API Plans
Partially update one API's plan
Partially update one API's plan
Apply a partial update to an API's plan using JSON Merge Patch (RFC 7396) or JSON Patch (RFC 6902). Only v4 HTTP Proxy API plans support this operation. Only the following fields are patchable: name, description, security (configuration only),
patch/environments/{envId}/apis/{apiId}/plans/{planId}
Query parameters
dryRunboolean
Headers
If-Matchstring
Optional optimistic-concurrency precondition. Supply the plan's current ETag (as returned by a prior read or patch). If the plan was modified since that ETag was read, the request is rejected with 412.
Request body
object required
Response
API's plan successfully patched
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"
}
]
}
]
}