Introduction

Base URL and IDs

{apiBaseUrl} = https://<API host>/api/v2

The API base URL is shown in the Admin Dashboard under Admin Access Control → Applications, in the API Access card, with a Copy button. See Applications.

Placeholder	Source
{apiBaseUrl}	API base URL in the API Access card. Every path in the reference is relative to it.
{organizationId}	Organization ID in Organization Settings, also shown in the hint under API base URL. Any other ID returns 404.
{contextId}	contextId of a context in List contexts. The segment before it in the path names the Service of the context. A context of another Organization or of another Service returns 404.

IDs are strings, also when they contain only digits. The examples use $API_BASE_URL, $NCP_API_TOKEN, $ORGANIZATION_ID and $CONTEXT_ID.

APIs

API	Base path	Reference
Organization	{apiBaseUrl}/organizations/{organizationId}	Organization
Sign In	{apiBaseUrl}/organizations/{organizationId}/contexts/sign-in/{contextId}	Access policies, Whitelistings

Requests and responses

• Request and response bodies are JSON in UTF-8. Send Content-Type: application/json with a request body.
• A request body field the operation does not have is refused with 400; see Errors.
• Successful responses are application/json. Errors are application/problem+json; see Errors.
• Every response carries the ID of the request in the X-Request-Id header.
• Every documented response field is always present. A value that is not known is null, never left out.
• Timestamps are ISO 8601 in UTC, always with three decimals: 2026-09-28T13:33:36.341Z, and 2026-09-30T13:41:00.000Z for a whole second. Dates are YYYY-MM-DD.

Request	Status
A body larger than 1 MB	413
A Transfer-Encoding header (a chunked body)	411

Both responses have an empty body. Send the body with a Content-Length header.

OpenAPI document

GET {apiBaseUrl}/openapi.json

• OpenAPI 3.1, titled “Platform API”. info.version is the document version, 2.0; see Versioning. It lists every published operation with its parameters, request and response shapes, examples and error responses.
• No API key is required, and the IP access list does not apply.
• The server is https://{apiHost}, and every path starts with /api/v2. In a tool that imports the document, set the server variable apiHost to the host of the API base URL: the part between https:// and /api/v2.
• The security scheme, bearerAuth, is an HTTP bearer scheme. Give the tool a token of the API key, and it sends Authorization: Bearer <token>.