Genesis API overview

The Genesis platform exposes a REST API over HTTPS. Every request is made against one base URL, authenticated with a token in a request header, and answers JSON.

Base URL

https://api.nxgen.cloud/api/v1

Every path on these pages is relative to it: GET /user/me means GET https://api.nxgen.cloud/api/v1/user/me.

Authentication

Requests carry a token in the auth-token header. See Authentication for how to obtain one.

Resources

Conventions

• Path parameters are written in braces, /site/{id}. Replace the whole placeholder, braces included.
• Request bodies are JSON unless an operation says otherwise. On these pages a body is shown as a skeleton: the field names with the type expected in place of each value, and (required) on the fields that must be present.
• Response tables list every status the specification declares. 401 means the token was missing or rejected; 403 means it was valid but not entitled to the resource.

Specification version 1.0.0.