API Plans
List the API's plans
List the API's plans
List plans for a given API, always filtered by a status and the possibility to filter by security.<br> The results are paginated.
get/environments/{envId}/apis/{apiId}/plans
Query parameters
statusesPlanStatus[]
List of status filters
[ "STAGING" ]
securitiesPlanSecurityType[]
List of security plan type filters
[ "KEY_LESS" ]
mode'STANDARD' | 'PUSH'
The behavioural mode of the Plan (Standard for classical plan, Push for subscription plan).
Example:STANDARD
Mode of plan
subscribableBystring
Application's identifier. Allow user to get API's plans subscribable by an application.
fieldsstring[]
Nested fields of data to return in plans.
pageinteger
The page number for pagination.
perPageinteger
The number of items per page for pagination.
Response
Page of API plans
Example response
{
"data": [
{
"id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
"name": "My Api plan",
"description": "I can use a hundred characters to describe this plan.",
"apiId": "6c530064-0b2c-4004-9300-640b2ce0047b",
"apiProductId": "6c530064-0b2c-4004-9300-640b2ce0047b",
"security": {
"type": "KEY_LESS"
},
"mode": "STANDARD",
"closedAt": "2023-05-25 12:40:46.184000+00:00",
"commentMessage": "Explain why you want to subscribe.",
"createdAt": "2023-05-25 12:40:46.184000+00:00",
"crossId": "df83b2a4-cc3e-3f80-9f0d-c138c106c076",
"definitionVersion": "V4",
"excludedGroups": [
"MY_GROUP1",
"MY_GROUP2"
],
"publishedAt": "2023-05-25 12:40:46.184000+00:00",
"status": "STAGING",
"tags": [
"public",
"private"
],
"type": "API",
"updatedAt": "2023-05-25 12:40:46.184000+00:00",
"validation": "AUTO",
"flows": [
{
"id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
"name": "My Flow",
"pathOperator": {
"path": "/my/path",
"operator": "EQUALS"
},
"methods": [
"GET"
],
"condition": "{#request.headers['x-foo'] == 'bar'}",
"consumers": [
{
"consumerId": "myTag"
}
]
}
]
}
]
}