Sign in
Application

Create an application by the logged in developer.

Changed on
post/api/applications

Request

  • The document declares no server URL.
  • Auth: HTTP bearer and API key in header X-Portal-Developer-ID

Request body

namestring

The object name.

descstring

The object description.

labelsLabelsMap

Key-value pairs of labels.

Example request

{
  "name": "us-west-rsc",
  "desc": "Object description.",
  "labels": {
    "version": "v2",
    "env": "prod"
  }
}

Response

namestring required

The object name.

descstring

The object description.

labelsLabelsMap

Key-value pairs of labels.

idstring required

The object ID.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "name": "us-west-rsc",
  "desc": "Object description.",
  "labels": {
    "version": "v2",
    "env": "prod"
  },
  "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}

Changes

  • 12f96ac28b19Revision changes
    • breaking

      request body became required

    • info

      the endpoint scheme security BearerAuth AND DeveloperIDHeader was added to the API

  • 53b809c2d9b1Revision changes
    • info

      the response's property default value 400 was removed for the status

    • info

      the response's property default value 401 was removed for the status