v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB
API Plans

Get one API's plan

Get one API's plan

Get the API's plan by its identifier.

get/environments/{envId}/apis/{apiId}/plans/{planId}

Response

An API's plan

OR
OR

Example response

{
  "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"
        }
      ]
    }
  ]
}