Delete API Package

Deletes an API package.

delete

Path Parameters

packageIdstring(uuid)required

The UUID API Package identifier

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

Response

API package was deleted successfully.

delete/api-packages/{packageId}
 

API Package Operations

List API Packages Operations

List API packages operations

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 Packages operations 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

Path Parameters

packageIdstring(uuid)required

The UUID API Package identifier

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

Response

application/json

List of API Package Operations

ListApiPackageOperationsResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
get/api-packages/{packageId}/operations
 
application/json

Update API Package Operation

Update API Package Operations

patch

Path Parameters

packageIdstring(uuid)required

The UUID API Package identifier

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

Body

application/json

JSON Patch Operation

A JSON Patch operation to add or remove an API Operation from a Package.

>= 1 items

* Additional properties are NOT allowed.
opstringrequired

The operation to perform.

Allowed values:addremovereplace

pathstringrequired

The path to the API Operation in the Package, in the format “operations/”.

Match pattern:^operations/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

valueobject
* Additional properties are NOT allowed.
Show Child Parameters

Response

API operations were successfully added or removed to the package.

patch/api-packages/{packageId}/operations

Body

[ { "op": "add", "path": "path" } ]
 

Get API Packages Operation

Get API packages operation

get

Path Parameters

packageIdstring(uuid)required

The UUID API Package identifier

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

operationIdstring(uuid)required

The UUID API Operation identifier

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

Response

application/json

API Package Operation

API Package Operation Response

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The API Operation identifier.

Example:0f5061ce-78f6-4452-9108-ad7c02821fd6

apiobjectrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
methodstringrequiredread-only

The HTTP method of an API Operation.

Allowed values:GETPOSTPUTDELETEPATCHOPTIONSHEADCONNECTTRACE

pathstringrequiredread-only

The path of the API Operation.

Example:/users/{user_id}

rate_limiting_configobject | nullrequiredread-only

Rate limit configuration that can be applied to an API Package or an API Package Operation.

* Additional properties are NOT allowed.
Show Child Parameters
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

implementation_statusobject

The implementation status of the operation.

* Additional properties are NOT allowed.
Show Child Parameters
get/api-packages/{packageId}/operations/{operationId}
 
application/json