APIs
Endpoints for viewing APIs published to the portal.
Get API
Gets the details for an existing published API.
Path Parameters
One OfThe API identifier, either ApiId or Api Slug
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
Response for a single api’s details.
Api
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
Name of API.
Example:Billing
Version of API.
Example:v1
Example:V1 API for billing functions
Visibility of the API listing.
Public APIs are visible to anyone and do not require authentication to view and retrieve information about them.
Private APIs are only visible to authenticated developers who have been granted access.
Allowed values:publicprivate
The API slug is used in generated URLs to provide human readable paths.
Defaults to slugify(name + version)
Match pattern:^[\w-]+$
Example:my-api-v1
One OfConfigurations for how the API is able to be registered for by applications.
KeyAuth Auth strategy that the application uses.
Show Child Parameters
Returns a list of specifications for an API.
Note: This Beta property is deprecated and will be removed in a GA release.
Show Child Parameters
Summary of the current version (version string of api.version matches version)
Show Child Parameters
A set of attributes that describe the API
Example:{"availability":["general"],"domain":["financial","billing"]}
List APIs
Returns a paginated list of published APIs.
Query Parameters
Filters APIs in the response.
Show Child Parameters
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
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
Response
application/json
Response
Response for a list of apis.
ApiListPage
returns the pagination information
Show Child Parameters
Show Child Parameters
List API Actions
Get a set of actions that the current developer is allowed to perform on an API.
Path Parameters
One OfThe API identifier, either ApiId or Api Slug
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
API actions
API Actions Response
List of actions that can be performed on the API
Show Child Parameters
List API Applications
Get applications that have a registration for a given API.
Any registration will count, regardless of status (i.e. even if it is pending, rejected, or revoked).
Use the unregistered query param to return the inverse, only including applicatons that do not have a registration (regardless of status).
Query Parameters
Return applications that do not have a registration for the API (regardless of registration status).
Filters Applications to retrieve.
Show Child 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
Path Parameters
One OfThe API identifier, either ApiId or Api Slug
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
Paginated list of applications either registered or not registered for an API
ApiListApplicationsPage
returns the pagination information