Get API

Gets the details for an existing published API.

get
/api/v3/apis/{apiIdOrSlug}

Path Parameters

apiIdOrSlugOne Of
required

The API identifier, either ApiId or Api Slug

ApiIdstring(uuid)read-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Response

application/json

Response for a single api’s details.

Api

* 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

namestringrequired

Name of API.

Example:Billing

versionstring | nullrequired

Version of API.

Example:v1

descriptionstring | nullrequired

Example:V1 API for billing functions

visibilitystringrequired

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

slugstringrequired

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

auth_strategiesOne Of
array[object]

Configurations for how the API is able to be registered for by applications.

AuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

* Additional properties are NOT allowed.
Show Child Parameters
specificationsarray[object]requiredDEPRECATED

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
current_version_summaryobject | null

Summary of the current version (version string of api.version matches version)

* Additional properties are NOT allowed.
Show Child Parameters
attributesobjectrequired

A set of attributes that describe the API

Example:{"availability":["general"],"domain":["financial","billing"]}

application/json

List APIs

Returns a paginated list of published APIs.

get
/api/v3/apis

Query Parameters

filterobject

Filters APIs in the response.

Show Child Parameters
sortstring

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

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Response

application/json

Response for a list of apis.

ApiListPage

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
application/json

List API Actions

Get a set of actions that the current developer is allowed to perform on an API.

get
/api/v3/apis/{apiIdOrSlug}/actions

Path Parameters

apiIdOrSlugOne Of
required

The API identifier, either ApiId or Api Slug

ApiIdstring(uuid)read-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Response

application/json

API actions

API Actions Response

* Additional properties are NOT allowed.
actionsobjectrequired

List of actions that can be performed on the API

* Additional properties are NOT allowed.
Show Child Parameters
application/json

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).

get
/api/v3/apis/{apiIdOrSlug}/applications

Query Parameters

unregisteredboolean

Return applications that do not have a registration for the API (regardless of registration status).

applicationfilterobject

Filters Applications to retrieve.

Show Child Parameters
page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Path Parameters

apiIdOrSlugOne Of
required

The API identifier, either ApiId or Api Slug

ApiIdstring(uuid)read-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Response

application/json

Paginated list of applications either registered or not registered for an API

ApiListApplicationsPage

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
application/json

API Docs

Endpoints for viewing API documentation published to the portal.