Get an API Implementation

Retrieve a gateway implementation for this API

get

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

implementationIdstring(uuid)required

The Portal identifier

Example:032d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

An API implementation

API Implementation

API Implementationobject

An entity that implements an API

One Of
idstring(uuid)read-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

serviceobject

A Gateway service that implements an API

* Additional properties are NOT allowed.
Show Child Parameters
get/apis/{apiId}/implementations/{implementationId}
 
application/json

Delete API Implementation

Unlink a gateway implementation from this API

delete

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

implementationIdstring(uuid)required

The Portal identifier

Example:032d905a-ed33-46a3-a093-d8f536af9a8a

Response

API implementation was unlinked successfully.

delete/apis/{apiId}/implementations/{implementationId}
 

List API Implementations

List gateway implementations for this API

get

Query 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

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

Response

application/json

Paginated list of API implementations

ListApiImplementations

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataOne Of
array[object]required

An entity that implements an API

ApiImplementationListItemGatewayServiceEntityobject

An API Implementation list item for gateway services

* Additional properties are NOT allowed.
Show Child Parameters
get/api-implementations
 
application/json

API Operations

List API Operations

Returns a list of operations for an API.
Returns 404 if the API is not configured for access control enforcement.

get

Query 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

filterobject

Filters API Operations in the response.

Show Child Parameters

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

Response

application/json

Paginated list of API operations

ListApiOperations

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

An operation linked to an API

* Additional properties are NOT allowed.
Show Child Parameters
get/apis/{apiId}/operations
 
application/json