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"]}
Example:{"icon":{"uri":"/apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw"}}
Show Child Parameters
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
API Attributes
Endpoints for viewing attributes across APIs published to the portal.
List API Attributes
Get a paginated list of all attributes across APIs in the portal.
If authenticated, results will include attributes of APIs visible to the authenticated user.
If not authenticated, results will include only attributes of publicly visible APIs.
When the selected query parameter is provided, the response will include a selected_api_count
field for each attribute value, indicating how many APIs would match that attribute value
when combined with the currently selected filters.
Query Parameters
Filters API attributes in the response.
Show Child Parameters
Specifies selected attribute values to calculate filtered API counts.
Use the format: selected[<attribute_key>]=<attribute_value_1>,<attribute_value_2>
When provided, the response will include selected_api_count for each attribute value.
Example:{"domain":"airlines,flights","visibility":"external"}
Response
application/json
Response
Paginated list of attributes across all APIs published in this portal.
ListApiAttributesPage
returns the pagination information