ApiSlug
stringThe Api slug is used in generated URLs to provide human readable paths.
Defaults to slugify(name + version)
Match pattern:^[\w-]+$
ApiId
stringThe API identifier.
API Actions Response
objectList of actions that can be performed on the API
Show Child Parameters
Api
objectContains 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"]}
ApiListPage
objectreturns the pagination information