ApiId

string

The API identifier.

Example

API Actions Response

object
* Additional properties are NOT allowed.
actionsobjectrequired

List of actions that can be performed on the API

* Additional properties are NOT allowed.
Show Child Parameters
Example

Api

object
* 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

versionstringrequired

Version of API.

Example:v1

descriptionstringrequired

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

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"]}

Example

ApiListPage

object
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
Example

ApiListApplicationsPage

object
* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
Example