Get an App Registration

Retrieves the specified API registration for an application.

get
/api/v3/applications/{applicationId}/registrations/{registrationId}

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

registrationIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

Response

application/json

Get registration response.

GetApiRegistrationResponse

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

statusstringrequired

The approval status of the registration.

Allowed values:approvedpendingrejectedrevoked

api_namestringrequired

The name of the API. This is the name that is displayed in the developer portal.

api_idstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

api_slugstringrequired

The API slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

Example:my-api-v1

application_idstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

application/json

Delete App Registration

Unregister an application for an API.

delete
/api/v3/applications/{applicationId}/registrations/{registrationId}

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

registrationIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

Response

The registration has been deleted.

CreateRegistrationPayload

object

The payload to create a registration.

* Additional properties are NOT allowed.
api_idstring(uuid)required

The API id required for registration.

Example

ListApiRegistrationsResponse

object
* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
Example

GetApiRegistrationResponse

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

statusstringrequired

The approval status of the registration.

Allowed values:approvedpendingrejectedrevoked

api_namestringrequired

The name of the API. This is the name that is displayed in the developer portal.

api_idstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

api_slugstringrequired

The API slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

Example:my-api-v1

application_idstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

Example