---
title: "Konnect Control Planes Configuration for API Gateways"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-api-gateways-dev-1/versions/a1769dd8-5923-4feb-8924-2e1ea4c75174"
---

# Konnect Control Planes Configuration for API Gateways

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Konnect Control Planes Configuration for API Gateways","version":"1.0.0","description":"The endpoints for configuring API Gateways in Konnect.","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v1","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v1","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v1","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v1","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v1","description":"India Production region"},{"url":"https://sg.api.konghq.com/v1","description":"Singapore Production region"}],"paths":{"/api-gateways":{"get":{"operationId":"list-api-gateways","summary":"List all API Gateways","description":"Returns an array of gateway objects containing information about the Konnect API Gateways.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/APIGatewayCommonFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListAPIGatewaysResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["API Gateways"]},"post":{"operationId":"create-api-gateway","summary":"Create an API Gateway","description":"Create an API Gateway in the Konnect Organization.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGatewayRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateAPIGatewayResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["API Gateways"]}},"/api-gateways/{gatewayId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"get-api-gateway","summary":"Get API Gateway","description":"Returns information about an individual API gateway.","responses":{"200":{"description":"A response to retrieving a single API gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayInfo"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["API Gateways"]},"put":{"operationId":"update-api-gateway","summary":"Update API Gateway","description":"Update an individual gateway.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGatewayRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateAPIGatewayResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["API Gateways"]},"delete":{"operationId":"delete-api-gateway","summary":"Delete API Gateway","description":"Delete an individual gateway.","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["API Gateways"]}},"/api-gateways/{gatewayId}/listeners":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-api-gateway-listeners","summary":"List API Gateway Listeners","description":"Returns a list of listeners associated with the specified API Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/APIGatewayCommonFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListAPIGatewayListenersResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["API Gateway Listeners"]},"post":{"operationId":"create-api-gateway-listener","summary":"Create API Gateway Listener","description":"Creates a new listener associated with the specified API Gateway.","requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayListenerRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayListener"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["API Gateway Listeners"]}},"/api-gateways/{gatewayId}/listeners/{apiGatewayListenerId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/apiGatewayListenerId"}],"get":{"operationId":"get-api-gateway-listener","summary":"Get an API Gateway Listener","description":"Returns information about a specific listener associated with the API Gateway.","responses":{"200":{"description":"A single API Gateway listener object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayListener"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Listeners"]},"put":{"operationId":"update-api-gateway-listener","summary":"Update API Gateway Listener","description":"Updates an existing listener associated with the specified API Gateway.","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayListenerRequest"},"responses":{"200":{"description":"Updated API Gateway listener object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayListener"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Listeners"]},"delete":{"operationId":"delete-api-gateway-listener","summary":"Delete API Gateway Listener","description":"Deletes a specific listener associated with the API Gateway.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Listeners"]}},"/api-gateways/{gatewayId}/listeners/{apiGatewayListenerId}/policies":{"parameters":[{"$ref":"#/components/parameters/apiGatewayListenerId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-api-gateway-listener-policies","summary":"List all policies for an API Gateway listener","description":"List all policies for an API Gateway listener","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/apiGatewayPolicyParentId"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicyListResponse"}},"tags":["API Gateway Listener Policy"]},"post":{"operationId":"create-api-gateway-listener-policy","summary":"Create a new policy for a listener","description":"Create a new listener policy","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayListenerPolicy"},"responses":{"201":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Listener Policy"]}},"/api-gateways/{gatewayId}/listeners/{apiGatewayListenerId}/policies/{apiGatewayPolicyId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewayPolicyId"},{"$ref":"#/components/parameters/apiGatewayListenerId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"get-api-gateway-listener-policy","summary":"Get a policy for a listener","description":"Get a policy for a listener","responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Listener Policy"]},"put":{"operationId":"update-api-gateway-listener-policy","summary":"Update a policy for a listener","description":"Update a policy for a listener","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayListenerPolicy"},"responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Listener Policy"]},"delete":{"operationId":"delete-api-gateway-listener-policy","summary":"Delete a policy for a listener","description":"Delete a policy for a listener","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Listener Policy"]}},"/api-gateways/{gatewayId}/listeners/{apiGatewayListenerId}/policies/{apiGatewayPolicyId}/move":{"post":{"operationId":"move-api-gateway-listener-policy","summary":"Move Policy","description":"Moves the position of a specific policy relative to the chain associated with the API Gateway listener.\n","parameters":[{"$ref":"#/components/parameters/apiGatewayPolicyId"},{"$ref":"#/components/parameters/apiGatewayListenerId"},{"$ref":"#/components/parameters/gatewayId"},{"name":"index","in":"query","description":"The index position of the policy.","required":true,"schema":{"type":"integer","example":10,"minimum":0},"allowEmptyValue":false}],"responses":{"201":{"description":"Position Updated"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Listener Policy"]}},"/api-gateways/{gatewayId}/services":{"get":{"operationId":"list-api-gateway-services","summary":"List all API Gateway Services","description":"List all API Gateway Services","parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/APIGatewayCommonFilter"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewayServiceListResponse"}},"tags":["API Gateway Service"]},"post":{"operationId":"create-api-gateway-service","summary":"Create a new API Gateway Service","description":"Create a new API Gateway Service","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayService"},"responses":{"201":{"description":"The created service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayService"}}}},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Service"]}},"/api-gateways/{gatewayId}/services/{apiGatewayServiceId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewayServiceId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"get-api-gateway-service","summary":"Get a service","description":"Get service","responses":{"200":{"description":"The requested service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayService"}}}},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service"]},"put":{"operationId":"update-api-gateway-service","summary":"Update a service","description":"Update a service","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayService"},"responses":{"200":{"description":"The updated service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayService"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service"]},"delete":{"operationId":"delete-api-gateway-service","summary":"Delete a service","description":"Delete a service","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service"]}},"/api-gateways/{gatewayId}/services/{apiGatewayServiceId}/inbound-policies":{"parameters":[{"$ref":"#/components/parameters/apiGatewayServiceId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-api-gateway-service-inbound-policies","summary":"List all policies for an API Gateway service","description":"List all inbound policies for an API Gateway service","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/apiGatewayPolicyParentId"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewayInboundPolicyListResponse"}},"tags":["API Gateway Service Inbound Policy"]},"post":{"operationId":"create-api-gateway-service-inbound-policy","summary":"Create a new inbound policy for a service","description":"Create a new inbound policy for a service","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayServiceInboundPolicy"},"responses":{"201":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Service Inbound Policy"]}},"/api-gateways/{gatewayId}/services/{apiGatewayServiceId}/inbound-policies/{apiGatewayPolicyId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewayPolicyId"},{"$ref":"#/components/parameters/apiGatewayServiceId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"get-api-gateway-service-inbound-policy","summary":"Get an inbound policy for a service","description":"Get an inbound policy for a service","responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Inbound Policy"]},"put":{"operationId":"update-api-gateway-service-inbound-policy","summary":"Update an inbound policy for a service","description":"Update an inbound policy for a service","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayServiceInboundPolicy"},"responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Inbound Policy"]},"delete":{"operationId":"delete-api-gateway-service-inbound-policy","summary":"Delete an inbound policy for a service","description":"Delete an inbound policy for a service","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Inbound Policy"]}},"/api-gateways/{gatewayId}/services/{apiGatewayServiceId}/inbound-policies/{apiGatewayPolicyId}/move":{"post":{"operationId":"move-api-gateway-service-inbound-policy","summary":"Move Inbound Policy","description":"Moves the position of a specific inbound policy relative to the chain associated with the API Gateway service.\n","parameters":[{"$ref":"#/components/parameters/apiGatewayPolicyId"},{"$ref":"#/components/parameters/apiGatewayServiceId"},{"$ref":"#/components/parameters/gatewayId"},{"name":"index","in":"query","description":"The index position of the policy.","required":true,"schema":{"type":"integer","example":10,"minimum":0},"allowEmptyValue":false}],"responses":{"201":{"description":"Position Updated"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Inbound Policy"]}},"/api-gateways/{gatewayId}/services/{apiGatewayServiceId}/outbound-policies":{"parameters":[{"$ref":"#/components/parameters/apiGatewayServiceId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-api-gateway-service-outbound-policies","summary":"List all policies for an API Gateway service","description":"List all outbound policies for an API Gateway service","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/apiGatewayPolicyParentId"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewayOutboundPolicyListResponse"}},"tags":["API Gateway Service Outbound Policy"]},"post":{"operationId":"create-api-gateway-service-outbound-policy","summary":"Create a new outbound policy for a service","description":"Create a new outbound policy for a service","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayServiceOutboundPolicy"},"responses":{"201":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Service Outbound Policy"]}},"/api-gateways/{gatewayId}/services/{apiGatewayServiceId}/outbound-policies/{apiGatewayPolicyId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewayPolicyId"},{"$ref":"#/components/parameters/apiGatewayServiceId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"get-api-gateway-service-outbound-policy","summary":"Get an outbound policy for a service","description":"Get an outbound policy for a service","responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Outbound Policy"]},"put":{"operationId":"update-api-gateway-service-outbound-policy","summary":"Update an outbound policy for a service","description":"Update an outbound policy for a service","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayServiceOutboundPolicy"},"responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Outbound Policy"]},"delete":{"operationId":"delete-api-gateway-service-outbound-policy","summary":"Delete an outbound policy for a service","description":"Delete an outbound policy for a service","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Outbound Policy"]}},"/api-gateways/{gatewayId}/services/{apiGatewayServiceId}/outbound-policies/{apiGatewayPolicyId}/move":{"post":{"operationId":"move-api-gateway-service-outbound-policy","summary":"Move Outbound Policy","description":"Moves the position of a specific outbound policy relative to the chain associated with the API Gateway service.\n","parameters":[{"$ref":"#/components/parameters/apiGatewayPolicyId"},{"$ref":"#/components/parameters/apiGatewayServiceId"},{"$ref":"#/components/parameters/gatewayId"},{"name":"index","in":"query","description":"The index position of the policy.","required":true,"schema":{"type":"integer","example":10,"minimum":0},"allowEmptyValue":false}],"responses":{"201":{"description":"Position Updated"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Outbound Policy"]}},"/api-gateways/{gatewayId}/routes":{"get":{"operationId":"list-api-gateway-routes","summary":"List all API Gateway Routes","description":"List all API Gateway Routes","parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/APIGatewayCommonFilter"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewayRouteListResponse"}},"tags":["API Gateway Route"]},"post":{"operationId":"create-api-gateway-route","summary":"Create a new API Gateway Route","description":"Create a new API Gateway Route","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayRoute"},"responses":{"201":{"description":"The created route.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayRoute"}}}},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Route"]}},"/api-gateways/{gatewayId}/routes/{apiGatewayRouteId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewayRouteId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"get-api-gateway-route","summary":"Get a route","description":"Get route","responses":{"200":{"description":"The requested route.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayRoute"}}}},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route"]},"put":{"operationId":"update-api-gateway-route","summary":"Update a route","description":"Update a route","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayRoute"},"responses":{"200":{"description":"The updated route.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayRoute"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route"]},"delete":{"operationId":"delete-api-gateway-route","summary":"Delete a route","description":"Delete a route","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route"]}},"/api-gateways/{gatewayId}/routes/{apiGatewayRouteId}/inbound-policies":{"parameters":[{"$ref":"#/components/parameters/apiGatewayRouteId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-api-gateway-route-inbound-policies","summary":"List all policies for an API Gateway route","description":"List all inbound policies for an API Gateway route","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/apiGatewayPolicyParentId"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewayInboundPolicyListResponse"}},"tags":["API Gateway Route Inbound Policy"]},"post":{"operationId":"create-api-gateway-route-inbound-policy","summary":"Create a new inbound policy for a route","description":"Create a new route policy","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayRouteInboundPolicy"},"responses":{"201":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Route Inbound Policy"]}},"/api-gateways/{gatewayId}/routes/{apiGatewayRouteId}/inbound-policies/{apiGatewayPolicyId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewayPolicyId"},{"$ref":"#/components/parameters/apiGatewayRouteId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"get-api-gateway-route-inbound-policy","summary":"Get an inbound policy for a route","description":"Get an inbound policy for a route","responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Inbound Policy"]},"put":{"operationId":"update-api-gateway-route-inbound-policy","summary":"Update an inbound policy for a route","description":"Update an inbound policy for a route","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayRouteInboundPolicy"},"responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Inbound Policy"]},"delete":{"operationId":"delete-api-gateway-route-inbound-policy","summary":"Delete an inbound policy for a route","description":"Delete an inbound policy for a route","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Inbound Policy"]}},"/api-gateways/{gatewayId}/routes/{apiGatewayRouteId}/inbound-policies/{apiGatewayPolicyId}/move":{"post":{"operationId":"move-api-gateway-route-inbound-policy","summary":"Move an inbound policy","description":"Moves the position of a specific policy relative to the chain associated with the API Gateway route.\n","parameters":[{"$ref":"#/components/parameters/apiGatewayPolicyId"},{"$ref":"#/components/parameters/apiGatewayRouteId"},{"$ref":"#/components/parameters/gatewayId"},{"name":"index","in":"query","description":"The index position of the policy.","required":true,"schema":{"type":"integer","example":10,"minimum":0},"allowEmptyValue":false}],"responses":{"201":{"description":"Position Updated"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Inbound Policy"]}},"/api-gateways/{gatewayId}/routes/{apiGatewayRouteId}/outbound-policies":{"parameters":[{"$ref":"#/components/parameters/apiGatewayRouteId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-api-gateway-route-outbound-policies","summary":"List all policies for an API Gateway route","description":"List all outbound policies for an API Gateway route","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/apiGatewayPolicyParentId"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewayOutboundPolicyListResponse"}},"tags":["API Gateway Route Outbound Policy"]},"post":{"operationId":"create-api-gateway-route-outbound-policy","summary":"Create a new outbound policy for a route","description":"Create a new route policy","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayRouteOutboundPolicy"},"responses":{"201":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Route Outbound Policy"]}},"/api-gateways/{gatewayId}/routes/{apiGatewayRouteId}/outbound-policies/{apiGatewayPolicyId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewayPolicyId"},{"$ref":"#/components/parameters/apiGatewayRouteId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"get-api-gateway-route-outbound-policy","summary":"Get an outbound policy for a route","description":"Get an outbound policy for a route","responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Outbound Policy"]},"put":{"operationId":"update-api-gateway-route-outbound-policy","summary":"Update an outbound policy for a route","description":"Update an outbound policy for a route","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayRouteOutboundPolicy"},"responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Outbound Policy"]},"delete":{"operationId":"delete-api-gateway-route-outbound-policy","summary":"Delete an outbound policy for a route","description":"Delete an outbound policy for a route","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Outbound Policy"]}},"/api-gateways/{gatewayId}/routes/{apiGatewayRouteId}/outbound-policies/{apiGatewayPolicyId}/move":{"post":{"operationId":"move-api-gateway-route-outbound-policy","summary":"Move an outbound policy","description":"Moves the position of a specific policy relative to the chain associated with the API Gateway route.\n","parameters":[{"$ref":"#/components/parameters/apiGatewayPolicyId"},{"$ref":"#/components/parameters/apiGatewayRouteId"},{"$ref":"#/components/parameters/gatewayId"},{"name":"index","in":"query","description":"The index position of the policy.","required":true,"schema":{"type":"integer","example":10,"minimum":0},"allowEmptyValue":false}],"responses":{"201":{"description":"Position Updated"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Outbound Policy"]}},"/api-gateways/{gatewayId}/shared-policies/routes":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-api-gateway-route-shared-policy-chains","summary":"List routes shared policy chains","description":"List routes shared policy chains","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewaySharedPolicyChainListResponse"}},"tags":["API Gateway Route Shared Policy Chain"]},"post":{"operationId":"create-api-gateway-route-shared-policy-chain","summary":"Create a shared policy chain","description":"Create a shared policy chain","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewaySharedPolicyChain"},"responses":{"201":{"$ref":"#/components/responses/APIGatewaySharedPolicyChain"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Route Shared Policy Chain"]}},"/api-gateways/{gatewayId}/shared-policies/routes/{apiGatewaySharedPolicyChainId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewaySharedPolicyChainId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"get-api-gateway-route-shared-policy-chain","summary":"Get a shared policy chain","description":"Get a shared policy chain","responses":{"200":{"$ref":"#/components/responses/APIGatewaySharedPolicyChain"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Shared Policy Chain"]},"put":{"operationId":"update-api-gateway-route-shared-policy-chain","summary":"Update a shared policy chain","description":"Update a shared policy chain","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewaySharedPolicyChain"},"responses":{"200":{"$ref":"#/components/responses/APIGatewaySharedPolicyChain"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Shared Policy Chain"]},"delete":{"operationId":"delete-api-gateway-route-shared-policy-chain","summary":"Delete a shared policy chain","description":"Delete a shared policy chain","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Shared Policy Chain"]}},"/api-gateways/{gatewayId}/shared-policies/routes/{apiGatewaySharedPolicyChainId}/inbound-policies":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/apiGatewaySharedPolicyChainId"}],"get":{"operationId":"list-api-gateway-route-shared-policy-chain-inbound-policies","summary":"List routes policy chains inbound policies","description":"List routes policy chains inbound policies","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/apiGatewayPolicyParentId"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewayInboundPolicyListResponse"}},"tags":["API Gateway Route Shared Inbound Policy Chain"]},"post":{"operationId":"create-api-gateway-route-shared-policy-chain-inbound-policy","summary":"Create a route shared policy chain policy","description":"Create a route shared policy chain inbound policy","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayRouteInboundPolicy"},"responses":{"201":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Route Shared Inbound Policy Chain"]}},"/api-gateways/{gatewayId}/shared-policies/routes/{apiGatewaySharedPolicyChainId}/inbound-policies/{apiGatewayPolicyId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewaySharedPolicyChainId"},{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/apiGatewayPolicyId"}],"get":{"operationId":"get-api-gateway-route-shared-policy-chain-inbound-policy","summary":"Get a shared route policy chain policy","description":"Get a shared route policy chain inbound policy","responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Shared Inbound Policy Chain"]},"put":{"operationId":"update-api-gateway-route-shared-policy-chain-inbound-policy","summary":"Update a shared route policy chain policy","description":"Update a shared route policy chain inbound policy","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayRouteInboundPolicy"},"responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Shared Inbound Policy Chain"]},"delete":{"operationId":"delete-api-gateway-route-shared-policy-chain-inbound-policy","summary":"Delete a shared route policy chain policy","description":"Delete a shared route policy chain inbound policy","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Shared Inbound Policy Chain"]}},"/api-gateways/{gatewayId}/shared-policies/routes/{apiGatewaySharedPolicyChainId}/outbound-policies":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/apiGatewaySharedPolicyChainId"}],"get":{"operationId":"list-api-gateway-route-shared-policy-chain-outbound-policies","summary":"List routes policy chains policies","description":"List routes policy chains outbound policies","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/apiGatewayPolicyParentId"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewayOutboundPolicyListResponse"}},"tags":["API Gateway Route Shared Outbound Policy Chain"]},"post":{"operationId":"create-api-gateway-route-shared-policy-chain-outbound-policy","summary":"Create a route shared policy chain policy","description":"Create a route shared policy chain outbound policy","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayRouteOutboundPolicy"},"responses":{"201":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Route Shared Outbound Policy Chain"]}},"/api-gateways/{gatewayId}/shared-policies/routes/{apiGatewaySharedPolicyChainId}/outbound-policies/{apiGatewayPolicyId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewaySharedPolicyChainId"},{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/apiGatewayPolicyId"}],"get":{"operationId":"get-api-gateway-route-shared-policy-chain-outbound-policy","summary":"Get a shared route policy chain policy","description":"Get a shared route policy chain outbound policy","responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Shared Outbound Policy Chain"]},"put":{"operationId":"update-api-gateway-route-shared-policy-chain-outbound-policy","summary":"Update a shared route policy chain policy","description":"Update a shared route policy chain outbound policy","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayRouteOutboundPolicy"},"responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Shared Outbound Policy Chain"]},"delete":{"operationId":"delete-api-gateway-route-shared-policy-chain-outbound-policy","summary":"Delete a shared route policy chain policy","description":"Delete a shared route policy chain outbound policy","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Route Shared Outbound Policy Chain"]}},"/api-gateways/{gatewayId}/shared-policies/services":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-api-gateway-service-shared-policy-chains","summary":"List services shared policy chains","description":"List services shared policy chains","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewaySharedPolicyChainListResponse"}},"tags":["API Gateway Service Shared Policy Chain"]},"post":{"operationId":"create-api-gateway-service-shared-policy-chain","summary":"Create a service shared policy chain","description":"Create a service shared policy chain","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewaySharedPolicyChain"},"responses":{"201":{"$ref":"#/components/responses/APIGatewaySharedPolicyChain"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Service Shared Policy Chain"]}},"/api-gateways/{gatewayId}/shared-policies/services/{apiGatewaySharedPolicyChainId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewaySharedPolicyChainId"},{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"get-api-gateway-service-shared-policy-chain","summary":"Get a service shared policy chain","description":"Get a service shared policy chain","responses":{"200":{"$ref":"#/components/responses/APIGatewaySharedPolicyChain"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Shared Policy Chain"]},"put":{"operationId":"update-api-gateway-service-shared-policy-chain","summary":"Update a service shared policy chain","description":"Update a service shared policy chain","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewaySharedPolicyChain"},"responses":{"200":{"$ref":"#/components/responses/APIGatewaySharedPolicyChain"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Shared Policy Chain"]},"delete":{"operationId":"delete-api-gateway-service-shared-policy-chain","summary":"Delete a service shared policy chain","description":"Delete a service shared policy chain","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Shared Policy Chain"]}},"/api-gateways/{gatewayId}/shared-policies/services/{apiGatewaySharedPolicyChainId}/inbound-policies":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/apiGatewaySharedPolicyChainId"}],"get":{"operationId":"list-api-gateway-service-shared-policy-chain-inbound-policies","summary":"List all service shared policy chain policies","description":"List all service shared policy chain inbound policies","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/apiGatewayPolicyParentId"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewayInboundPolicyListResponse"}},"tags":["API Gateway Service Shared Inbound Policy Chain"]},"post":{"operationId":"create-api-gateway-service-shared-policy-chain-inbound-policy","summary":"Create a service shared policy chain policy","description":"Create a service shared policy chain inbound policy","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayServiceInboundPolicy"},"responses":{"201":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Service Shared Inbound Policy Chain"]}},"/api-gateways/{gatewayId}/shared-policies/services/{apiGatewaySharedPolicyChainId}/inbound-policies/{apiGatewayPolicyId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewaySharedPolicyChainId"},{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/apiGatewayPolicyId"}],"get":{"operationId":"get-api-gateway-service-shared-policy-chain-inbound-policy","summary":"Get a service shared policy chain policy","description":"Get a service shared policy chain inbound policy","responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Shared Inbound Policy Chain"]},"put":{"operationId":"update-api-gateway-service-shared-policy-chain-inbound-policy","summary":"Update a service shared policy chain policy","description":"Update a service shared policy chain inbound policy","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayServiceInboundPolicy"},"responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Shared Inbound Policy Chain"]},"delete":{"operationId":"delete-api-gateway-service-shared-policy-chain-inbound-policy","summary":"Delete a service shared policy chain policy","description":"Delete a service shared policy chain inbound policy","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Shared Inbound Policy Chain"]}},"/api-gateways/{gatewayId}/shared-policies/services/{apiGatewaySharedPolicyChainId}/outbound-policies":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/apiGatewaySharedPolicyChainId"}],"get":{"operationId":"list-api-gateway-service-shared-policy-chain-outbound-policies","summary":"List all service shared policy chain policies","description":"List all service shared policy chain outbound policies","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/apiGatewayPolicyParentId"}],"responses":{"200":{"$ref":"#/components/responses/APIGatewayOutboundPolicyListResponse"}},"tags":["API Gateway Service Shared Outbound Policy Chain"]},"post":{"operationId":"create-api-gateway-service-shared-policy-chain-outbound-policy","summary":"Create a service shared policy chain policy","description":"Create a service shared policy chain outbound policy","parameters":[{"$ref":"#/components/parameters/gatewayId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayServiceOutboundPolicy"},"responses":{"201":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["API Gateway Service Shared Outbound Policy Chain"]}},"/api-gateways/{gatewayId}/shared-policies/services/{apiGatewaySharedPolicyChainId}/outbound-policies/{apiGatewayPolicyId}":{"parameters":[{"$ref":"#/components/parameters/apiGatewaySharedPolicyChainId"},{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/apiGatewayPolicyId"}],"get":{"operationId":"get-api-gateway-service-shared-policy-chain-outbound-policy","summary":"Get a service shared policy chain policy","description":"Get a service shared policy chain outbound policy","responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Shared Outbound Policy Chain"]},"put":{"operationId":"update-api-gateway-service-shared-policy-chain-outbound-policy","summary":"Update a service shared policy chain policy","description":"Update a service shared policy chain outbound policy","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayServiceOutboundPolicy"},"responses":{"200":{"$ref":"#/components/responses/APIGatewayPolicy"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Shared Outbound Policy Chain"]},"delete":{"operationId":"delete-api-gateway-service-shared-policy-chain-outbound-policy","summary":"Delete a service shared policy chain policy","description":"Delete a service shared policy chain outbound policy","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Service Shared Outbound Policy Chain"]}},"/api-gateways/{gatewayId}/data-plane-certificates":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-api-gateway-data-plane-certificates","summary":"List API Gateway DataPlane Certificates","description":"Returns a list of dataplane certificates that are associated to this API gateway. A dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this API gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/APIGatewayCommonFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListAPIGatewayDataPlaneCertificatesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway DataPlane Certificates"]},"post":{"operationId":"create-api-gateway-data-plane-certificate","summary":"Create a New DataPlane Certificate","description":"Create new dataplane certificate to this API gateway. A dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this API gateway.","requestBody":{"$ref":"#/components/requestBodies/CreateAPIGatewayDataPlaneCertificateRequest"},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayDataPlaneCertificate"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway DataPlane Certificates"]}},"/api-gateways/{gatewayId}/data-plane-certificates/{certificateId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/certificateId"}],"get":{"operationId":"get-api-gateway-data-plane-certificate","summary":"Get DataPlane Certificate","description":"Returns information about an individual dataplane certificate.","responses":{"200":{"description":"A single dataplane certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayDataPlaneCertificate"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway DataPlane Certificates"]},"put":{"operationId":"update-api-gateway-data-plane-certificate","summary":"Update API Gateway DataPlane Certificate","description":"Updates an existing dataplane certificate associated with the specified API Gateway.","requestBody":{"$ref":"#/components/requestBodies/UpdateAPIGatewayDataPlaneCertificateRequest"},"responses":{"200":{"description":"Updated API gateway dataplane certificate object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayDataPlaneCertificate"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["API Gateway DataPlane Certificates"]},"delete":{"operationId":"delete-api-gateway-data-plane-certificate","summary":"Delete API Gateway DataPlane Certificate","description":"Deletes a specific dataplane certificate associated with the API Gateway.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway DataPlane Certificates"]}},"/api-gateways/{gatewayId}/nodes":{"parameters":[{"$ref":"#/components/parameters/gatewayId"}],"get":{"operationId":"list-api-gateway-nodes","summary":"List Nodes","description":"Returns a list of nodes associated with the specified API Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/ListAPIGatewayNodesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["API Gateway Nodes"]}},"/api-gateways/{gatewayId}/nodes/{apiGatewayNodeId}":{"parameters":[{"$ref":"#/components/parameters/gatewayId"},{"$ref":"#/components/parameters/apiGatewayNodeId"}],"get":{"operationId":"get-api-gateway-node","summary":"Get a Node","description":"Returns information about a specific node associated with the API Gateway.","responses":{"200":{"description":"A single node object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayNode"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Gateway Nodes"]}}},"components":{"parameters":{"APIGatewayCommonFilter":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldContainsFilter"}}},"in":"query","name":"filter","description":"Filter documents returned in the response.","required":false,"style":"deepObject"},"apiGatewayListenerId":{"schema":{"type":"string","format":"uuid"},"name":"apiGatewayListenerId","in":"path","required":true,"description":"The ID of the API Gateway Listener."},"apiGatewayNodeId":{"schema":{"type":"string","format":"uuid"},"name":"apiGatewayNodeId","in":"path","required":true,"description":"The ID of the API Gateway Node."},"apiGatewayPolicyId":{"schema":{"type":"string","format":"uuid"},"name":"apiGatewayPolicyId","in":"path","required":true,"description":"The ID of the API Gateway Policy."},"apiGatewayPolicyParentId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"parent_policy_id","in":"query","description":"The ID of the parent policy."},"apiGatewayRouteId":{"schema":{"type":"string","format":"uuid"},"name":"apiGatewayRouteId","in":"path","required":true,"description":"The ID of the API Gateway Route."},"apiGatewayServiceId":{"schema":{"type":"string","format":"uuid"},"name":"apiGatewayServiceId","in":"path","required":true,"description":"The ID of the API Gateway Service."},"apiGatewaySharedPolicyChainId":{"schema":{"type":"string","format":"uuid"},"name":"apiGatewaySharedPolicyChainId","in":"path","required":true,"description":"The ID of the API Gateway Shared Policy Chain."},"certificateId":{"schema":{"type":"string","format":"uuid"},"name":"certificateId","in":"path","required":true,"description":"The ID of the dataplane certificate."},"gatewayId":{"name":"gatewayId","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"},"description":"The UUID of your Gateway."},"PageAfter":{"name":"page[after]","description":"Request the next page of data, starting with the item after this parameter.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}}},"schemas":{"APIGatewayInfo":{"allOf":[{"$ref":"#/components/schemas/Gateway"},{"type":"object","required":["version"],"properties":{"version":{"description":"The version number of the API gateway. Every change to an entity\nunder this gateway will modify the version.\n","type":"string","example":"v1.123"}}}]},"APIGatewayListener":{"allOf":[{"$ref":"#/components/schemas/BaseAPIGatewayListener"},{"type":"object","properties":{"id":{"description":"The ID of the listener","type":"string","format":"uuid"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","created_at","updated_at","port","protocol"]}]},"BaseAPIGatewayListener":{"type":"object","properties":{"name":{"description":"The unique name of the listener.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the listener.","type":"string"},"port":{"$ref":"#/components/schemas/APIGatewayListenerPort"},"protocol":{"$ref":"#/components/schemas/APIGatewayListenerProtocol"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["port","protocol","name"]},"APIGatewayListenerPort":{"description":"The port number of the API Gateway listener.","type":"integer","maximum":65535,"minimum":1},"APIGatewayListenerProtocol":{"description":"The protocol used by the listener.","type":"string","enum":["http","https"]},"BaseAPIGatewayService":{"type":"object","properties":{"name":{"description":"The unique name of the API Gateway Service.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the service.","type":"string"},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["name"]},"APIGatewayService":{"allOf":[{"$ref":"#/components/schemas/BaseAPIGatewayService"},{"type":"object","required":["id","created_at","updated_at"],"properties":{"id":{"description":"The ID of the service.","type":"string","format":"uuid"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}}}]},"BaseAPIGatewayRoute":{"type":"object","properties":{"name":{"description":"The name of the API Gateway Route.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A human-readable description of the route.","type":"string"},"path":{"description":"The path to match for the route.","type":"string"},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["name","path"]},"APIGatewayRoute":{"allOf":[{"$ref":"#/components/schemas/BaseAPIGatewayRoute"},{"type":"object","required":["id","created_at","updated_at"],"properties":{"id":{"description":"The ID of the service.","type":"string","format":"uuid"},"default_service":{"$ref":"#/components/schemas/APIGatewayServiceReference"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}}}]},"APIGatewayRouteModify":{"allOf":[{"$ref":"#/components/schemas/BaseAPIGatewayRoute"},{"type":"object","properties":{"default_service":{"$ref":"#/components/schemas/APIGatewayServiceReferenceModify"}}}]},"APIGatewayServiceReference":{"description":"A reference to an existing service by ID.","type":"object","properties":{"id":{"description":"The ID of the service","type":"string","format":"uuid"},"name":{"description":"The name identifier of the service","type":"string","maxLength":255,"minLength":1}},"required":["id","name"]},"APIGatewayServiceReferenceModify":{"description":"A reference to an existing service, either by ID or by name.","anyOf":[{"$ref":"#/components/schemas/APIGatewayServiceReferenceById"},{"$ref":"#/components/schemas/APIGatewayServiceReferenceByName"}]},"APIGatewayServiceReferenceById":{"description":"A reference to an existing service by ID.","type":"object","properties":{"id":{"description":"The ID of the service","type":"string","format":"uuid"}},"required":["id"]},"APIGatewayServiceReferenceByName":{"description":"A reference to an existing service by name.","type":"object","properties":{"name":{"description":"The name identifier of the service","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"}},"required":["name"]},"APIGatewayPolicy":{"description":"A policy that can be applied to an API Gateway.","type":"object","properties":{"id":{"description":"The ID of the policy","type":"string","format":"uuid"},"type":{"description":"The type identifier of the policy","type":"string"},"name":{"description":"The name of the policy","type":"string"},"config":{"description":"The configuration of the policy","type":"object"},"parent_policy_id":{"description":"The unique identifier of the parent policy, if any.","type":"string","format":"uuid","nullable":true},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.","type":"string","example":"context.introspect_token.claims.gold_tier == true","maxLength":1000,"minLength":1,"x-expression":{"type":"boolean"}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["id","type","config","created_at","updated_at"]},"CreateAPIGatewayListenerPolicy":{"discriminator":{"propertyName":"type","mapping":{"terminate":"#/components/schemas/TerminatePolicy","forward_to_svc":"#/components/schemas/ForwardToSvcPolicy"}},"oneOf":[{"$ref":"#/components/schemas/TerminatePolicy"},{"$ref":"#/components/schemas/ForwardToSvcPolicy"}]},"CreateAPIGatewayServiceInboundPolicy":{"discriminator":{"propertyName":"type","mapping":{"policy_chain_reference":"#/components/schemas/PolicyChainReferencePolicy","rate_limit":"#/components/schemas/RateLimitPolicy","set_req_header":"#/components/schemas/SetReqHeaderPolicy","terminate":"#/components/schemas/TerminatePolicy","forward_to_upstream":"#/components/schemas/ForwardToUpstreamPolicy"}},"oneOf":[{"$ref":"#/components/schemas/PolicyChainReferencePolicy"},{"$ref":"#/components/schemas/RateLimitPolicy"},{"$ref":"#/components/schemas/SetReqHeaderPolicy"},{"$ref":"#/components/schemas/TerminatePolicy"},{"$ref":"#/components/schemas/ForwardToUpstreamPolicy"}]},"CreateAPIGatewayServiceOutboundPolicy":{"discriminator":{"propertyName":"type","mapping":{"policy_chain_reference":"#/components/schemas/PolicyChainReferencePolicy","set_resp_header":"#/components/schemas/SetRespHeaderPolicy","terminate":"#/components/schemas/TerminatePolicy"}},"oneOf":[{"$ref":"#/components/schemas/PolicyChainReferencePolicy"},{"$ref":"#/components/schemas/SetRespHeaderPolicy"},{"$ref":"#/components/schemas/TerminatePolicy"}]},"CreateAPIGatewayRouteInboundPolicy":{"discriminator":{"propertyName":"type","mapping":{"policy_chain_reference":"#/components/schemas/PolicyChainReferencePolicy","rate_limit":"#/components/schemas/RateLimitPolicy","set_req_header":"#/components/schemas/SetReqHeaderPolicy","terminate":"#/components/schemas/TerminatePolicy","forward_to_svc":"#/components/schemas/ForwardToSvcPolicy"}},"oneOf":[{"$ref":"#/components/schemas/PolicyChainReferencePolicy"},{"$ref":"#/components/schemas/RateLimitPolicy"},{"$ref":"#/components/schemas/SetReqHeaderPolicy"},{"$ref":"#/components/schemas/TerminatePolicy"},{"$ref":"#/components/schemas/ForwardToSvcPolicy"}]},"CreateAPIGatewayRouteOutboundPolicy":{"discriminator":{"propertyName":"type","mapping":{"policy_chain_reference":"#/components/schemas/PolicyChainReferencePolicy","set_resp_header":"#/components/schemas/SetRespHeaderPolicy","terminate":"#/components/schemas/TerminatePolicy"}},"oneOf":[{"$ref":"#/components/schemas/PolicyChainReferencePolicy"},{"$ref":"#/components/schemas/SetRespHeaderPolicy"},{"$ref":"#/components/schemas/TerminatePolicy"}]},"BaseAPIGatewayPolicy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"type":{"description":"The type identifier of the policy","type":"string"},"name":{"description":"The name identifier of the policy","type":"string"},"config":{"description":"The configuration of the policy","type":"object"},"condition":{"description":"A string containing the boolean expression that determines whether the policy is applied.","type":"string","example":"context.introspect_token.claims.gold_tier == true","maxLength":1000,"minLength":1,"x-expression":{"type":"boolean"}},"parent_policy_id":{"description":"The unique identifier of the parent policy, if any.","type":"string","format":"uuid","nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["type"]},"PolicyChainReferencePolicy":{"allOf":[{"$ref":"#/components/schemas/BaseAPIGatewayPolicy"},{"type":"object","properties":{"type":{"type":"string","enum":["policy_chain_reference"]},"config":{"oneOf":[{"$ref":"#/components/schemas/PolicyChainReferenceById"},{"$ref":"#/components/schemas/PolicyChainReferenceByName"}]}},"required":["type","config"]}]},"PolicyChainReferenceById":{"description":"Reference a policy chain by its unique identifier.","type":"object","properties":{"id":{"description":"The unique identifier of the policy chain.","type":"string","format":"uuid"}},"additionalProperties":false,"required":["id"]},"PolicyChainReferenceByName":{"description":"Reference a policy chain by its unique name.","type":"object","properties":{"name":{"description":"The name of the shared policy chain to reference.","type":"string"}},"additionalProperties":false,"required":["name"]},"RateLimitPolicy":{"allOf":[{"$ref":"#/components/schemas/BaseAPIGatewayPolicy"},{"type":"object","properties":{"type":{"type":"string","enum":["rate_limit"]},"config":{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer"},"window_size":{"type":"integer"},"bucket_key":{"type":"string"}},"required":["limit","window_size"]}},"required":["type","config"]}]},"SetReqHeaderPolicy":{"allOf":[{"$ref":"#/components/schemas/BaseAPIGatewayPolicy"},{"type":"object","properties":{"type":{"type":"string","enum":["set_req_header"]},"config":{"$ref":"#/components/schemas/HeaderProperty"}},"required":["type","config"]}]},"SetRespHeaderPolicy":{"allOf":[{"$ref":"#/components/schemas/BaseAPIGatewayPolicy"},{"type":"object","properties":{"type":{"type":"string","enum":["set_resp_header"]},"config":{"$ref":"#/components/schemas/HeaderProperty"}},"required":["type","config"]}]},"TerminatePolicy":{"allOf":[{"$ref":"#/components/schemas/BaseAPIGatewayPolicy"},{"type":"object","properties":{"type":{"type":"string","enum":["terminate"]},"config":{"type":"object","additionalProperties":false,"properties":{"status":{"type":"integer"},"body":{"type":"string"}},"required":["status","body"]}},"required":["type","config"]}]},"ForwardToSvcPolicy":{"allOf":[{"$ref":"#/components/schemas/BaseAPIGatewayPolicy"},{"type":"object","properties":{"type":{"type":"string","enum":["forward_to_svc"]},"config":{"type":"object","additionalProperties":false,"properties":{"service":{"$ref":"#/components/schemas/APIGatewayServiceReferenceModify"}},"required":["service"]}},"required":["type","config"]}]},"ForwardToUpstreamPolicy":{"allOf":[{"$ref":"#/components/schemas/BaseAPIGatewayPolicy"},{"type":"object","properties":{"type":{"type":"string","enum":["forward_to_upstream"]},"config":{"type":"object","additionalProperties":false,"properties":{"hostname":{"type":"string"},"path":{"type":"string"}},"required":["hostname","path"]}},"required":["type","config"]}]},"HeaderProperty":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false,"required":["key","value"]},"APIGatewayPolicyList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/APIGatewayPolicy"}},"meta":{"$ref":"#/components/schemas/CursorMeta"}},"required":["data","meta"]},"APIGatewaySharedPolicyChain":{"description":"A reusable policy chain that can be applied to multiple routes or services.","type":"object","properties":{"id":{"description":"The ID of the shared policy chain","type":"string","format":"uuid","readOnly":true},"name":{"description":"The unique name of the shared policy chain","type":"string"},"title":{"description":"The title of the shared policy chain.","type":"string"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["name"]},"CreateAPIGatewaySharedPolicyChain":{"type":"object","properties":{"name":{"description":"The unique name of the shared policy chain","type":"string"},"title":{"description":"The title of the shared policy chain","type":"string"},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["name"]},"APIGatewayDataPlaneCertificate":{"description":"A dataplane certificate.","type":"object","properties":{"id":{"description":"The unique identifier of the certificate.","type":"string","format":"uuid"},"certificate":{"description":"JSON escaped string of the certificate.","type":"string"},"name":{"description":"The name to identify of the certificate.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"description":{"description":"A description of the certificate.","type":"string"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"metadata":{"$ref":"#/components/schemas/APIGatewayCertificateMetadata"}},"required":["id","certificate","created_at","updated_at"]},"APIGatewayCertificateMetadata":{"description":"Metadata extracted from a certificate.","type":"object","properties":{"issuer":{"description":"The issuer of the certificate.","type":"string"},"subject":{"description":"The subject of the certificate.","type":"string"},"key_usages":{"description":"The key usages of the certificate.","type":"array","items":{"type":"string"}},"expiry":{"description":"The expiry date of the certificate as a unix timestamp.","type":"integer","format":"int64"},"san_names":{"description":"The Subject Alternative Names (SAN) of the certificate.","type":"array","items":{"type":"string"}},"dns_names":{"description":"The DNS names in the certificate SAN.","type":"array","items":{"type":"string"}},"email_addresses":{"description":"The email addresses in the certificate SAN.","type":"array","items":{"type":"string"}},"ip_addresses":{"description":"The IP addresses in the certificate SAN.","type":"array","items":{"type":"string"}},"uris":{"description":"The URIs in the certificate SAN.","type":"array","items":{"type":"string","format":"uri"}},"sha256_fingerprint":{"description":"The SHA-256 fingerprint of the certificate.","type":"string"}}},"StringFieldContainsFilter":{"description":"Filters on the given string field value by fuzzy match.","type":"object","properties":{"contains":{"type":"string"}},"additionalProperties":false,"required":["contains"],"title":"StringFieldContainsFilter","x-examples":{"example-1":{"contains":"some-value"}}},"CursorMetaPage":{"type":"object","properties":{"first":{"description":"URI to the first page","type":"string","format":"path"},"last":{"description":"URI to the last page","type":"string","format":"path"},"next":{"description":"URI to the next page","type":"string","format":"path","nullable":true},"previous":{"description":"URI to the previous page","type":"string","format":"path","nullable":true},"size":{"description":"Requested page size","type":"number","example":10}},"required":["size","next","previous"]},"CursorMeta":{"description":"Pagination metadata.","type":"object","properties":{"page":{"$ref":"#/components/schemas/CursorMetaPage"}},"required":["page"]},"GatewayName":{"description":"The name of the Gateway.","type":"string","maxLength":255,"minLength":1,"x-unicode-pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.:/+']*[\\p{L}\\p{N}]$"},"GatewayDescription":{"description":"A human-readable description of the Gateway.","type":"string","maxLength":512},"Labels":{"description":"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63},"maxProperties":50,"title":"Labels"},"Gateway":{"description":"The gateway object contains information about a Konnect gateway.","type":"object","properties":{"id":{"description":"The gateway ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"name":{"$ref":"#/components/schemas/GatewayName"},"description":{"$ref":"#/components/schemas/GatewayDescription"},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"description":"An ISO-8604 timestamp representation of gateway creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"updated_at":{"description":"An ISO-8604 timestamp representation of gateway update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"additionalProperties":false,"required":["id","name","created_at","updated_at"],"x-examples":{"Example 1":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Test Gateway","labels":{"env":"test"},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}}},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"MinRuntimeVersion":{"description":"The minimum runtime version supported by the API. This is the lowest version of the data plane\nrelease that can be used with the entity model.\nWhen not specified, the minimum runtime version will be pinned to the latest available release.\n","type":"string","example":"1.1","pattern":"^\\d+\\.\\d+$"},"CreateGatewayRequest":{"description":"The request schema for the create gateway request.","type":"object","properties":{"name":{"$ref":"#/components/schemas/GatewayName"},"description":{"$ref":"#/components/schemas/GatewayDescription"},"min_runtime_version":{"$ref":"#/components/schemas/MinRuntimeVersion"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name"],"title":"CreateGatewayRequest"},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]},"MinRuntimeVersionUpdate":{"description":"The minimum runtime version supported by the API. This is the lowest version of the data plane\nrelease that can be used with the entity model.\nWhen not specified, the minimum runtime version will not be updated.\n","type":"string","example":"1.1","pattern":"^\\d+\\.\\d+$"},"UpdateGatewayRequest":{"description":"The request schema for the update gateway request.","type":"object","properties":{"name":{"$ref":"#/components/schemas/GatewayName"},"description":{"$ref":"#/components/schemas/GatewayDescription"},"min_runtime_version":{"$ref":"#/components/schemas/MinRuntimeVersionUpdate"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"title":"UpdateGatewayRequest"},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"GatewayNode":{"type":"object","properties":{"id":{"description":"The node ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"version":{"description":"The string representation of the node current version.","type":"string"},"last_seen_at":{"description":"An ISO-8604 timestamp representation of node last seen date.","type":"string","format":"date-time","example":"2025-08-04T20:10:06.927Z"},"created_at":{"description":"An ISO-8604 timestamp representation of node creation date.","type":"string","format":"date-time","example":"2025-08-04T20:10:06.927Z","readOnly":true},"updated_at":{"description":"An ISO-8604 timestamp representation of node update date.","type":"string","format":"date-time","example":"2025-08-04T20:10:06.927Z","readOnly":true},"config_applied_at":{"description":"The time the node succeeds in applying the configuration.","type":"string","format":"date-time","readOnly":true},"config_version":{"description":"The version number of the configuration applied by the node.","type":"string","example":"v1.123","readOnly":true}},"required":["id","version","last_seen_at","created_at","updated_at"]}},"examples":{"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"CreateAPIGatewayListenerRequest":{"description":"The http listener to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseAPIGatewayListener"}}}},"UpdateAPIGatewayListenerRequest":{"description":"Listener to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseAPIGatewayListener"}}}},"CreateAPIGatewayService":{"description":"The service to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseAPIGatewayService"}}}},"UpdateAPIGatewayService":{"description":"The service to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseAPIGatewayService"}}}},"CreateAPIGatewayRoute":{"description":"The route to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayRouteModify"}}}},"UpdateAPIGatewayRoute":{"description":"The route to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayRouteModify"}}}},"CreateAPIGatewayListenerPolicy":{"description":"The listener policy to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIGatewayListenerPolicy"}}}},"UpdateAPIGatewayListenerPolicy":{"description":"The policy to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIGatewayListenerPolicy"}}}},"CreateAPIGatewayServiceInboundPolicy":{"description":"The service inboundpolicy to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIGatewayServiceInboundPolicy"}}}},"CreateAPIGatewayServiceOutboundPolicy":{"description":"The service outbound policy to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIGatewayServiceOutboundPolicy"}}}},"UpdateAPIGatewayServiceInboundPolicy":{"description":"The inbound policy to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIGatewayServiceInboundPolicy"}}}},"UpdateAPIGatewayServiceOutboundPolicy":{"description":"The outbound policy to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIGatewayServiceOutboundPolicy"}}}},"CreateAPIGatewayRouteInboundPolicy":{"description":"The route inbound policy to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIGatewayRouteInboundPolicy"}}}},"UpdateAPIGatewayRouteInboundPolicy":{"description":"The inbound policy to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIGatewayRouteInboundPolicy"}}}},"CreateAPIGatewayRouteOutboundPolicy":{"description":"The route outbound policy to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIGatewayRouteOutboundPolicy"}}}},"UpdateAPIGatewayRouteOutboundPolicy":{"description":"The outbound policy to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIGatewayRouteOutboundPolicy"}}}},"CreateAPIGatewaySharedPolicyChain":{"description":"The shared policy to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIGatewaySharedPolicyChain"}}}},"UpdateAPIGatewaySharedPolicyChain":{"description":"The shared policy to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIGatewaySharedPolicyChain"}}}},"CreateAPIGatewayDataPlaneCertificateRequest":{"content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"description":"JSON escaped string of the certificate.","type":"string"},"name":{"description":"The name to identify the certificate.","type":"string"},"description":{"description":"A description of the certificate.","type":"string"}},"required":["certificate"]},"examples":{"Sample Certificate":{"value":{"certificate":"-----BEGIN CERTIFICATE-----\r\n*****\r\n-----END CERTIFICATE-----\r\n"}}}}},"description":"Request body for creating a certificate."},"UpdateAPIGatewayDataPlaneCertificateRequest":{"description":"The request schema for updating a dataplane certificate.","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"description":"JSON escaped string of the certificate.","type":"string"},"name":{"description":"The name to identify of the certificate.","type":"string"},"description":{"description":"A description of the certificate.","type":"string"}},"required":["certificate"]}}}}},"responses":{"ListAPIGatewaysResponse":{"description":"A paginated list response for a collection of gateways.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/APIGatewayInfo"}}},"additionalProperties":false,"required":["meta","data"],"title":"ListAPIGatewaysResponse"}}}},"CreateAPIGatewayResponse":{"description":"A response to creating a gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayInfo"}}}},"UpdateAPIGatewayResponse":{"description":"A response to updating a gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayInfo"}}}},"ListAPIGatewayListenersResponse":{"description":"A paginated list response for a collection of API Gateway Listeners.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/APIGatewayListener"}}}}}}},"APIGatewayServiceListResponse":{"description":"List of API Gateway Services","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/APIGatewayService"}}},"additionalProperties":false,"required":["meta","data"]}}}},"APIGatewayRouteListResponse":{"description":"List of API Gateway Routes","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/APIGatewayRoute"}}},"additionalProperties":false,"required":["meta","data"]}}}},"APIGatewayPolicyListResponse":{"description":"A paginated list response for a collection of API Gateway Inbound Policies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayPolicyList"}}}},"APIGatewayInboundPolicyListResponse":{"description":"A paginated list response for a collection of API Gateway Inbound Policies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayPolicyList"}}}},"APIGatewayOutboundPolicyListResponse":{"description":"A paginated list response for a collection of API Gateway Outbound Policies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayPolicyList"}}}},"APIGatewayPolicy":{"description":"An API Gateway policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewayPolicy"}}}},"APIGatewaySharedPolicyChainListResponse":{"description":"A paginated list response for a collection of API Gateway Shared Policy Chains.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/APIGatewaySharedPolicyChain"}}}}}}},"APIGatewaySharedPolicyChain":{"description":"A shared policy chain for a gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIGatewaySharedPolicyChain"}}}},"ListAPIGatewayDataPlaneCertificatesResponse":{"description":"A paginated list response for a collection of certificates associated with an API Gateway.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/APIGatewayDataPlaneCertificate"}}}}}}},"ListAPIGatewayNodesResponse":{"description":"A paginated list response for a collection of nodes associated with an API Gateway.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GatewayNode"}}}}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"Internal":{"description":"Internal","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"NotAvailable":{"description":"Service not available","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n"}}},"tags":[{"name":"API Gateways"}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
