API
List APIs
Returns a collection of all APIs.
get/v3/apis
Query parameters
page[size]integer
Example:10
The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]integer
Example:1
Determines which page of the entities to retrieve.
Filters APIs in the response.
{
"created_at": {
"eq": "2022-03-30T07:20:50Z"
},
"updated_at": {
"eq": "2022-03-30T07:20:50Z"
}
}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
Sorts a collection of APIs. Supported sort attributes are:
- name
- version
- created_at
- updated_at
Response
List of APIs
Example response
{
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
},
"data": [
{
"id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
"name": "MyAPI",
"current_version_summary": {
"id": "7710d5c4-d902-410b-992f-18b814155b53",
"spec": {
"type": "oas3"
},
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
},
"slug": "my-api-v1",
"api_spec_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"portals": [
{
"id": "25a2624c-49fc-4764-99e1-224ed819f200",
"name": "My Portal",
"display_name": "My Portal"
}
],
"labels": {
"env": "test"
},
"attributes": {
"env": [
"production"
],
"domains": [
"web",
"mobile"
]
},
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}