Sign in

v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB
Application Registrations

Create Registration

Creates a new registration for this application to access a specific API. Registrations created through the portal management API will respect the auto-approve settings of the portal and/or API publication. API publications that do not use auto-approve must be manually approved by an administrator after creation.

post/v3/portals/{portalId}/applications/{applicationId}/registrations

Request body

api_idstring uuid required

The ID of the API the application is registering for.

status'approved' | 'pending'

The status of the application registration. It must be a valid status value for a registration creation.

Example request

{
  "api_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"
}

Response

Details about an application registration.

idstring uuid required

Contains a unique identifier used for this resource.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

status'approved' | 'pending' | 'revoked' | 'rejected' required

The status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved. Pending, revoked, and rejected registrations will not provide access to the API.

Example response

{
  "id": "c300cc33-2d33-4754-b086-a98e0fcd36fb",
  "status": "approved",
  "application": {
    "id": "c15e2460-ba40-431d-9df0-4957fcff7cda",
    "name": "App 1"
  },
  "api": {
    "id": "86f637b7-cd95-478b-9b02-d770618f641c",
    "name": "Great Stuff",
    "version": "v1",
    "entity_type": "api"
  },
  "created_at": "2022-12-22T20:13:07.305Z",
  "updated_at": "2022-12-22T20:13:36.710Z"
}