Sign in

v6

latestOpenAPI 3.0.3raw.githubusercontent.com2025-11-28172255.4 KB
Mapping Versions

Update a mapping version

Updates an existing mapping version configuration.

patch/gateway/mapping-version/{gateway_topic}/{version_number}

Path parameters

gateway_topicstring required

Unique topic identifier of the gateway

version_numberinteger required

Sequential version number of the mapping version

Query parameters

method'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS' | 'HEAD' required

HTTP method for the mapping in uppercase

pathstring required

URL path for the mapping including the leading slash

Request body

activeboolean

Whether the mapping version is active

descriptionstring

Updated description of the mapping version

exact_matchboolean

Whether the path should be matched exactly

attributesstring[]

Updated attributes for the mapping version

boolean_logicstring

Updated boolean logic expression for request routing

invocation_typestring

Updated type of invocation for the resource

Example request

{
  "description": "Updated description for version 1",
  "middleware": [
    {
      "order": 1,
      "resource": "auth-middleware",
      "resource_type": "function",
      "resource_version": "latest",
      "type": "pre-request"
    }
  ],
  "exact_match": true,
  "attributes": [
    "premium"
  ],
  "boolean_logic": "user.premium == true",
  "invocation_type": "Event"
}

Response

Mapping version updated successfully

messagestring

Example response

{
  "message": "success"
}