Register App for API
Registers an application for an API.
Path Parameters
Id of the targeted application
Body
application/json
Body
Create an application registration.
CreateRegistrationPayload
The payload to create a registration.
The API id required for registration.
Response
application/json
Response
Registration creation response.
GetApiRegistrationResponse
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
The approval status of the registration.
Allowed values:approvedpendingrejectedrevoked
The name of the API. This is the name that is displayed in the developer portal.
Contains a unique identifier used by the Portal API for this resource.
The API slug is used in generated URLs to provide human readable paths.
Defaults to slugify(name + version)
Example:my-api-v1
Contains a unique identifier used by the Portal API for this resource.
Get an App Registration
Retrieves the specified API registration for an application.
Path Parameters
Id of the targeted application
Contains a unique identifier used by the Portal API for this resource.
Response
application/json
Response
Get registration response.
GetApiRegistrationResponse
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
The approval status of the registration.
Allowed values:approvedpendingrejectedrevoked
The name of the API. This is the name that is displayed in the developer portal.
Contains a unique identifier used by the Portal API for this resource.
The API slug is used in generated URLs to provide human readable paths.
Defaults to slugify(name + version)
Example:my-api-v1
Contains a unique identifier used by the Portal API for this resource.
Delete App Registration
Unregister an application for an API.
Path Parameters
Id of the targeted application
Contains a unique identifier used by the Portal API for this resource.
Response
Response
The registration has been deleted.
CreateRegistrationPayload
objectThe payload to create a registration.
The API id required for registration.
ListApiRegistrationsResponse
objectreturns the pagination information