Create API Implementation
Creates an implementation for an API.
If all operations in an API are implemented by a single gateway service and the service
has no routes that are not part of the API, then the API can be linked to the service.
For cases where an API is implemented by multiple gateway services, only a subset of
routes in one or more gateway services, or API operations need to be made available for API packages,
then the API should be linked to the control plane that defines the routes that overlap with the API.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Body
application/json
Body
API Implementation
An entity that implements an API
One OfA Gateway service that implements an API
Show Child Parameters
Response
application/json
Response
An API implementation
API Implementation
An entity that implements an API
One OfContains 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
A Gateway service that implements an API
Show Child Parameters
Authentication
Path Parameters
Body
Get an API Implementation
Retrieve a gateway implementation for this API
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The Portal identifier
Example:032d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
An API implementation
API Implementation
An entity that implements an API
One OfContains 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
A Gateway service that implements an API
Show Child Parameters
Authentication
Path Parameters
Delete API Implementation
Unlink a gateway implementation from this API
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The Portal identifier
Example:032d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
API implementation was unlinked successfully.
Authentication
Path Parameters
List API Implementations
List gateway implementations for this API
Query 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
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
Response
application/json
Response
Paginated list of API implementations
ListApiImplementations
returns the pagination information
Show Child Parameters
One OfAn entity that implements an API
An API Implementation list item for gateway services