List Registrations for App
Lists API registrations for an application.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filter by direct equality comparison of the id property with a supplied value.
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Filter by direct equality comparison (short-hand) of the id property with a supplied value.
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Filter by direct equality comparison of the status property with a supplied value.
Allowed values:approvedpendingrejectedrevoked
Example:approved
Filter by direct equality comparison (short-hand) of the status property with a supplied value.
Allowed values:approvedpendingrejectedrevoked
Example:approved
Filter by direct equality comparison of the api_name property with a supplied value.
Example:good service
Filter by direct equality comparison (short-hand) of the api_name property with a supplied value.
Example:good service
Filter by contains comparison of the api_name property with a supplied substring
Example:good service
Path Parameters
Id of the targeted application
Response
application/json
Response
Get registrations response.
ListApiRegistrationsResponse
returns the pagination information
Show Child Parameters
Show Child Parameters
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.