---
title: "Konnect Runtime Groups Configuration"
url: "https://nov18-dev.movespot.fyi/apis/konnect-runtime-groups-configuration-0/versions/af18902c-58f1-49d7-8ec2-9987b4e0d1bd"
---

# Konnect Runtime Groups Configuration

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"contact":{"email":"support@konghq.com","name":"Kong Inc","url":"https://konghq.com"},"description":"The API for configurating Konnect Runtime Groups.","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"title":"Konnect Runtime Groups Configuration","version":"0.0.1"},"servers":[{"url":"https://us.api.konghq.com/v2","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v2","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v2","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v2","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v2","description":"India Production region"},{"url":"https://sg.api.konghq.com/v2","description":"Singapore Production region"}],"paths":{"/runtime-groups/{runtimeGroupId}/expected-config-hash":{"get":{"operationId":"get-expected-config-hash","summary":"Get an Expected Config Hash","description":"Retrieve the expected config hash for this runtime group. The expected config hash can be used to verify if the config hash of a runtime instance is up to date with the runtime group. The config hash will be the same if they are in sync.","responses":{"200":{"$ref":"#/components/responses/get-expected-config-hash"}},"tags":["DP Nodes"]},"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/dp-client-certificates":{"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}],"get":{"operationId":"get-dp-client-certificates","summary":"List DP Client Certificates","description":"Returns a list of pinned dataplane client certificates that are associated to this runtime group. A pinned dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this runtime group.","responses":{"200":{"$ref":"#/components/responses/list-dp-client-certs"}},"tags":["DP Certificates"]},"post":{"operationId":"post-dp-client-certificates","summary":"Pin New DP Client Certificate","description":"Pin a new DP Client Certificate to this runtime group. A pinned dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this runtime group.","requestBody":{"$ref":"#/components/requestBodies/create-dp-client-cert"},"responses":{"201":{"$ref":"#/components/responses/get-dp-client-cert"}},"tags":["DP Certificates"]}},"/runtime-groups/{runtimeGroupId}/dp-client-certificates/{certificateId}":{"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"},{"name":"certificateId","in":"path","required":true,"schema":{"type":"string"}}],"get":{"operationId":"get-dp-client-certificates-cert_id","summary":"Get a DP Client Certificate","description":"Retrieve a pinned dataplane client certificate associated to this runtime group. A pinned dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this runtime group.","parameters":[{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/page_number"}],"responses":{"200":{"$ref":"#/components/responses/get-dp-client-cert"}},"tags":["DP Certificates"]},"delete":{"operationId":"delete-dp-client-certificates-cert_id","summary":"Delete DP Client Certificate","description":"Remove a pinned dataplane client certificate associated to this runtime group. Removing a pinned dataplane certificate would invalidate any dataplanes currently connected to this runtime group using this certificate.","responses":{"204":{"description":"No Content"}},"tags":["DP Certificates"]}},"/runtime-groups/{runtimeGroupId}/nodes":{"get":{"operationId":"get-nodes","summary":"List Runtime Instance Records","description":"Returns a list of runtime instance records that are associated to this runtime group. A runtime instance record contains all the metadata information of the Kong Gateway dataplane.","parameters":[{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/page_number"}],"responses":{"200":{"$ref":"#/components/responses/list-nodes"}},"tags":["DP Nodes"]},"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/nodes/eol":{"get":{"operationId":"get-nodes-eol","summary":"List Runtime Instance End-of-Life Records","description":"Returns a list of records of runtime instances, whose versions are approaching End of Full Support/End of Life, that are associated to this runtime group. Each record contains a runtime's id, version, and corresponding resolution message to upgrade to the closest Long Term Support version.","parameters":[{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/page_number"}],"responses":{"200":{"$ref":"#/components/responses/list-nodes-eol"}},"tags":["DP Nodes"]},"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/nodes/{nodeId}":{"parameters":[{"name":"nodeId","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/runtimeGroupId"}],"get":{"operationId":"get-nodes-node_id","summary":"Get a Runtime Instance Record","description":"Retrieve a specific runtime instance record associated to this runtime group. A runtime instance record contains all the metadata information of the Kong Gateway dataplane.","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/get-node"}},"tags":["DP Nodes"]},"delete":{"operationId":"delete-nodes-node_id","summary":"Delete Runtime Instance Record","description":"Remove a specific runtime instance record associated to this runtime group. Deleting this record does not prevent the runtime instance from re-connecting to the runtime group.","responses":{"204":{"description":"No Content"}},"tags":["DP Nodes"]}},"/runtime-groups/{runtimeGroupId}/core-entities/plugin-schemas":{"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}],"get":{"operationId":"list-plugin-schemas","summary":"List custom plugin schemas associated with a runtime group","description":"Returns an array of custom plugins schemas associated with a runtime group.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/PageBefore"}],"responses":{"200":{"$ref":"#/components/responses/list-plugin-schemas"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Custom Plugin Schemas"]},"post":{"operationId":"create-plugin-schemas","summary":"Upload custom plugin schema","description":"Upload a custom plugin schema associated with a runtime group.","requestBody":{"$ref":"#/components/requestBodies/create-plugin-schemas"},"responses":{"201":{"$ref":"#/components/responses/plugin-schemas"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Custom Plugin Schemas"]}},"/runtime-groups/{runtimeGroupId}/core-entities/plugin-schemas/{name}":{"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"},{"name":"name","in":"path","description":"The custom plugin name","required":true,"schema":{"type":"string","example":"myplugin"}}],"get":{"operationId":"get-plugin-schema","summary":"Get a custom plugin schema","description":"Returns information about a custom plugin from a given name.","responses":{"200":{"$ref":"#/components/responses/plugin-schemas"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Custom Plugin Schemas"]},"delete":{"operationId":"delete-plugin-schemas","summary":"Delete custom plugin schema","description":"Delete an individual custom plugin schema.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Custom Plugin Schemas"]},"put":{"operationId":"update-plugin-schemas","summary":"Create or update a custom plugin schema","description":"Create or update an individual custom plugin schema.","requestBody":{"$ref":"#/components/requestBodies/create-plugin-schemas"},"responses":{"200":{"$ref":"#/components/responses/plugin-schemas"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Custom Plugin Schemas"]}},"/runtime-groups/{runtimeGroupId}/core-entities/ca_certificates":{"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}],"get":{"operationId":"list-ca_certificates","summary":"List all CA certificates","description":"Retrieve a list of all available Certificate Authority (CA) certificates, including the certificate ID, creation date, and other details. You can use query parameters to filter the results by size or tags, for example `/ca-certificates?size=50&tags=enterprise`.","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"A successful response listing CA Certificates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CA-Certificate"}}}}},"tags":["CA Certificates"]},"post":{"operationId":"create-ca_certificate","summary":"Create a new CA certificate","description":"Create a new Certificate Authority (CA) certificate. The request body must include the `cert` property, the certificate data in PEM format; it can also include `cert_digest`, a digest of the certificate in hex format for verifying the certificates integrity, and `tags`, an optional list of tags to categorize the certificate. ","requestBody":{"$ref":"#/components/requestBodies/CA-cert-request"},"responses":{"201":{"description":"The created certificate object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CA-Certificate"}}}},"400":{"description":"Invalid CA certificate"}},"tags":["CA Certificates"]}},"/runtime-groups/{runtimeGroupId}/core-entities/ca_certificates/{ca_certificate_id}":{"delete":{"operationId":"delete-ca_certificate","summary":"Delete a CA Certificate","description":"Delete the specified Certificate Authority (CA) certificate using the provided ca_certificate_id.","responses":{"204":{"description":"Successfully deleted CA Certificate or the resource didn't exist"}},"tags":["CA Certificates"]},"get":{"operationId":"get-ca_certificate","summary":"Get a CA certificate","description":"Retrieve details about the specified Certificate Authority (CA) certificate using the provided path parameter `ca_certificate_id`.","parameters":[{"name":"ca_certificate_id","in":"path","description":"The unique identifier of the certificate to retrieve.","required":true,"schema":{"type":"string"},"examples":{"example":{"summary":"Example CA certificate ID","value":"04fbeacf-a9f1-4a5d-ae4a-b0407445db3f"}}},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"The specified CA certificate exists in the system, and the response includes details about the certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CA-Certificate"}}}},"404":{"description":"Resource does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"Error code","type":"integer","example":5},"message":{"description":"A message describing the error message.","type":"string","example":"not found"}},"x-examples":{"Example 1":{"code":5,"message":"not found"}}},"examples":{"404 Not Found":{"value":{"code":5,"message":"not found"}}}}}}},"tags":["CA Certificates"]},"put":{"operationId":"updatet-ca_certificate","summary":"Update a CA Certificate","description":"Create or Update a CA Certificate using the provided path parameter `ca_certificate_id`.","requestBody":{"$ref":"#/components/requestBodies/CA-cert-request"},"responses":{"200":{"description":"Successfully upserted CA Certificate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CA-Certificate"}}}},"400":{"description":"Invalid CA Certificate","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["CA Certificates"]},"parameters":[{"$ref":"#/components/parameters/ca_certificate_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/certificates":{"get":{"operationId":"list-certificates","summary":"List all certificates","description":"Retrieve a list of all available certificate/ You can use query parameters to filter the results by size or tags, for example `/certificates?size=50&tags=enterprise`.","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/certificate_response"}},"tags":["Certificates"]},"post":{"operationId":"create-certificate","summary":"Create a new Certificate","description":"Create a new certificate with the provided details. Use this endpoint to add a new certificate to the system. The request body must include the certificate data and other details required for creating a new certificate.","requestBody":{"$ref":"#/components/requestBodies/cert-request"},"responses":{"200":{"$ref":"#/components/responses/certificate_response"},"400":{"description":"Invalid Certificate","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Certificates"]},"parameters":[{"name":"runtimeGroupId","in":"path","description":"The ID of your runtime group. This variable is available in the Konnect manager","required":true,"schema":{"type":"string","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"}}]},"/runtime-groups/{runtimeGroupId}/core-entities/certificates/{certificate_id}":{"delete":{"operationId":"delete-certificate","summary":"Delete a Certificate","description":"Delete a Certificate\n","parameters":[{"name":"certificate_id","in":"path","description":"ID of the Certificate to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successfully deleted Certificate or the resource didn't exist"}},"tags":["Certificates"]},"get":{"operationId":"get-certificate","summary":"Get a Certificate","description":"Retrieve details about the specified certificate using the provided path parameter `certificate_id`.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"},{"$ref":"#/components/parameters/pagination-size"}],"responses":{"200":{"description":"HTTP 200 OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"}}}},"404":{"description":"Resource does not exist"}},"tags":["Certificates"]},"put":{"operationId":"update-certificate-put","summary":"Update a Certificate","description":"Update details about the specified certificate using the provided path parameter `certificate_id`.\n\nInserts (or replaces) the certificate under the requested `certificate_id`with the definition specified in the request body. When the `id` attribute has the structure of a UUID, the certificate being inserted/replaced will be identified by its `id`. Otherwise it will be identified by the `name`.\n\nWhen creating a new Certificate without specifying `id` (neither in the path or the request body), then it will be auto-generated.\n","requestBody":{"$ref":"#/components/requestBodies/cert-request"},"responses":{"200":{"description":"Successfully upserted Certificate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"}}}},"400":{"description":"Invalid Certificate","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Certificates"]},"parameters":[{"name":"certificate_id","in":"path","description":"The unique identifier of the Certificate to retrieve.","required":true,"schema":{"type":"string","example":"7fca84d6-7d37-4a74-a7b0-93e576089a41"}},{"name":"runtimeGroupId","in":"path","description":"The ID of your runtime group. This variable is available in the Konnect manager","required":true,"schema":{"type":"string","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"}}]},"/runtime-groups/{runtimeGroupId}/core-entities/certificates/{certificate_name_or_id}/snis":{"get":{"operationId":"get-sni-with-certificate","summary":"List SNIs associated with a certificate","description":"Retrieve a paginated list of all SNIs associated with a certificate. Use this endpoint to retrieve a list of SNIs that are linked to a specific certificate. You can use the optional query parameters to filter the results based on specific criteria. The response will include the list of SNIs and pagination information. See the response schema for details on the expected format of the response body.","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/sni-response"}},"tags":["SNIs"]},"post":{"operationId":"create-sni-for-certificate","summary":"Create a new SNI associated with a Certificate","description":"Create a new SNI and associate it with a certificate in the system. Use this endpoint to add a new SNI to the system and link it to a specific certificate.","requestBody":{"$ref":"#/components/requestBodies/create-sni"},"responses":{"200":{"description":"Successfully created SNI","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SNI"}}}},"400":{"description":"Invalid SNI","content":{"application/json":{"schema":{"type":"object"},"examples":{"Bad Request":{"value":{"code":3,"message":"data constraint error","details":[{"@type":"type.googleapis.com/kong.admin.model.v1.ErrorDetail","type":"ERROR_TYPE_REFERENCE","field":"certificate.id","messages":["certificate_id (type: foreign) constraint failed for value 'a3ad71a8-6685-4b03-a101-980a953544f6': "]}]}}}}}}},"tags":["SNIs"]},"parameters":[{"$ref":"#/components/parameters/certificate_name_or_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/certificates/{certificate_id}/snis/{sni_id}":{"delete":{"operationId":"delete-sni-for-certificate","summary":"Delete a an SNI associated with a Certificate","description":"Delete a an SNI associated with a a Certificate using an ID.","responses":{"204":{"description":"Successfully deleted SNI or the resource didn't exist"}},"tags":["SNIs"]},"get":{"operationId":"fetch-sni-with-certificate","summary":"Get an SNI associated with a certificate","description":"Get an SNI associated with a Certificate using ID or name.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"Successfully fetched SNI","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SNI"}}}},"404":{"description":"Resource does not exist"}},"tags":["SNIs"]},"put":{"operationId":"upsert-sni-for-certificate","summary":"Upsert an SNI associated with a certificate","description":"Create or Update an SNI associated with a Certificate using ID or name.\n\nInserts (or replaces) the SNI under the requested resource with the definition specified in the body. The SNI will be identified by the id attribute.\n\nWhen the name or id attribute has the structure of a UUID, the SNI being inserted/replaced will be identified by its id. Otherwise it will be identified by its name.\n\nWhen creating a new SNI without specifying id (neither in the URL nor in the body), then it will be auto-generated.","requestBody":{"description":"Description of the SNI","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SNI"}}}},"responses":{"200":{"description":"Successfully upserted SNI","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SNI"}}}},"400":{"description":"Invalid SNI","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["SNIs"]},"parameters":[{"$ref":"#/components/parameters/certificate_id"},{"$ref":"#/components/parameters/sni_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/consumers":{"get":{"operationId":"list-consumers","summary":"List all Consumers","description":"Retrieve a list of all consumers.You can use query parameters to filter the results by size or tags, for example `/consumers?size=50&tags=enterprise`.","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/consumer-create-response"}},"tags":["Consumers"]},"post":{"operationId":"create-consumer","summary":"Create a new Consumer","description":"Create a new Consumer","requestBody":{"$ref":"#/components/requestBodies/consumer-request"},"responses":{"200":{"$ref":"#/components/responses/consumer-create-response"},"400":{"description":"Invalid Consumer","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Consumers"]},"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/consumers/{consumer_id}":{"delete":{"operationId":"delete-consumer","summary":"Delete a Consumer","description":"Delete a specific consumer from the system using either the consumer ID or the consumer username. This operation is irreversible and permanently removes all data associated with the specified consumer. If the consumer was deleted succesfully the endpoint will return a 204 response indicating that the resource did not exist.","responses":{"204":{"description":"Successfully deleted Consumer or the resource didn't exist"}},"tags":["Consumers"]},"get":{"operationId":"get-consumer","summary":"Get a Consumer","description":"Retrieve the details of a specific consumer in the system using either the consumer ID or the consumer username. If the consumer with the specified ID or username cannot be found, the endpoint will return a 404.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/consumer-create-response"},"404":{"description":"Resource does not exist"}},"tags":["Consumers"]},"put":{"operationId":"upsert-consumer","summary":"Update a Consumer","description":"Create or Update Consumer using ID or username. The consumer will be identified via the username or id attribute.If the consumer with the specified ID or username cannot be found, the endpoint will return a 404.\n\nWhen the username or id attribute has the structure of a UUID, the Consumer being inserted/replaced will be identified by its id. Otherwise it will be identified by its username.\n\nWhen creating a new Consumer without specifying id (neither in the URL nor in the body), then it will be auto-generated.\n\nNotice that specifying a username in the URL and a different one in the request body is not allowed.","requestBody":{"$ref":"#/components/requestBodies/consumer-request"},"responses":{"200":{"$ref":"#/components/responses/consumer-response-data"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"}},"tags":["Consumers"]},"parameters":[{"$ref":"#/components/parameters/consumer_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/consumers/{consumer_id}/plugins":{"get":{"operationId":"list-plugins-for-consumer","summary":"List all plugins associated with a consumer","description":"Retrieve a list of all plugins associated with a consumer. ","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/plugin-response"}},"tags":["Plugins"]},"post":{"operationId":"create-plugin-for-consumer","summary":"Create a new Plugin associated with a Consumer","description":"Create a new Plugin associated with a Consumer","requestBody":{"$ref":"#/components/requestBodies/plugin-request"},"responses":{"200":{"$ref":"#/components/responses/plugin-response"},"400":{"description":"Invalid Plugin","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Plugins"]},"parameters":[{"$ref":"#/components/parameters/consumer_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/consumers/{consumer_id}/plugins/{plugin_id_or_instance_name}":{"delete":{"operationId":"delete-plugin-for-consumer","summary":"Delete a a Plugin associated with a a Consumer","description":"Delete a a Plugin associated with a a Consumer using ID.","responses":{"204":{"description":"Successfully deleted Plugin or the resource didn't exist"}},"tags":["Plugins"]},"get":{"operationId":"fetch-plugin-for-consumer","summary":"Get a Plugin associated with a Consumer","description":"Get a Plugin associated with a Consumer using ID.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/plugin-response"},"404":{"description":"Resource does not exist"}},"tags":["Plugins"]},"put":{"operationId":"upsert-plugin-for-consumer","summary":"Upsert a Plugin associated with a Consumer","description":"Create or Update a Plugin associated with a Consumer using ID.","requestBody":{"$ref":"#/components/requestBodies/plugin-request"},"responses":{"200":{"$ref":"#/components/responses/plugin-response"}},"tags":["Plugins"]},"parameters":[{"$ref":"#/components/parameters/consumer_id"},{"$ref":"#/components/parameters/plugin_id_or_instance_name"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/key-sets":{"get":{"operationId":"list-key-sets","summary":"List all Key-sets","description":"Retrieve a list of all Key-sets in the system. A Key Set object holds a collection of asymmetric key objects. This entity allows to logically group keys by their purpose. Key Sets can be both tagged and filtered by tags.\n","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/key-set-response"}},"tags":["Key-sets"]},"post":{"operationId":"create-key-set","summary":"Create a new Key-set","description":"This endpoint allows creating a new Key-set by sending a JSON object that describes the Key-set to be created.The request body must contain all the fields required to create a new Key-set. ","requestBody":{"$ref":"#/components/requestBodies/key-set-request"},"responses":{"200":{"$ref":"#/components/responses/key-set-response"},"400":{"description":" Returned if the request contains invalid data."}},"tags":["Key-sets"]},"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/key-sets/{key-set_id_or_name}":{"delete":{"operationId":"delete-key-set","summary":"Delete a Key-set","description":"Delete a Key-set.","responses":{"204":{"description":"Successfully deleted Key-set or the resource didn't exist"}},"tags":["Key-sets"]},"get":{"operationId":"get-key-set","summary":"Get a Key-set","description":"This endpoint retrieves information about a specific key-set based on its ID or name.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/key-set-response"},"404":{"description":"Resource does not exist"}},"tags":["Key-sets"]},"put":{"operationId":"upsert-key-set","summary":"Update a Key-set","description":"Update a Key-set using ID or name.","requestBody":{"$ref":"#/components/requestBodies/key-set-request"},"responses":{"200":{"$ref":"#/components/responses/key-set-response"},"400":{"description":"Invalid Key-set","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Key-sets"]},"parameters":[{"$ref":"#/components/parameters/key-set_id_or_name"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/keys":{"get":{"operationId":"list-keys","summary":"List all Keys","description":"List all Keys","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"A successful response listing Keys","content":{"application/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Key"}},"offset":{"$ref":"#/components/schemas/pagination-offset-response"}}}}}}},"tags":["Keys"]},"post":{"operationId":"create-key","summary":"Create a new Key","description":"This API endpoint allows you to create a new key. When the request is successful, the API will respond with a 200 status code and a JSON object that represents the newly created key. If the request is invalid, the API will respond with a `400` status code and an error message in the response body.","requestBody":{"$ref":"#/components/requestBodies/keys-request"},"responses":{"200":{"description":"Successfully created Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Key"}}}},"400":{"description":"Invalid Key","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Keys"]},"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/keys/{key_id_or_name}":{"delete":{"operationId":"delete-key","summary":"Delete a Key","description":"Delete a Key","responses":{"204":{"description":"Successfully deleted Key or the resource didn't exist"}},"tags":["Keys"]},"get":{"operationId":"get-key","summary":"Get a Key","description":"Get a Key using ID or name.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"Successfully fetched Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Key"},"examples":{"example":{"value":{"id":"d958f66b-8e99-44d2-b0b4-edd5bbf24658","jwk":"{alg:RSA,  kid: 42,  ...}","kid":"42","name":"a-key","pem":{"private_key":"-----BEGIN","public_key":"-----BEGIN"},"set":{"id":"b86b331c-dcd0-4b3e-97ce-47c5a9543031"}}}}}}},"404":{"description":"Resource does not exist"}},"tags":["Keys"]},"put":{"operationId":"upsert-key","summary":"Upsert a Key","description":"Create or Update Key using ID or name.","requestBody":{"$ref":"#/components/requestBodies/keys-request"},"responses":{"200":{"description":"Successfully upserted Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Key"},"examples":{"Example":{"value":{"id":"d958f66b-8e99-44d2-b0b4-edd5bbf24658","jwk":"{alg:RSA,  kid: 42,  ...}","kid":"42","name":"a-key","pem":{"private_key":"-----BEGIN","public_key":"-----BEGIN"},"set":{"id":"b86b331c-dcd0-4b3e-97ce-47c5a9543031"}}}}}}},"400":{"description":"Invalid Key","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Keys"]},"parameters":[{"$ref":"#/components/parameters/key_id_or_name"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/plugins":{"get":{"operationId":"list-plugins","summary":"List all Plugins","description":"This endpoint allows you to list all the plugins. You can use query parameters to filter the results by size or tags, for example `/plugins?size=50&tags=enterprise`.","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/plugin-response"}},"tags":["Plugins"]},"post":{"operationId":"create-plugin","summary":"Create a new Plugin","description":"Create a new Plugin.","requestBody":{"$ref":"#/components/requestBodies/plugin-request"},"responses":{"200":{"description":"Successfully created Plugin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plugin"},"examples":{"example":{"value":{"config":{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":["apikey"],"run_on_preflight":true},"enabled":true,"id":"3fd1eea1-885a-4011-b986-289943ff8177","name":"key-auth","protocols":["grpc","grpcs","http","https"]}}}}}},"400":{"description":"Invalid Plugin","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Plugins"]},"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/plugins/{plugin_id_or_instance_name}":{"delete":{"operationId":"delete-plugin","summary":"Delete a Plugin","description":"Delete a Plugin","responses":{"204":{"description":"Successfully deleted Plugin or the resource didn't exist"}},"tags":["Plugins"]},"get":{"operationId":"get-plugin","summary":"Get a Plugin","description":"Get a Plugin using ID.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"Successfully fetched Plugin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plugin"}}}},"404":{"description":"Resource does not exist"}},"tags":["Plugins"]},"put":{"operationId":"upsert-plugin","summary":"Upsert a Plugin","description":"Create or Update Plugin using ID.","requestBody":{"$ref":"#/components/requestBodies/plugin-request"},"responses":{"200":{"description":"Successfully upserted Plugin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plugin"},"examples":{"example":{"value":{"config":{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":["apikey"],"run_on_preflight":true},"enabled":true,"id":"3fd1eea1-885a-4011-b986-289943ff8177","name":"key-auth","protocols":["grpc","grpcs","http","https"]}}}}}},"400":{"description":"Invalid Plugin","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Plugins"]},"parameters":[{"$ref":"#/components/parameters/plugin_id_or_instance_name"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/routes":{"get":{"operationId":"list-routes","summary":"List all routes","description":"List all routes\n\nroute entities define rules to match client requests. Each route is associated with a service, and a service may have multiple routes associated to it. Every request matching a given route will be proxied to its associated service.\n\n> Note: Path handling algorithms v1 was deprecated in Kong 3.0. From Kong 3.0, when router_flavor is set to expressions, route.path_handling will be unconfigurable and the path handling behavior will be v0; when router_flavor is set to traditional_compatible, the path handling behavior will be v0 regardless of the value of route.path_handling. Only router_flavor = traditional will support path_handling v1' behavior.","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"A successful response listing routes","content":{"application/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Route"}},"offset":{"$ref":"#/components/schemas/pagination-offset-response"}}}}}}},"tags":["Routes"]},"post":{"operationId":"create-route","summary":"Create a new route","description":"Create a new route","requestBody":{"$ref":"#/components/requestBodies/route-request"},"responses":{"200":{"description":"Successfully created route","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Route"}}}},"400":{"description":"Invalid route","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Routes"]},"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/routes/{route_id}":{"delete":{"operationId":"delete-route","summary":"Delete a route","description":"Delete a route.","responses":{"204":{"description":"Successfully deleted route or the resource didn't exist"}},"tags":["Routes"]},"get":{"operationId":"get-route","summary":"Get a route","description":"Get a route using ID or name.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"Successfully fetched route","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Route"}}}},"404":{"description":"Resource does not exist"}},"tags":["Routes"]},"put":{"operationId":"upsert-route","summary":"Update a route","description":"Create or Update route using ID or name.","requestBody":{"$ref":"#/components/requestBodies/route-request"},"responses":{"200":{"description":"Successfully upserted route","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Route"}}}},"400":{"description":"Invalid route","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Routes"]},"parameters":[{"name":"runtimeGroupId","in":"path","description":"The ID of your runtime group. This variable is available in the Konnect manager","required":true,"schema":{"type":"string","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"}},{"name":"route_id","in":"path","required":true,"schema":{"type":"string"}}]},"/runtime-groups/{runtimeGroupId}/core-entities/routes/{route_id}/plugins":{"get":{"operationId":"list-plugins-for-route","summary":"List all Plugins associated with a route","description":"List all Plugins associated with a a route","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"A successful response listing Plugins","content":{"application/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Plugin"}},"offset":{"$ref":"#/components/schemas/pagination-offset-response"}}}}}}},"tags":["Plugins"]},"post":{"operationId":"create-plugin-for-route","summary":"Create a new Plugin associated with a route","description":"Create a new Plugin associated with a route","requestBody":{"$ref":"#/components/requestBodies/plugin-request"},"responses":{"200":{"$ref":"#/components/responses/plugin-response"},"400":{"description":"Invalid Plugin","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Plugins"]},"parameters":[{"$ref":"#/components/parameters/route_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/routes/{route_id}/plugins/{plugin_id_or_instance_name}":{"delete":{"operationId":"delete-plugin-for-route","summary":"Delete a a Plugin associated with a route","description":"Delete a a Plugin associated with a a route using ID.","responses":{"204":{"description":"Successfully deleted Plugin or the resource didn't exist"}},"tags":["Plugins"]},"get":{"operationId":"fetch-plugin-for-route","summary":"Get a Plugin associated with a route","description":"Get a Plugin associated with a route using ID.","parameters":[{"name":"route_id","in":"path","description":"ID or name of the related route","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/plugin-response"},"404":{"description":"Resource does not exist"}},"tags":["Plugins"]},"put":{"operationId":"upsert-plugin-for-route","summary":"Upsert a Plugin associated with a route","description":"Create or Update a Plugin associated with a route using ID.","requestBody":{"$ref":"#/components/requestBodies/plugin-request"},"responses":{"200":{"$ref":"#/components/responses/plugin-response"},"400":{"description":"Invalid Plugin","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Plugins"]},"parameters":[{"$ref":"#/components/parameters/route_id"},{"$ref":"#/components/parameters/plugin_id_or_instance_name"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/services":{"get":{"operationId":"list-services","summary":"List all services","description":"List all services","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/service-response"}},"tags":["Services"]},"post":{"operationId":"create-service","summary":"Create a new service","description":"Create a new service","requestBody":{"$ref":"#/components/requestBodies/service-request"},"responses":{"201":{"description":"Successfully created service","content":{"application/json":{"schema":{"type":"object","properties":{"connect_timeout":{"type":"integer"},"created_at":{"type":"integer"},"enabled":{"type":"boolean"},"host":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"port":{"type":"integer"},"protocol":{"type":"string"},"read_timeout":{"type":"integer"},"retries":{"type":"integer"},"updated_at":{"type":"integer"},"write_timeout":{"type":"integer"}},"x-examples":{"Example 1":{"connect_timeout":6000,"created_at":1684437851,"enabled":true,"host":"example.com","id":"ebf4e826-b17a-4e23-9d58-2621c9faa135","name":"my-service","path":"/some_api","port":80,"protocol":"http","read_timeout":6000,"retries":5,"updated_at":1684437851,"write_timeout":6000}}},"examples":{"http service creation":{"value":{"connect_timeout":6000,"created_at":1684437851,"enabled":true,"host":"example.com","id":"ebf4e826-b17a-4e23-9d58-2621c9faa135","name":"my-service","path":"/some_api","port":80,"protocol":"http","read_timeout":6000,"retries":5,"updated_at":1684437851,"write_timeout":6000}}}}}},"400":{"description":"Invalid service","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Services"]},"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/services/{service_id}":{"delete":{"operationId":"delete-service","summary":"Delete a service","description":"Delete a service","parameters":[{"name":"service_id","in":"path","description":"ID or name of the service to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successfully deleted service or the resource didn't exist"}},"tags":["Services"]},"get":{"operationId":"get-service","summary":"Get a service","description":"Get a service using ID or name.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/service-response"},"404":{"description":"Resource does not exist"}},"tags":["Services"]},"put":{"operationId":"upsert-service","summary":"Upsert a service","description":"Create or Update service using ID or name.","requestBody":{"$ref":"#/components/requestBodies/service-request"},"responses":{"200":{"$ref":"#/components/responses/service-response"},"400":{"description":"Invalid service","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Services"]},"parameters":[{"$ref":"#/components/parameters/service_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/services/{service_id}/plugins":{"get":{"operationId":"get-plugins-for-service","summary":"List all Plugins associated with a service","description":"List all Plugins associated with a a service","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"A successful response listing Plugins","content":{"application/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Plugin"}},"offset":{"$ref":"#/components/schemas/pagination-offset-response"}}}}}}},"tags":["Plugins"]},"post":{"operationId":"create-plugin-for-service","summary":"Create a new Plugin associated with a service","description":"Create a new Plugin associated with a service","requestBody":{"$ref":"#/components/requestBodies/plugin-request"},"responses":{"200":{"description":"Successfully created Plugin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plugin"}}}},"400":{"description":"Invalid Plugin","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Plugins"]},"parameters":[{"$ref":"#/components/parameters/service_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/services/{service_id}/plugins/{plugin_id_or_instance_name}":{"delete":{"operationId":"delete-plugin-for-a-service","summary":"Delete a a plugin associated with a service","description":"Delete a a Plugin associated with a a service using ID.","responses":{"204":{"description":"Successfully deleted Plugin or the resource didn't exist"}},"tags":["Plugins"]},"get":{"operationId":"fetch-plugin-with-a-service","summary":"Get a Plugin associated with a service","description":"Get a Plugin associated with a service using ID.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"Successfully fetched Plugin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plugin"}}}},"404":{"description":"Resource does not exist"}},"tags":["Plugins"]},"put":{"operationId":"upsert-plugin-for-a-service","summary":"Upsert a plugin associated with a service","description":"Create or Update a Plugin associated with a service using ID.","requestBody":{"$ref":"#/components/requestBodies/plugin-request"},"responses":{"201":{"$ref":"#/components/responses/plugin-response"},"400":{"description":"Invalid Plugin","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Plugins"]},"parameters":[{"$ref":"#/components/parameters/service_id"},{"$ref":"#/components/parameters/plugin_id_or_instance_name"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/services/{service_id}/routes":{"get":{"operationId":"list-routes-for-service","summary":"List all routes associated with a service","description":"List all routes associated with a a service","parameters":[{"name":"service_id","in":"path","description":"ID or name of the related service","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"A successful response listing routes","content":{"application/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Route"}},"offset":{"$ref":"#/components/schemas/pagination-offset-response"}}},"examples":{"Example 1":{"value":{"data":[{"hosts":["foo.example.com","foo.example.us"],"id":"56c4566c-14cc-4132-9011-4139fcbbe50a","name":"example-route","paths":["/v1","/v2"],"service":{"id":"bd380f99-659d-415e-b0e7-72ea05df3218"}}],"offset":"string"}}}}}}},"tags":["Routes"]},"post":{"operationId":"create-route-for-service","summary":"Create a new route associated with a service","description":"Create a new route associated with a service","parameters":[{"name":"service_id","in":"path","description":"ID or name of the related service","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/route-request"},"responses":{"201":{"description":"Successfully created route","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Route"},"examples":{"Created route":{"value":{"created_at":1684438957,"headers":{"x-another-header":["bla"],"x-my-header":["foo","bar"]},"hosts":["example.com","foo.test"],"https_redirect_status_code":426,"id":"40dac76a-ce79-4bca-844d-afb44b9d8784","methods":["GET","POST"],"name":"my-route","path_handling":"v0","paths":["/foo","/bar"],"preserve_host":false,"protocols":["http","https"],"regex_priority":0,"request_buffering":true,"response_buffering":true,"service":{"id":"b073426b-1087-42e5-85d9-a2bf9fe0a09d"},"strip_path":true,"tags":["user-level","low-priority"],"updated_at":1684438957}}}}}},"400":{"description":"Invalid route","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Routes"]},"parameters":[{"$ref":"#/components/parameters/service_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/services/{service_id}/routes/{route_id}":{"delete":{"operationId":"delete-route-for-service","summary":"Delete a a route associated with a service","description":"Delete a a route associated with a a service using ID or name.","responses":{"204":{"description":"Successfully deleted route or the resource didn't exist"}},"tags":["Routes"]},"get":{"operationId":"fetch-route-for-service","summary":"Get a route associated with a service","description":"Get a route associated with a service using ID or name.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"Successfully fetched route","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Route"},"examples":{"Example 1":{"value":{"hosts":["foo.example.com","foo.example.us"],"id":"56c4566c-14cc-4132-9011-4139fcbbe50a","name":"example-route","paths":["/v1","/v2"],"service":{"id":"bd380f99-659d-415e-b0e7-72ea05df3218"}}}}}}},"404":{"description":"Resource does not exist"}},"tags":["Routes"]},"put":{"operationId":"upsert-route-for-service","summary":"Upsert a route associated with a service","description":"Create or Update a route associated with a service using ID or name.","requestBody":{"$ref":"#/components/requestBodies/route-request"},"responses":{"200":{"description":"Successfully upserted route","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Route"},"examples":{"Example 1":{"value":{"hosts":["foo.example.com","foo.example.us"],"id":"56c4566c-14cc-4132-9011-4139fcbbe50a","name":"example-route","paths":["/v1","/v2"],"service":{"id":"bd380f99-659d-415e-b0e7-72ea05df3218"}}}}}}},"400":{"description":"Invalid route","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Routes"]},"parameters":[{"$ref":"#/components/parameters/service_id"},{"$ref":"#/components/parameters/route_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/snis":{"get":{"operationId":"list-snis","summary":"List all SNIs","description":"List all SNIs","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/sni-response"}},"tags":["SNIs"]},"post":{"operationId":"create-sni","summary":"Create a new SNI","description":"Create a new SNI","requestBody":{"$ref":"#/components/requestBodies/create-sni"},"responses":{"200":{"$ref":"#/components/responses/sni-response"},"400":{"description":"Invalid SNI","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["SNIs"]},"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/snis/{sni_id}":{"delete":{"operationId":"delete-sni","summary":"Delete an SNI","description":"Delete an SNI","responses":{"204":{"description":"Successfully deleted SNI or the resource didn't exist"}},"tags":["SNIs"]},"get":{"operationId":"get-sni","summary":"Get an SNI","description":"Get an SNI using ID or name.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/sni-response"},"404":{"description":"Resource does not exist"}},"tags":["SNIs"]},"put":{"operationId":"upsert-sni","summary":"Update an SNI","description":"Create or Update SNI using ID or name.","requestBody":{"$ref":"#/components/requestBodies/create-sni"},"responses":{"200":{"$ref":"#/components/responses/sni-response"},"400":{"description":"Invalid SNI","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["SNIs"]},"parameters":[{"$ref":"#/components/parameters/sni_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/upstreams":{"get":{"operationId":"list-upstreams","summary":"List all Upstreams","description":"List all registered upstreams. You can filter the results by pagination size, offset, or tags like `/upstreams?size=10&offset=0`.\n","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"A successful response listing Upstreams","content":{"application/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Upstream"}},"offset":{"$ref":"#/components/schemas/pagination-offset-response"}}},"examples":{"example":{"value":{"data":[{"algorithm":"round-robin","hash_fallback":"none","hash_on":"none","hash_on_cookie_path":"/","healthchecks":{"active":{"concurrency":10,"healthy":{"http_statuses":[200,302],"interval":0,"successes":0},"http_path":"/","https_verify_certificate":true,"timeout":1,"type":"http","unhealthy":{"http_failures":0,"http_statuses":[429,404,500,501,502,503,504,505],"interval":0,"tcp_failures":0,"timeouts":0}},"passive":{"healthy":{"http_statuses":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],"successes":0},"type":"http","unhealthy":{"http_failures":0,"http_statuses":[429,500,503],"tcp_failures":0,"timeouts":0}},"threshold":0},"id":"6eed5e9c-5398-4026-9a4c-d48f18a2431e","name":"api.example.internal","slots":10000}],"offset":"string"}}}}}}},"tags":["Upstreams"]},"post":{"operationId":"create-upstream","summary":"Create a new Upstream","description":"Create a new Upstream\n","requestBody":{"$ref":"#/components/requestBodies/upstream-request"},"responses":{"200":{"description":"Successfully created Upstream","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upstream"}}}},"400":{"description":"Invalid Upstream","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Upstreams"]},"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/upstreams/{upstream_id}":{"delete":{"operationId":"delete-upstream","summary":"Delete an Upstream","description":"Delete an Upstream","responses":{"204":{"description":"Successfully deleted Upstream or the resource didn't exist"}},"tags":["Upstreams"]},"get":{"operationId":"get-upstream","summary":"Get an Upstream","description":"Get an Upstream using ID or name.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"Successfully fetched Upstream","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upstream"}}}},"404":{"description":"Resource does not exist"}},"tags":["Upstreams"]},"put":{"operationId":"upsert-upstream","summary":"Update an Upstream","description":"Create or Update Upstream using ID or name.","requestBody":{"$ref":"#/components/requestBodies/upstream-request"},"responses":{"201":{"description":"Successfully upserted Upstream","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upstream"},"examples":{"Example 1":{"value":{"id":"58c8ccbb-eafb-4566-991f-2ed4f678fa70","created_at":1422386534,"name":"my-upstream","algorithm":"round-robin","hash_on":"none","hash_fallback":"none","hash_on_cookie_path":"/","slots":10000,"healthchecks":{"passive":{"type":"http","healthy":{"http_statuses":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],"successes":0},"unhealthy":{"http_statuses":[429,500,503],"timeouts":0,"http_failures":0,"tcp_failures":0}},"active":{"https_verify_certificate":true,"healthy":{"http_statuses":[200,302],"successes":0,"interval":0},"unhealthy":{"http_failures":0,"http_statuses":[429,404,500,501,502,503,504,505],"timeouts":0,"tcp_failures":0,"interval":0},"type":"http","concurrency":10,"headers":{"type":"object","properties":{"x-my-header":{"description":"The value(s) of the x-my-header header.","type":"array","items":{"type":"string"}},"x-another-header":{"description":"The value(s) of the x-another-header header.","type":"array","items":{"type":"string"}}}},"timeout":1,"http_path":"/","https_sni":"example.com"},"threshold":0},"tags":["user-level","low-priority"],"host_header":"example.com","client_certificate":{"id":"ea29aaa3-3b2d-488c-b90c-56df8e0dd8c6"},"use_srv_name":false}}}}}},"400":{"description":"Invalid Upstream","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Upstreams"]},"parameters":[{"$ref":"#/components/parameters/upstream_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/upstreams/{upstream_id}/targets":{"get":{"operationId":"list-targets-for-upstream","summary":"List all Targets associated with an Upstream","description":"List all Targets associated with a an Upstream","parameters":[{"name":"upstream_id","in":"path","description":"ID or name of the related Upstream","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"A successful response listing Targets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Target"}}}}},"tags":["Targets"]},"post":{"operationId":"create-target-for-upstream","summary":"Create a new Target associated with an Upstream","description":"Create a new Target associated with an Upstream","parameters":[{"name":"upstream_id","in":"path","description":"ID or name of the related Upstream","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/target-request"},"responses":{"200":{"description":"Successfully created Target","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Target"},"examples":{"Successfully created Target":{"value":{"id":"173a6cee-90d1-40a7-89cf-0329eca780a6","created_at":1422386534,"upstream":{"id":"bdab0e47-4e37-4f0b-8fd0-87d95cc4addc"},"target":"example.com:8000","weight":100,"tags":["user-level","low-priority"]}}}}}},"400":{"description":"Invalid Target","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Targets"]},"parameters":[{"$ref":"#/components/parameters/upstream_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/upstreams/{upstream_id}/targets/{target_id}":{"delete":{"operationId":"delete-upstream-target","summary":"Delete a a Target associated with a an Upstream","description":"Delete a a Target associated with a an Upstream using ID or target.","responses":{"204":{"description":"Successfully deleted Target or the resource didn't exist"}},"tags":["Targets"]},"get":{"operationId":"fetch-target-for-upstream","summary":"Get a Target associated with an Upstream","description":"Get a Target associated with an Upstream using ID or target.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"Successfully fetched Target","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Target"}}}},"404":{"description":"Resource does not exist"}},"tags":["Targets"]},"put":{"operationId":"upsert-target-for-upstream","summary":"Upsert a Target associated with an Upstream","description":"Create or Update a Target associated with an Upstream using ID or target.","requestBody":{"$ref":"#/components/requestBodies/target-request"},"responses":{"200":{"description":"Successfully upserted Target","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Target"}}}},"400":{"description":"Invalid Target","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Targets"]},"parameters":[{"$ref":"#/components/parameters/upstream_id"},{"$ref":"#/components/parameters/target_id"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/vaults":{"get":{"operationId":"list-vaults","summary":"List all Vaults","description":"List all Vaults","parameters":[{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"A successful response listing Vaults","content":{"application/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Vault"}},"offset":{"$ref":"#/components/schemas/pagination-offset-response"}}}}}}},"tags":["Vaults"]},"post":{"operationId":"create-vault","summary":"Create a new Vault","description":"Create a new Vault","requestBody":{"$ref":"#/components/requestBodies/vault-request"},"responses":{"200":{"description":"Successfully created Vault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vault"}}}},"400":{"description":"Invalid Vault","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Vaults"]},"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/vaults/{vault_id_or_prefix}":{"delete":{"operationId":"delete-vault","summary":"Delete a Vault","description":"Delete a Vault","parameters":[{"name":"vault_id_or_prefix","in":"path","description":"ID or prefix of the Vault to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successfully deleted Vault or the resource didn't exist"}},"tags":["Vaults"]},"get":{"operationId":"get-vault","summary":"Get a Vault","description":"Get a Vault using ID or prefix.\n\nVault entities are used to configure different Vault connectors.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"Successfully fetched Vault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vault"}}}},"404":{"description":"Resource does not exist"}},"tags":["Vaults"]},"put":{"operationId":"upsert-vault","summary":"Upsert a Vault","description":"Create or Update Vault using ID or prefix.","parameters":[{"name":"vault_id_or_prefix","in":"path","description":"Name or ID of the Vault to lookup","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/vault-request"},"responses":{"200":{"description":"Successfully upserted Vault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vault"}}}},"400":{"description":"Invalid Vault","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Vaults"]},"parameters":[{"$ref":"#/components/parameters/vault_id_or_prefix"},{"$ref":"#/components/parameters/runtimeGroupId"}]},"/runtime-groups/{runtimeGroupId}/core-entities/schemas/plugins/{plugin_name}":{"parameters":[{"name":"plugin_name","in":"path","description":"The name of a Kong plugin","required":true,"schema":{"type":"string","example":"basic-auth"}},{"$ref":"#/components/parameters/runtimeGroupId"}],"get":{"operationId":"get-schemas-plugins-plugin_name","summary":"Get a Plugin Schema","description":"Retrieve the schema of a plugin’s configuration. This is useful to understand what fields a plugin accepts, and can be used for building third-party integrations to the Kong’s plugin system.\n","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"OK"}},"tags":["Information"]}},"/runtime-groups/{runtimeGroupId}/core-entities/debug/cluster/control-planes-nodes/log-level/{log_level}":{"parameters":[{"name":"log_level","in":"path","description":"Log levels are set in Kong’s configuration. Log levels increase in order of their severity","required":true,"schema":{"type":"string","example":"warn","enum":["info","notice","warn","error","crit"]}},{"name":"runtimeGroupId","in":"path","required":true,"schema":{"type":"string"}}],"put":{"operationId":"put-debug-cluster-control-planes-nodes-log-level-log_level","summary":"Set Node Log Level of All Control Plane Nodes","description":"Change the log level of all Control Plane nodes deployed in Hybrid (CP/DP) cluster.\n\nSee the [NGINX docs](http://nginx.org/en/docs/ngx_core_module.html#error_log) for a list of accepted values.\n\nCare must be taken when changing the log level of a node to `debug` in a production environment because the disk could fill up quickly. As soon as the debug logging finishes, revert back to a higher level such as notice.\n\nIt’s currently not possible to change the log level of DP and DB-less nodes.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"Response message","type":"string","example":"log level changed"}},"x-examples":{"Example 1":{"message":"log level changed"}}},"examples":{"log level changed":{"value":{"message":"log level changed"}}}}}}},"tags":["Debug"]}},"/runtime-groups/{runtimeGroupId}/core-entities/debug/cluster/log-level/{log_level}":{"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"},{"$ref":"#/components/parameters/log_level"}],"put":{"operationId":"put-debug-cluster-log-level-log_level","summary":"Set Node Log Level of All Nodes","description":"Change the log level of all nodes in a cluster.\n\n\n\nSee the [NGINX docs](http://nginx.org/en/docs/ngx_core_module.html#error_log) for a list of accepted values.\n\nIt’s currently not possible to change the log level of DP and DB-less nodes.\n\nCurrently, when a user dynamically changes the log level for the entire cluster, if a new node joins a cluster the new node will run at the previous log level, not at the log level that was previously set dynamically for the entire cluster.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message containing information about the log level","type":"string","example":"log level changed"}},"x-examples":{"Example 1":{"message":"log level changed"}}},"examples":{"log level changed":{"value":{"message":"log level changed"}}}}}}},"tags":["Debug"]}},"/runtime-groups/{runtimeGroupId}/core-entities/debug/node/log-level":{"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}],"get":{"operationId":"get-debug-node-log-level","summary":"Get a Node Log Level of A Node","description":"Retrieve the current log level of a node.\n\nSee the [NGINX documentation](http://nginx.org/en/docs/ngx_core_module.html#error_log) for the list of possible return values.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message containing the current log level of the node.","type":"string","example":"log level: debug"}},"x-examples":{"Example 1":{"message":"log level: debug"}}},"examples":{"Example 1":{"value":{"message":"log level: debug"}}}}}}},"tags":["Debug"]}},"/runtime-groups/{runtimeGroupId}/core-entities/debug/node/log-level/{log_level}":{"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"},{"$ref":"#/components/parameters/log_level"}],"put":{"operationId":"put-debug-node-log-level-log_level","summary":"Set log level of a single node","description":"Change the log level of a node.\n\nSee the [NGINX documentation](http://nginx.org/en/docs/ngx_core_module.html#error_log) for the list of possible return values.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message confirming the log level change","type":"string","example":"log level changed"}},"x-examples":{"Example 1":{"message":"log level changed"}}},"examples":{"log level changed":{"value":{"message":"log level changed"}}}}}}},"tags":["Debug"]}},"/runtime-groups/{runtimeGroupId}/core-entities/consumer_groups":{"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"}],"get":{"operationId":"get-runtimeGroupId-core-entities-consumer_groups","summary":"List consumer groups","description":"Returns a list of active consumer groups.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/consumer-groups-response"}},"tags":["consumer-groups"]},"post":{"operationId":"post-runtimeGroupId-core-entities-consumer_groups","summary":"Create a consumer group","description":"Create a consumer group by passing a name and optional tags in the request body.","requestBody":{"$ref":"#/components/requestBodies/consumer-groups-request"},"responses":{"200":{"$ref":"#/components/responses/consumer-groups-response"}},"tags":["consumer-groups"]},"delete":{"operationId":"delete-consumer_groups-group_name_or_id","summary":"Delete a consumer group","description":"Delete a consumer group. Deleting a consumer group removes all consumers from that group. This operation does not delete existing consuemrs.\n","responses":{"204":{"description":"HTTP/1.1 204 No Content\n"}},"tags":["consumer-groups"]}},"/runtime-groups/{runtimeGroupId}/core-entities/consumer_groups/{group_id}":{"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"},{"$ref":"#/components/parameters/group_id"}],"get":{"operationId":"get-runtimeGroupId-core-entities-consumer_groups-consumer_id","summary":"List a specific consumer group","description":"Return information about a specific consumer group by passing the `group_id` as a path parameter.","parameters":[{"$ref":"#/components/parameters/pagination-offset"},{"$ref":"#/components/parameters/pagination-size"},{"$ref":"#/components/parameters/pagination-tags-filter"}],"responses":{"200":{"$ref":"#/components/responses/consumer-groups-response"}},"tags":["consumer-groups"]},"put":{"operationId":"put-runtimeGroupId-core-entities-consumer_groups-group_id","summary":"Create a consumer group","description":"Create a consumer group.","requestBody":{"$ref":"#/components/requestBodies/consumer-request"},"responses":{"200":{"$ref":"#/components/responses/consumer-response-data"}},"tags":["consumer-groups"]},"delete":{"operationId":"delete-runtimeGroupId-core-entities-consumer_groups-group_id","summary":"Delete consumer group","description":"Delete consumer group.","responses":{"204":{"description":"No Content"}},"tags":["consumer-groups"]}},"/runtime-groups/{runtimeGroupId}/core-entities/consumer_groups/{group_id}/consumers":{"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"},{"$ref":"#/components/parameters/group_id"}],"get":{"operationId":"get-runtimeGroupId-core-entities-consumer_groups-group_id-consumers","summary":"List all consumers in a consumer group","description":"Returns a list of consumers that belong to a consumer group.","responses":{"200":{"$ref":"#/components/responses/consumer-groups-response"}},"tags":["consumer-groups"]},"post":{"operationId":"post-runtimeGroupId-core-entities-consumer_groups-group_id-consumers","summary":"Add a consumer to a group","description":"Add a consumer to a group","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"consumer":{"description":"The consumer ID for the consumer that you want to add to a group.","type":"string","example":"288f2bfc-04e2-4ec3-b6f3-40408dff5417"}}}}}},"responses":{"201":{"$ref":"#/components/responses/return-consumer-group"}},"tags":["consumer-groups"]},"delete":{"operationId":"delete-runtimeGroupId-core-entities-consumer_groups-group_id-consumers","summary":"Remove all consumers from a consumer group","description":"Removes all consumers from a consumer group. Does not delete any consumers.consumers.","responses":{"204":{"description":"No Content"}},"tags":["consumer-groups"]}},"/runtime-groups/{runtimeGroupId}/core-entities/consumers/{consumer_id}/consumer_groups":{"parameters":[{"$ref":"#/components/parameters/runtimeGroupId"},{"$ref":"#/components/parameters/consumer_id"}],"get":{"operationId":"get-runtimeGroupId-core-entities-consumer_id-consumer_groups","summary":"List consumer groups for a consumer","description":"View all consumer groups that a consumer is assigned to.\n","responses":{"200":{"$ref":"#/components/responses/consumer-groups-response"}},"tags":["consumer-groups"]},"post":{"operationId":"post-runtimeGroupId-core-entities-consumers-consumer_id-consumer_groups","summary":"Add a consumer to a group","description":"Add a consumer to a specific consumer group.\n\nIf you add a consumer to multiple groups:\n\nIf all groups are allowed by the Rate Limiting Advanced plugin, only the first group’s settings will apply.\nOtherwise, whichever group is specified in the Rate Limiting Advanced plugin will be active.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"group":{"description":"The consumer group UUID.","type":"string","example":"1e965e47-d185-4e9e-8bc7-94ea6ae75b2e"}}}}}},"responses":{"200":{"$ref":"#/components/responses/consumer-groups-response"}},"tags":["consumer-groups"]},"delete":{"operationId":"delete-runtimeGroupId-core-entities-consumers-consumer_id-consumer_groups","summary":"Remove a consumer from all groups","description":"Remove a consumer from all groups","responses":{"204":{"description":"No Content"}},"tags":["consumer-groups"]}}},"components":{"parameters":{"ca_certificate_id":{"name":"ca_certificate_id","description":"ID of the related certificate","in":"path","required":true,"schema":{"type":"string","example":"7fca84d6-7d37-4a74-a7b0-93e576089a41"}},"certificate_id":{"name":"certificate_id","in":"path","required":true,"schema":{"type":"string","example":"7fca84d6-7d37-4a74-a7b0-93e576089a41"},"description":"The unique identifier of the Certificate to retrieve."},"certificate_name_or_id":{"name":"certificate_name_or_id","in":"path","required":true,"schema":{"type":"string","example":"name","enum":["a3ad71a8-6685-4b03-a101-980a953544f6","name"]},"description":"The unique identifier or the `name` attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed."},"consumer_id":{"name":"consumer_id","in":"path","schema":{"type":"string","example":"e94215b0-9198-42ce-bf0b-98afff31b2a7"},"description":"The unique identifier or the username of the Consumer to retrieve.","required":true},"group_id":{"name":"group_id","in":"path","required":true,"schema":{"type":"string","example":"be4bcfca-b1df-4fac-83cc-5cf6774bf48e"},"description":"The UUID of the consumer group."},"key-set_id_or_name":{"name":"key-set_id_or_name","in":"path","required":true,"schema":{"type":"string","example":"46CA83EE-671C-11ED-BFAB-2FE47512C77A"},"description":"The unique identifier or the `name` attribute of the Key Set that should be associated to the newly-created Key."},"key_id_or_name":{"name":"key_id_or_name","in":"path","required":true,"schema":{"type":"string","example":"24D0DBDA-671C-11ED-BA0B-EF1DCCD3725"},"description":"The unique identifier or the name of the Key to retrieve."},"log_level":{"name":"log_level","in":"path","required":true,"schema":{"type":"string","example":"warn","enum":["info","notice","warn","error","crit"]},"description":"Log levels are set in Kong’s configuration. Log levels increase in order of their severity"},"page_number":{"name":"page_number","in":"query","required":false,"schema":{"type":"integer"},"description":"The specific page number in the collection results."},"page_size":{"name":"page_size","in":"query","required":false,"schema":{"type":"integer"},"description":"The number of items to include in a page."},"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"}},"PageBefore":{"name":"page[before]","description":"Request the next page of data, starting with the item before 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}},"pagination-offset":{"description":"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources","in":"query","name":"offset","schema":{"type":"string"}},"pagination-size":{"description":"Number of resources to be returned.","in":"query","name":"size","schema":{"type":"integer","default":100,"maximum":1000,"minimum":1}},"pagination-tags-filter":{"description":"A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.","example":"tag1,tag2","in":"query","name":"tags","schema":{"type":"string"}},"plugin_id_or_instance_name":{"name":"plugin_id_or_instance_name","in":"path","required":true,"schema":{"type":"string","example":"response-ratelimiting"},"description":"The unique identifier of the Plugin to create or update."},"route_id":{"name":"route_id","in":"path","required":true,"schema":{"type":"string","example":"e94215b0-9198-42ce-bf0b-98afff31b2a7"},"description":"The unique identifier or the name of the route to retrieve."},"runtimeGroupId":{"name":"runtimeGroupId","in":"path","required":true,"schema":{"type":"string","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"},"description":"The ID of your runtime group. This variable is available in the Konnect manager"},"service_id":{"name":"service_id","description":"ID **or** name of the service to lookup","example":"7fca84d6-7d37-4a74-a7b0-93e576089a41","in":"path","required":true,"schema":{"type":"string"}},"sni_id":{"name":"sni_id","in":"path","required":true,"schema":{"type":"string","example":"my-sni"},"description":"The unique identifier or the name of the SNI to retrieve."},"target_id":{"name":"target_id","in":"path","required":true,"schema":{"type":"string","example":"e94215b0-9198-42ce-bf0b-98afff31b2a7"},"description":"The `id` of an existing target entry."},"upstream_id":{"name":"upstream_id","in":"path","required":true,"schema":{"type":"string","example":"7fca84d6-7d37-4a74-a7b0-93e576089a41"},"description":"The unique identifier of the Upstream associated to the Certificate to be retrieved."},"vault_id_or_prefix":{"name":"vault_id_or_prefix","in":"path","required":true,"schema":{"type":"string","example":"env"},"description":"The unique identifier or the prefix of the Vault to retrieve."}},"schemas":{"CA-Certificate":{"description":"A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate. CA Certificates can be both tagged and filtered by tags.","type":"object","properties":{"cert":{"description":"PEM-encoded public certificate of the CA.","type":"string","example":"-----BEGIN CERTIFICATE-----..."},"cert_digest":{"description":"SHA256 hex digest of the public certificate.","type":"string","example":"c641e28d77e93544f2fa87b2cf3f3d51..."},"created_at":{"description":"Unix epoch when the resource was created.","type":"integer","example":1422386534},"updated_at":{"description":"Unix epoch when the resouce was updated.","type":"integer","example":1422386534},"id":{"type":"string","format":"uuid","example":"04fbeacf-a9f1-4a5d-ae4a-b0407445db3f"},"tags":{"description":"An optional set of strings associated with the Certificate for grouping and filtering.","type":"array","items":{"type":"string","example":"[user-level, low-priority]"}}},"example":{"cert":"-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","id":"b2f34145-0343-41a4-9602-4c69dec2f260"},"title":"CA-Certificate","x-examples":{"200 - list of multiple certificates":{"data":[{"id":"43429efd-b3a5-4048-94cb-5cc4029909bb","created_at":1422386534,"updated_at":1422386534,"cert":"-----BEGIN CERTIFICATE-----...","cert_digest":"c641e28d77e93544f2fa87b2cf3f3d51...","tags":["user-level","low-priority"]},{"id":"d26761d5-83a4-4f24-ac6c-cff276f2b79c","created_at":1422386534,"updated_at":1422386534,"cert":"-----BEGIN CERTIFICATE-----...","cert_digest":"c641e28d77e93544f2fa87b2cf3f3d51...","tags":["admin","high-priority","critical"]}],"next":"http://localhost:8001/ca_certificates?offset=6378122c-a0a1-438d-a5c6-efabae9fb969"}}},"Certificate":{"description":"A certificate object represents a public certificate. These fields are _referenceable_, and can be stored as [secrets](http://docs.konqhq.com/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","type":"object","properties":{"cert":{"description":"PEM-encoded public certificate chain of the SSL key This field is referenceable and can be stored in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","type":"string","example":"-----BEGIN CERTIFICATE-----\\ncertificate-content\\n-----END CERTIFICATE-----"},"cert_alt":{"description":"PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs.","type":"string","example":"-----BEGIN CERTIFICATE-----..."},"created_at":{"description":"Unix epoch when the resource was created.","type":"integer","example":1422386534},"updated_at":{"description":"Unix epoch when the resouce was updated.","type":"integer","example":1422386534},"id":{"description":"The UUID representation of the certificate object.","type":"string","format":"uuid","example":"7fca84d6-7d37-4a74-a7b0-93e576089a41"},"key":{"description":"PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","type":"string","example":" -----BEGIN RSA PRIVATE KEY-----..."},"key_alt":{"description":"PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","type":"string","example":"-----BEGIN EC PRIVATE KEY-----..."},"tags":{"description":"An optional set of strings associated with the Certificate for grouping and filtering.","type":"array","items":{"type":"string","example":"user-level"}}},"example":{"cert":"-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","id":"b2f34145-0343-41a4-9602-4c69dec2f269","key":"-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"},"title":"Certificate"},"Key":{"description":"A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.","type":"object","properties":{"created_at":{"description":"Unix epoch when the resource was created.","type":"integer","example":1422386534},"id":{"description":"The unique identifier or the prefix of the Vault to delete.","type":"string","example":"24D0DBDA-671C-11ED-BA0B-EF1DCCD3725F"},"jwk":{"description":"A JSON Web Key represented as a string.","type":"string","example":"{\\alg\\:\\RSA\\,  \\kid\\: \\42\\,  ...}"},"kid":{"description":"A unique identifier for a key.","type":"string","example":"42"},"updated_at":{"description":"Unix epoch when the resouce was updated.","type":"integer","example":1422386534},"pem":{"description":"A keypair in PEM format.","type":"object","properties":{"private_key":{"type":"string","example":"-----BEGIN"},"public_key":{"type":"string","example":"-----BEGIN"}}},"set":{"description":"The id (an UUID) of the key-set with which to associate the key.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","example":"46CA83EE-671C-11ED-BFAB-2FE47512C77A"}}},"tags":{"description":"An optional set of strings associated with the Key for grouping and filtering.","type":"array","items":{"type":"string"}}},"example":{"id":"d958f66b-8e99-44d2-b0b4-edd5bbf24658","jwk":"{alg:RSA,  kid: 42,  ...}","kid":"42","name":"a-key","pem":{"private_key":"-----BEGIN","public_key":"-----BEGIN"},"set":{"id":"b86b331c-dcd0-4b3e-97ce-47c5a9543031"}},"title":"Key"},"Plugin":{"description":"A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","type":"object","properties":{"config":{"description":"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","type":"object"},"consumer":{"description":"If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"}}},"created_at":{"description":"Unix epoch when the resource was created.","type":"integer"},"enabled":{"description":"Whether the plugin is applied.","type":"boolean","default":true},"id":{"type":"string"},"instance_name":{"type":"string"},"name":{"description":"The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.","type":"string"},"ordering":{"type":"object"},"protocols":{"description":"A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support `tcp` and `tls`.","type":"array","items":{"type":"string"},"default":["grpc","grpcs","http","https"]},"route":{"description":"If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"}}},"service":{"description":"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service. Leave unset for the plugin to activate regardless of the service being matched.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"}}},"tags":{"description":"An optional set of strings associated with the Plugin for grouping and filtering.","type":"array","items":{"type":"string"}}},"example":{"config":{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":["apikey"],"run_on_preflight":true},"enabled":true,"id":"3fd1eea1-885a-4011-b986-289943ff8177","name":"key-auth","protocols":["grpc","grpcs","http","https"]},"title":"Plugin"},"Route":{"description":"Route entities define rules to match client requests. Every request matching a given route will be proxied to its associated service.","type":"object","properties":{"created_at":{"description":"Unix epoch when the resource was created.","type":"integer"},"destinations":{"description":"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields ip (optionally in CIDR range notation) and/or port.","type":"array","items":{"type":"object","properties":{}}},"headers":{"description":"One or more lists of values indexed by header name that will cause this route to match if present in the request. The `Host` header cannot be used with this attribute: hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","type":"object"},"hosts":{"description":"A list of domain names that match this route. Note that the hosts value is case sensitive.","type":"array","items":{"type":"string","example":"foo.example.com"}},"https_redirect_status_code":{"description":"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the route is configured to only accept the `https` protocol.","type":"integer","default":426},"id":{"type":"string","example":"56c4566c-14cc-4132-9011-4139fcbbe50a"},"methods":{"description":"A list of HTTP methods that match this route.","type":"array","items":{"type":"string"}},"name":{"description":"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named test and Test.","type":"string"},"path_handling":{"description":"Controls how the service path, route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","type":"string","default":"v0"},"paths":{"description":"A list of paths that match this route.","type":"array","items":{"type":"string"}},"preserve_host":{"description":"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","type":"boolean","default":false},"protocols":{"description":"An array of the protocols this route should allow. See the [route Object](#route-object) section for a list of accepted protocols. When set to only `https`, HTTP requests are answered with an upgrade error. When set to only `http`, HTTPS requests are answered with an error.","type":"array","items":{"type":"string"},"default":["http","https"]},"regex_priority":{"description":"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","type":"integer","default":0},"request_buffering":{"description":"Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","type":"boolean","default":true},"response_buffering":{"description":"Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","type":"boolean","default":true},"service":{"description":"The service this route is associated to. This is where the route proxies traffic to.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"}}},"snis":{"description":"A list of SNIs that match this route when using stream routing.","type":"array","items":{"type":"string"}},"sources":{"description":"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields ip (optionally in CIDR range notation) and/or port.","type":"array","items":{"type":"object","properties":{}}},"strip_path":{"description":"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","type":"boolean","default":true},"tags":{"description":"An optional set of strings associated with the route for grouping and filtering.","type":"array","items":{"type":"string"}},"updated_at":{"description":"Unix epoch when the resource was last updated.","type":"integer"}},"example":{"hosts":["foo.example.com","foo.example.us"],"id":"56c4566c-14cc-4132-9011-4139fcbbe50a","name":"example-route","paths":["/v1","/v2"],"service":{"id":"bd380f99-659d-415e-b0e7-72ea05df3218"}},"title":"Route"},"SNI":{"description":"An SNI object represents a many-to-one mapping of hostnames to a certificate. That is, a certificate object can have many hostnames associated with it; when Kong receives an SSL request, it uses the SNI field in the Client Hello to lookup the certificate object based on the SNI associated with the certificate.","type":"object","properties":{"certificate":{"description":"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","example":"147f5ef0-1ed6-4711-b77f-489262f8bff7"}}},"created_at":{"description":"Unix epoch when the resource was created.","type":"integer","example":1422386534},"id":{"type":"string","example":"b87eb55d-69a1-41d2-8653-8d706eecefc0"},"name":{"description":"The SNI name to associate with the given certificate.","type":"string","example":"my-sni"},"tags":{"description":"An optional set of strings associated with the SNIs for grouping and filtering.","type":"array","items":{"type":"string","example":"user-level, enterprise"}}},"example":{"certificate":{"id":"bd380f99-659d-415e-b0e7-72ea05df3218"},"id":"36c4566c-14cc-4132-9011-4139fcbbe50a","name":"some.example.org"}},"Target":{"description":"A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with `weight=0`; alternatively, use the `DELETE` convenience method to accomplish the same. The current target object definition is the one with the latest `created_at`.","type":"object","properties":{"created_at":{"description":"Unix epoch when the resource was created.","type":"number","example":1422386534},"updated_at":{"description":"Unix epoch when the resource was last updated.","type":"integer","example":1422386534},"id":{"description":"The unique identifier or the name of the upstream for which to update the target.","type":"string","example":"173a6cee-90d1-40a7-89cf-0329eca780a6"},"tags":{"description":"An optional set of strings associated with the Target for grouping and filtering.","type":"array","items":{"type":"string"}},"target":{"description":"The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the `port` value will be overridden by the value from the DNS record.","type":"string"},"upstream":{"description":"The unique identifier or the name of the upstream for which to update the target.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","example":"bdab0e47-4e37-4f0b-8fd0-87d95cc4addc"}}},"weight":{"description":"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","type":"integer","example":100,"default":100}},"example":{"id":"089292a7-ba3d-4d88-acf0-97b4b2e2621a","target":"203.0.113.42","upstream":{"id":"5f1d7e76-2fed-4806-a6af-869984f025cb"},"weight":100},"x-examples":{"Example 1":{"created_at":1685645663,"id":"1da9dd7e-24a2-4a82-9826-5147ed76f804","tags":["string"],"target":"122.158.1.38:8000","updated_at":1685645663,"upstream":{"id":"fe335516-b679-44e5-8bf0-f9af0524e230"},"weight":100}}},"Upstream":{"description":"The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named `service.v1.xyz` for a service object whose `host` is `service.v1.xyz`. Requests for this service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.","type":"object","properties":{"algorithm":{"description":"Which load balancing algorithm to use.","type":"string","default":"round-robin"},"client_certificate":{"description":"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"}}},"created_at":{"description":"Unix epoch when the resource was created.","type":"integer","example":1422386534},"updated_at":{"description":"Unix epoch when the resouce was updated.","type":"integer","example":1422386534},"hash_fallback":{"description":"What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`.","type":"string","default":"none"},"hash_fallback_header":{"description":"The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.","type":"string"},"hash_fallback_query_arg":{"description":"The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","type":"string"},"hash_fallback_uri_capture":{"description":"The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","type":"string"},"hash_on":{"description":"What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing.","type":"string","default":"none"},"hash_on_cookie":{"description":"The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","type":"string"},"hash_on_cookie_path":{"description":"The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.","type":"string","default":"/"},"hash_on_header":{"description":"The header name to take the value from as hash input. Only required when `hash_on` is set to `header`.","type":"string"},"hash_on_query_arg":{"description":"The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","type":"string"},"hash_on_uri_capture":{"description":"The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.","type":"string"},"healthchecks":{"type":"object","properties":{"active":{"type":"object","properties":{"concurrency":{"type":"integer","default":10},"headers":{"type":"object"},"healthy":{"type":"object","properties":{"http_statuses":{"type":"array","items":{"type":"integer"},"default":[200,302]},"interval":{"type":"number","default":0},"successes":{"type":"integer","default":0}}},"http_path":{"type":"string","default":"/"},"https_sni":{"type":"string"},"https_verify_certificate":{"type":"boolean","default":true},"timeout":{"type":"number","default":1},"type":{"type":"string","default":"http"},"unhealthy":{"type":"object","properties":{"http_failures":{"type":"integer","default":0},"http_statuses":{"type":"array","items":{"type":"integer"},"default":[429,404,500,501,502,503,504,505]},"interval":{"type":"number","default":0},"tcp_failures":{"type":"integer","default":0},"timeouts":{"type":"integer","default":0}}}}},"passive":{"type":"object","properties":{"healthy":{"type":"object","properties":{"http_statuses":{"type":"array","items":{"type":"integer"},"default":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308]},"successes":{"type":"integer","default":0}}},"type":{"type":"string","default":"http"},"unhealthy":{"type":"object","properties":{"http_failures":{"type":"integer","default":0},"http_statuses":{"type":"array","items":{"type":"integer"},"default":[429,500,503]},"tcp_failures":{"type":"integer","default":0},"timeouts":{"type":"integer","default":0}}}}},"threshold":{"type":"number","default":0}}},"host_header":{"description":"The hostname to be used as `Host` header when proxying requests through Kong.","type":"string"},"id":{"type":"string"},"name":{"description":"This is a hostname, which must be equal to the `host` of a service.","type":"string"},"slots":{"description":"The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`.","type":"integer","default":10000},"tags":{"description":"An optional set of strings associated with the Upstream for grouping and filtering.","type":"array","items":{"type":"string"}},"use_srv_name":{"description":"If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`.","type":"boolean","default":false}},"example":{"algorithm":"round-robin","hash_fallback":"none","hash_on":"none","hash_on_cookie_path":"/","healthchecks":{"active":{"concurrency":10,"healthy":{"http_statuses":[200,302],"interval":0,"successes":0},"http_path":"/","https_verify_certificate":true,"timeout":1,"type":"http","unhealthy":{"http_failures":0,"http_statuses":[429,404,500,501,502,503,504,505],"interval":0,"tcp_failures":0,"timeouts":0}},"passive":{"healthy":{"http_statuses":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],"successes":0},"type":"http","unhealthy":{"http_failures":0,"http_statuses":[429,500,503],"tcp_failures":0,"timeouts":0}},"threshold":0},"id":"6eed5e9c-5398-4026-9a4c-d48f18a2431e","name":"api.example.internal","slots":10000}},"Vault":{"description":"Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, Hashicorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.","type":"object","properties":{"config":{"description":"The configuration properties for the Vault which can be found on the vaults' documentation page.","type":"object"},"created_at":{"description":"Unix epoch when the resource was created.","type":"integer","example":1422386534},"description":{"description":"The description of the Vault entity.","type":"string","example":"This vault is used to retrieve redis database access credentials"},"id":{"type":"string","example":"B2A30E8F-C542-49CF-8015-FB674987D1A5"},"name":{"description":"The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","type":"string","example":"env"},"prefix":{"description":"The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","type":"string","example":"env"},"tags":{"description":"An optional set of strings associated with the Vault for grouping and filtering.","type":"array","items":{"type":"string","example":"database-credentials"}},"updated_at":{"description":"Unix epoch when the resource was last updated.","type":"integer","example":1422386534}},"example":{"config":{"prefix":"ENV_PREFIX"},"description":"environment variable based vault","id":"2747d1e5-8246-4f65-a939-b392f1ee17f8","name":"env","tags":["foo","bar"]},"x-examples":{"Example Vault":{"id":"B2A30E8F-C542-49CF-8015-FB674987D1A5","prefix":"env","name":"env","description":"This vault is used to retrieve redis database access credentials","config":{"prefix":"SSL_"},"created_at":1422386534,"updated_at":1422386534,"tags":["database-credentials","data-plane"]}}},"pagination-offset-response":{"description":"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","type":"string"},"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"}}}]},"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"}}}]},"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"}}}]}},"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":{"CA-cert-request":{"content":{"application/json":{"schema":{"type":"object","properties":{"cert":{"description":"PEM-encoded public certificate of the CA.\n","type":"string","example":"-----BEGIN CERTIFICATE-----..."},"cert_digest":{"description":"SHA256 hex digest of the public certificate.\n","type":"string","example":"c641e28d77e93544f2fa87b2cf3f3d51..."},"tags":{"description":"An optional set of strings associated with the Certificate for grouping and filtering.","type":"array","items":{"type":"string"}}},"required":["cert"],"x-examples":{"Example 1":{"cert":"-----BEGIN CERTIFICATE-----...","cert_digest":"c641e28d77e93544f2fa87b2cf3f3d51...","tags":["user-level","low-priority"]}}}}},"description":"This request body represents a new Certificate Authority (CA) certificate and includes the properties required to create a new certificate."},"cert-request":{"content":{"application/json":{"schema":{"type":"object","properties":{"cert":{"description":"PEM-encoded public certificate chain of the SSL key pair. ","type":"string","example":"-----BEGIN CERTIFICATE-----...,"},"key":{"description":"PEM-encoded private key of the SSL key pair. ","type":"string","example":"-----BEGIN RSA PRIVATE KEY-----..."},"cert_alt":{"description":"PEM-encoded public certificate chain of the alternate SSL key pair. ","type":"string"},"key_alt":{"description":"PEM-encoded private key of the alternate SSL key pair. ","type":"string","example":"-----BEGIN EC PRIVATE KEY-----..."},"tags":{"description":"An optional set of strings associated with the Certificate for grouping and filtering.\n","type":"array","items":{"type":"string"}}},"required":["cert","key"],"x-examples":{"Example":{"id":"7fca84d6-7d37-4a74-a7b0-93e576089a41","created_at":1422386534,"cert":"-----BEGIN CERTIFICATE-----...","key":"-----BEGIN RSA PRIVATE KEY-----...","cert_alt":"-----BEGIN CERTIFICATE-----...","key_alt":"-----BEGIN EC PRIVATE KEY-----...","snis":["foo.test","example.com"],"tags":["user-level","low-priority"]}}}}}},"create-sni":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The SNI name to associate with the given certificate.","type":"string","example":"my-sni"},"tags":{"description":"An optional set of strings associated with the SNIs for grouping and filtering.\n","type":"array","items":{"type":"string","example":"[user-level, low-priority]"}},"certificate":{"description":"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `“certificate:{id:<certificate id>”}`.","type":"object","properties":{"id":{"description":"91020192-062d-416f-a275-9addeeaffaf2","type":"string","example":"91020192-062d-416f-a275-9addeeaffaf2"}},"required":["id"]}},"required":["name","certificate"],"x-examples":{"Example 1":{"name":"my-sni","tags":["user-level","low-priority"],"certificate":{"id":"a2e013e8-7623-4494-a347-6d29108ff68b"}}}}}},"description":"A JSON object containing the details of the new SNI, including the name, certificate, and tags."},"consumer-request":{"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"description":"The unique username of the Consumer. You must send either this field or custom_id with the request.\n","type":"string"},"custom_id":{"description":"Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.\n","type":"string"},"tags":{"description":"An optional set of strings associated with the Consumer for grouping and filtering.\n","type":"array","items":{"type":"string"}}},"required":["username","custom_id"],"x-examples":{"Example 1":{"id":"ec1a1f6f-2aa4-4e58-93ff-b56368f19b27","created_at":1422386534,"username":"my-username","custom_id":"my-custom-id","tags":["user-level","low-priority"]}}}}},"description":"Consumer request body"},"plugin-request":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.","type":"string","example":"rate-limiting","nullable":true},"route":{"description":"If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used. Default: `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `route:{id:<route id>}` or `route:{name:<route name>}`.","type":"object","properties":{"id":{"description":"The Id of the route.","type":"string","example":"a2e013e8-7623-4494-a347-6d29108ff68b"}}},"service":{"description":"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.","type":"object","nullable":true,"properties":{"id":{"description":"The Id of the route.","type":"string","example":"a2e013e8-7623-4494-a347-6d29108ff68b"}}},"instance_name":{"description":"The Plugin instance name.\n","type":"string","example":"rate-limiting-foo"},"config":{"description":"The configuration properties for the Plugin","type":"object","properties":{"hour":{"type":"integer","example":500},"minute":{"type":"integer","example":500}}},"protocols":{"description":"A list of the request protocols that will trigger this plugin.","type":"array","items":{"type":"string","enum":["http","grpc","grpcs","tls","tcp"],"default":"http"}},"enabled":{"description":"Whether the plugin is applied. Default: `true`.\n","type":"boolean","default":true},"tags":{"description":"An optional set of strings associated with the Plugin for grouping and filtering.\n","type":"array","items":{"type":"string"}}},"x-examples":{"Example 1":{"name":"rate-limiting","route":null,"service":null,"consumer":null,"instance_name":"rate-limiting-foo","config":{"hour":500,"minute":20},"protocols":["http","https"],"enabled":true,"tags":["user-level","low-priority"],"ordering":{"before":["plugin-name"]}}}},"examples":{"request example":{"value":{"name":"rate-limiting","consumer":"string","instance_name":"rate-limiting-foo","config":{"hour":500,"minute":500},"protocols":["http"],"enabled":true,"tags":["string"]}}}}},"description":"Plugin request body"},"key-set-request":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name to associate with the given key-set.\n","type":"string","example":"my-key_set"},"tags":{"description":"An optional set of strings associated with the Key for grouping and filtering.\n","type":"array","items":{"type":"string"}}},"x-examples":{"Example 1":{"name":"my-key_set","tags":["google-keys","mozilla-keys"]}}}}}},"keys-request":{"content":{"application/json":{"schema":{"type":"object","properties":{"set":{"description":"The id (an UUID) of the key-set with which to associate the key .With form-encoded, the notation is `set.id=<set id>` or `set.name=<set name>`. With JSON, use `“set:{id:<set id>}` or `set:{name:<set name>}.`","type":"object","properties":{"id":{"description":"46CA83EE-671C-11ED-BFAB-2FE47512C77A","type":"string"}}},"name":{"description":"The name to associate with the given keys.\n","type":"string","example":"my-key"},"kid":{"description":"A unique identifier for a key.\n","type":"string","example":"42"},"jwk":{"description":"A JSON Web Key represented as a string.","type":"string","example":"{\\alg\\:\\RSA\\,  \\kid\\: \\42\\,  ...}"},"pem":{"description":"A keypair in PEM format.\n","type":"object","properties":{"private_key":{"type":"string","example":"private_key: -----BEGIN"},"public_key":{"type":"string","example":"public_key: -----BEGIN"}}},"tags":{"description":"An optional set of strings associated with the Key for grouping and filtering.\n","type":"array","items":{"type":"string"}}},"required":["kid"],"x-examples":{"Example 1":{"set":{"id":"46CA83EE-671C-11ED-BFAB-2FE47512C77A"},"name":"my-key","kid":"42","jwk":"{alg:RSA,  kid: 42,  ...}","pem":{"private_key":"-----BEGIN","public_key":"-----BEGIN"},"tags":["application-a","public-key-xyz"]}}}}}},"route-request":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named “test” and “Test”.\n","type":"string"},"protocols":{"description":"An array of the protocols this route should allow","type":"array","items":{"type":"string","default":"https","example":"tcp"}},"methods":{"description":"A list of HTTP methods that match this route.\n","type":"array","items":{"type":"string","example":"GET"}},"hosts":{"description":"A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is `hosts[]=example.com&hosts[]=foo.test`. With JSON, use an Array.","type":"array","items":{"type":"string"}},"paths":{"description":"A list of paths that match this route. With form-encoded, the notation is `paths[]=/foo&paths[]=/bar`. With JSON, use an array. The path can be a regular expression, or a plain text pattern. ","type":"array","items":{"type":"string"}},"headers":{"description":"One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the `hosts` attribute. When headers contains only one value and that value starts with the special prefix` ~*`, the value is interpreted as a regular expression.","type":"object","properties":{"x-my-header":{"type":"array","items":{"type":"string"}},"x-another-header":{"type":"array","items":{"type":"string"}}}},"https_redirect_status_code":{"description":"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`\nLocation header is injected by Kong if the field is set to `301`, `302`, `307` or `308`. Note: This config applies only if the route is configured to only accept the https protocol. Accepted values are: `426`, `301`, `302`, `307`, `308`. Default: `426`.","type":"integer","example":426,"default":426,"enum":[426,301,302,307,308]},"regex_priority":{"description":"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones). Default: `0`.","type":"integer","example":0,"default":0},"strip_path":{"description":"When matching a route via one of the paths, strip the matching prefix from the upstream request URL. Default: `true`.","type":"boolean","default":true},"path_handling":{"description":"Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are: `v0`, `v1`. Default: `v0`.","type":"string","example":"v0","enum":["v1","v0"]},"preserve_host":{"description":"When matching a route via one of the `hosts` domain names, use the request `host` header in the upstream request headers. If set to `false`, the upstream Host header will be that of the service’s host.","type":"boolean","default":true},"request_buffering":{"description":"Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. Default: true.\n","type":"boolean","default":true},"response_buffering":{"description":"Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. Default: `true`.\n","type":"boolean","default":true},"snis":{"description":"A list of SNIs that match this route when using stream routing.\n","type":"array","items":{"type":"string"}},"sources":{"description":"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields “ip” (optionally in CIDR range notation) and/or “port”.\n","type":"array","items":{"type":"object","properties":{"ip":{"type":"string","example":"10.1.0.0/16"},"port":{"type":"integer","example":1234}}}},"destinations":{"description":"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields “ip” (optionally in CIDR range notation) and/or “port”.\n","type":"array","items":{"type":"object","properties":{"ip":{"type":"string","example":"0.1.0.0/16"},"port":{"type":"integer"}}}},"tags":{"description":"An optional set of strings associated with the route for grouping and filtering.\n","type":"array","items":{"type":"string"}},"service":{"description":"The service this route is associated to. This is where the route proxies traffic to. With form-encoded, the notation is service.id=<service id> or service.name=<service name>. With JSON, use “`service:{id:<service id>}` or `service:{name:<service name>}`.","type":"object","properties":{"id":{"type":"string","example":"af8330d3-dbdc-48bd-b1be-55b98608834b"}}}},"required":["protocols","https_redirect_status_code","preserve_host","request_buffering","response_buffering"],"x-examples":{"Example 1":{"name":"my-route","protocols":["http","https"],"methods":["GET","POST"],"hosts":["example.com","foo.test"],"paths":["/foo","/bar"],"headers":{"x-my-header":["foo","bar"],"x-another-header":["bla"]},"https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"v0","preserve_host":false,"request_buffering":true,"response_buffering":true,"snis":["foo.test","example.com"],"sources":[{"ip":"10.1.0.0/16","port":1234},{"ip":"10.2.2.2"},{"port":9123}],"destinations":[{"ip":"10.1.0.0/16","port":1234},{"ip":"10.2.2.2"},{"port":9123}],"tags":["user-level","low-priority"],"service":{"id":"af8330d3-dbdc-48bd-b1be-55b98608834b"}}}},"examples":{"Create a route":{"value":{"name":"my-route","protocols":["http","https"],"methods":["GET","POST"],"hosts":["example.com","foo.test"],"paths":["/foo","/bar"],"headers":{"x-my-header":["foo","bar"],"x-another-header":["bla"]},"https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"v0","preserve_host":false,"request_buffering":true,"response_buffering":true,"tags":["user-level","low-priority"],"service":{"id":"af8330d3-dbdc-48bd-b1be-55b98608834b"}}}}}},"description":"Route request body"},"service-request":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The service name.\n","type":"string","example":"my-service"},"retries":{"description":"The number of retries to execute upon failure to proxy. Default:`5`.\n","type":"integer","example":5,"default":5},"protocol":{"description":"The protocol used to communicate with the upstream. Accepted values are: `grpc`, `grpcs`, `http`, `https`, `tcp`, `tls`, `tls_passthrough`, `udp`, `ws`\n, `wss`\n. Default: `http`.","type":"string","example":"http","default":"http","enum":["grpc","grpcs","http","https","tcp","tls ","tls_passthrough","udp","ws","wss"]},"host":{"description":"The host of the upstream server. Note that the host value is case sensitive.\n","type":"string","example":"example.com"},"port":{"description":"The upstream server port. Default: `80`.\n","type":"integer","example":80,"default":80},"path":{"description":"The path to be used in requests to the upstream server.\n","type":"string","example":"/some_api"},"connect_timeout":{"description":"The timeout in milliseconds for establishing a connection to the upstream server. Default: `60000`.","type":"integer","example":6000,"default":6000},"write_timeout":{"description":"The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Default: `60000`.\n","type":"integer","example":6000,"default":6000},"read_timeout":{"description":"The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Default: `60000`.\n","type":"integer","example":6000,"default":6000},"tags":{"description":"An optional set of strings associated with the service for grouping and filtering.\n","type":"array","items":{"type":"string","example":"user-level"}},"client_certificate":{"description":"Certificate to be used as client certificate while TLS handshaking to the upstream server. With form-encoded, the notation is `client_certificate.id=<client_certificate id>`. With JSON, use `client_certificate:{id:<client_certificate id>}`.","type":"object","properties":{"id":{"type":"string","example":"4e3ad2e4-0bc4-4638-8e34-c84a417ba39b"}}},"tls_verify":{"description":"Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.\n","type":"boolean","default":true},"tls_verify_depth":{"description":"Maximum depth of chain while verifying Upstream server’s TLS certificate. If set to null, then the Nginx default is respected. Default: null.\n","type":"string","example":"respected","default":null,"nullable":true},"ca_certificates":{"description":"Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server’s TLS certificate. If set to null when Nginx default is respected. With form-encoded, the notation is `ca_certificates[]=4e3ad2e4-0bc4-4638-8e34-c84a417ba39b&ca_certificates[]=51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515`. With JSON, use an Array.","type":"array","items":{"type":"string","example":"4e3ad2e4-0bc4-4638-8e34-c84a417ba39b"}},"enabled":{"description":"Whether the service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404). Default: `true`.","type":"boolean","default":true}},"required":["protocol","host","port","enabled"],"x-examples":{"Example 1":{"id":"9748f662-7711-4a90-8186-dc02f10eb0f5","created_at":1422386534,"updated_at":1422386534,"name":"my-service","retries":5,"protocol":"http","host":"example.com","port":80,"path":"/some_api","connect_timeout":60000,"write_timeout":60000,"read_timeout":60000,"tags":["user-level","low-priority"],"client_certificate":{"id":"4e3ad2e4-0bc4-4638-8e34-c84a417ba39b"},"tls_verify":true,"tls_verify_depth":null,"ca_certificates":["4e3ad2e4-0bc4-4638-8e34-c84a417ba39b","51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515"],"enabled":true}}},"examples":{"Example":{"value":{"name":"my-service","retries":5,"protocol":"http","host":"example.com","port":80,"path":"/some_api","connect_timeout":6000,"write_timeout":6000,"read_timeout":6000,"tags":["user-level"],"client_certificate":{"id":"4e3ad2e4-0bc4-4638-8e34-c84a417ba39b"},"tls_verify":true,"tls_verify_depth":null,"ca_certificates":["4e3ad2e4-0bc4-4638-8e34-c84a417ba39b"],"enabled":true}},"http service":{"value":{"name":"my-service2","retries":5,"protocol":"http","host":"example.com","port":80,"path":"/some_api","connect_timeout":6000,"write_timeout":6000,"read_timeout":6000,"enabled":true}}}}}},"upstream-request":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"This is a hostname, which must be equal to the `host` of a service.","type":"string","example":"my-upstream"},"algorithm":{"description":"Which load balancing algorithm to use. Accepted values are: `consistent-hashing`, `least-connections`,` round-robin`. Default: `round-robin`.\n","type":"string","example":"round-robin","default":"round-robin","enum":["consistent-hashing","least-connections","round-robin"]},"hash_on":{"description":"What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing","type":"string","default":"none","enum":["none","consumer","ip","cookie","uri_capture","path","query_arg"]},"hash_fallback":{"description":"What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.","type":"string","example":"none","default":"none","enum":["none","consumer","ip","cookie","uri_capture","path","query_arg"]},"hash_on_header":{"description":"The header name to take the value from as hash input. Only required when `hash_on` is set to header.","type":"string","example":"none"},"hash_fallback_header":{"description":"The header name to take the value from as hash input. Only required when hash_fallback is set to header.","type":"string","example":"none","default":"none"},"hash_on_cookie":{"description":"The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","type":"string","example":"none"},"hash_on_cookie_path":{"description":"The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`. Default: `/`.","type":"string","example":"/","default":"/"},"hash_on_query_arg":{"description":"The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","type":"string","example":"hash_value"},"hash_fallback_query_arg":{"description":"The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","type":"string","example":"hash_value"},"hash_on_uri_capture":{"description":"The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.","type":"string","example":"hash_value"},"hash_fallback_uri_capture":{"description":"The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","type":"string","example":"hash_value"},"slots":{"description":"The number of slots in the load balancer algorithm. If the algorithm is set to `round-robin`, this setting determines the maximum number of slots. If the algorithm is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.","type":"integer","example":5000,"default":10000,"maximum":65536,"minimum":10},"healthchecks":{"type":"object","properties":{"passive":{"type":"object","properties":{"type":{"description":"Whether to perform passive health checks interpreting HTTP/HTTPS statuses, or just check for TCP connection success. In passive checks, http and https options are equivalent. Accepted values are: `tcp`, `http`, `https`, `grpc`, `grpcs`.","type":"string","example":"tcp","default":"http","enum":["tcp","http","https","grpc","grpcs"]},"healthy":{"type":"object","properties":{"http_statuses":{"description":"An array of HTTP statuses which represent healthiness when produced by proxied traffic, as observed by passive health checks.  With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=201`. With JSON, use an array.","type":"array","items":{"type":"integer","enum":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308]},"example":[200,201,202],"default":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308]},"successes":{"description":"Number of successes in proxied traffic (as defined by `healthchecks.passive.healthy.http_statuses`) to consider a target healthy, as observed by passive health checks.","type":"integer","example":2,"default":0}}},"unhealthy":{"type":"object","properties":{"http_statuses":{"description":"An array of HTTP statuses which represent unhealthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=500`. With JSON, use an array.","type":"array","items":{"type":"integer","enum":[429,500,503]},"example":[500,503],"default":[429,500,503]},"timeouts":{"description":"Number of timeouts in proxied traffic to consider a target unhealthy, as observed by passive health checks.","type":"integer","example":1,"default":0},"http_failures":{"description":"Number of HTTP failures in proxied traffic (as defined by `healthchecks.passive.unhealthy.http_statuses`) to consider a target unhealthy, as observed by passive health checks.","type":"integer","example":3,"default":0},"tcp_failures":{"description":"Number of TCP connection failures to consider a target unhealthy, as observed by passive health checks.","type":"integer","example":1,"default":0}}}}},"active":{"type":"object","properties":{"https_verify_certificate":{"type":"boolean"},"healthy":{"type":"object","properties":{"http_statuses":{"description":"An array of HTTP statuses to consider a success, indicating healthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=302`. With JSON, use an array.","type":"array","items":{"type":"integer"},"example":[200,201],"default":[200,302]},"successes":{"description":"Number of successes in active probes (as defined by `healthchecks.active.healthy.http_statuses`) to consider a target healthy.","type":"integer","example":3,"default":0},"interval":{"description":"Interval between active health checks for healthy targets (in seconds). A value of zero indicates that active probes for healthy targets should not be performed.","type":"integer","example":30,"default":0}}},"unhealthy":{"type":"object","properties":{"http_failures":{"description":"Number of HTTP failures in active probes (as defined by `healthchecks.active.unhealthy.http_statuses`) to consider a target unhealthy.","type":"integer","example":2,"default":0},"http_statuses":{"description":"An array of HTTP statuses to consider a failure, indicating unhealthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=404`. With JSON, use an array.","type":"array","items":{"type":"integer"},"example":[400,404],"default":[429,404,500,501,502,503,504,505]},"timeouts":{"description":"Number of timeouts in active probes to consider a target unhealthy.","type":"integer","example":2,"default":0},"tcp_failures":{"description":"Number of TCP failures in active probes to consider a target unhealthy.","type":"integer","example":1,"default":0},"interval":{"description":"Interval between active health checks for unhealthy targets (in seconds). A value of zero indicates that active probes for unhealthy targets should not be performed.","type":"integer","example":10,"default":0}}},"type":{"description":"Whether to perform active health checks using HTTP or HTTPS, or just attempt a TCP connection.","type":"string","example":"https","default":"http","enum":["tcp","http","https","grpc","grpcs"]},"concurrency":{"description":"Number of targets to check concurrently in active health checks.","type":"integer","example":5,"default":10},"timeout":{"description":"Socket timeout for active health checks (in seconds).","type":"integer","example":5,"default":1},"http_path":{"description":"Path to use in GET HTTP request to run as a probe on active health checks.","type":"string","default":"/"},"https_sni":{"description":"The hostname to use as an SNI (Server Name Identification) when performing active health checks using HTTPS. This is particularly useful when Targets are configured using IPs, so that the target host’s certificate can be verified with the proper SNI.","type":"string"}}},"threshold":{"description":"The minimum percentage of the upstream’s targets’ weight that must be available for the whole upstream to be considered healthy.","type":"integer","default":0,"maximum":100,"minimum":0}}},"tags":{"description":"An optional set of strings associated with the Upstream for grouping and filtering.","type":"array","items":{"type":"string"},"example":["user-level","low-priority"]},"host_header":{"description":"The hostname to be used as Host header when proxying requests through Kong.","type":"string"},"client_certificate":{"description":"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.","type":"object","properties":{"id":{"type":"string","example":"ea29aaa3-3b2d-488c-b90c-56df8e0dd8c6"}}}},"required":["name"],"x-examples":{"Example 1":{"id":"58c8ccbb-eafb-4566-991f-2ed4f678fa70","created_at":1422386534,"name":"my-upstream","algorithm":"round-robin","hash_on":"none","hash_fallback":"none","hash_on_cookie_path":"/","slots":10000,"healthchecks":{"passive":{"type":"http","healthy":{"http_statuses":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],"successes":0},"unhealthy":{"http_statuses":[429,500,503],"timeouts":0,"http_failures":0,"tcp_failures":0}},"active":{"https_verify_certificate":true,"healthy":{"http_statuses":[200,302],"successes":0,"interval":0},"unhealthy":{"http_failures":0,"http_statuses":[429,404,500,501,502,503,504,505],"timeouts":0,"tcp_failures":0,"interval":0},"type":"http","concurrency":10,"headers":[{"x-my-header":["foo","bar"],"x-another-header":["bla"]}],"timeout":1,"http_path":"/","https_sni":"example.com"},"threshold":0},"tags":["user-level","low-priority"],"host_header":"example.com","client_certificate":{"id":"ea29aaa3-3b2d-488c-b90c-56df8e0dd8c6"},"use_srv_name":false}}},"examples":{"Upstream":{"value":{"name":"my-upstream","algorithm":"round-robin","hash_on":"none","hash_fallback":"none","hash_on_cookie_path":"/","slots":10000,"healthchecks":{"passive":{"type":"http","healthy":{"http_statuses":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],"successes":0},"unhealthy":{"http_statuses":[429,500,503],"timeouts":0,"http_failures":0,"tcp_failures":0}},"active":{"https_verify_certificate":true,"healthy":{"http_statuses":[200,302],"successes":0,"interval":0},"unhealthy":{"http_failures":0,"http_statuses":[429,404,500,501,502,503,504,505],"timeouts":0,"tcp_failures":0,"interval":0},"type":"http","concurrency":10,"headers":{"type":"object","properties":{"x-my-header":{"description":"The value(s) of the x-my-header header.","type":"array","items":{"type":"string"}},"x-another-header":{"description":"The value(s) of the x-another-header header.","type":"array","items":{"type":"string"}}}},"timeout":1,"http_path":"/","https_sni":"example.com"},"threshold":0},"tags":["user-level","low-priority"],"host_header":"example.com","client_certificate":{"id":"ea29aaa3-3b2d-488c-b90c-56df8e0dd8c6"},"use_srv_name":false}},"Example request":{"value":{"name":"my-upstream","tags":["user-level","low-priority"],"algorithm":"round-robin"}}}}}},"target-request":{"content":{"application/json":{"schema":{"type":"object","properties":{"upstream":{"description":"The unique identifier or the name of the upstream for which to update the target.\n","type":"object","properties":{"id":{"description":"The unique identifier or the name of the upstream for which to update the target.","type":"string","example":"173a6cee-90d1-40a7-89cf-0329eca780a6"}}},"weight":{"description":"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","type":"integer","default":100,"maximum":65535,"minimum":0},"tags":{"description":"An optional set of strings associated with the Target for grouping and filtering.","type":"array","items":{"type":"string"}},"target":{"description":"The target IP address","type":"string","example":"192.158.1.38"}},"x-examples":{"Example 1":{"upstream":{"id":"bdab0e47-4e37-4f0b-8fd0-87d95cc4addc"},"target":"example.com:8000","weight":100,"tags":["user-level","low-priority"]}}},"examples":{"Example":{"value":{"upstream":{"id":"fe335516-b679-44e5-8bf0-f9af0524e230"},"target":"192.158.1.38","weight":100,"tags":["string"]}}}}}},"vault-request":{"content":{"application/json":{"schema":{"type":"object","properties":{"prefix":{"description":"The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.\n","type":"string","example":"pre"},"name":{"description":"The name of the Vault that’s going to be added. Currently, the Vault implementation must be installed in every Kong instance.\n","type":"string","example":"env"},"description":{"description":"The description of the Vault object.\n","type":"string","example":"This vault is used to retrieve redis database access credentials"},"config":{"description":"The configuration properties for the Vault which can be found on the vaults’ documentation page.\n","type":"object","properties":{"prefix":{"type":"string","example":"SSL_"}}},"tags":{"description":"An optional set of strings associated with the Vault for grouping and filtering.\n","type":"array","items":{"type":"string"}}},"x-examples":{"Example 1":{"prefix":"env","name":"env","description":"This vault is used to retrieve redis database access credentials","config":{"prefix":"SSL_"},"tags":["database-credentials","data-plane"]}}},"examples":{"Example 1":{"value":{"prefix":"pre","name":"env","description":"This vault is used to retrieve redis database access credentials","config":{"prefix":"SSL_"},"tags":["database-credentials","data-plane"]}}}}}},"consumer-groups-request":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"A unique name for the consumer group you want to create.","type":"string","example":"Example"},"tags":{"description":"An optional set of strings associated with the consumer group for grouping and filtering.","type":"array","items":{"type":"string"}}},"required":["name"],"x-examples":{"Example 1":{"name":"JL","tags":["tag1","tag2"]}}},"examples":{"Example 1":{"value":{"name":"Example","tags":["string"]}}}}},"description":"Consumer groups request body"},"create-dp-client-cert":{"content":{"application/json":{"schema":{"type":"object","properties":{"cert":{"description":"JSON escaped string of the certificate.","type":"string"}},"required":["cert"]},"examples":{"Sample DP Client Certificate":{"value":{"cert":"-----BEGIN CERTIFICATE-----\r\n*****\r\n-----END CERTIFICATE-----\r\n"}}}}},"description":"Request body for creating a dp-client-certificate."},"create-plugin-schemas":{"content":{"application/json":{"schema":{"type":"object","properties":{"lua_schema":{"description":"The custom plugin schema; `jq -Rs '.' schema.lua`.\n","type":"string","example":"return { name = \\\"myplugin\\\", fields = { { config = { type = \\\"record\\\", fields = { } } } } }"}},"required":["lua_schema"],"x-examples":{"Example 1":{"lua_schema":"return { name = \\\"myplugin\\\", fields = { { config = { type = \\\"record\\\", fields = { } } } } }"}}}}}}},"responses":{"sni-response":{"description":"SNI response object","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"Array of SNIs","type":"array","items":{"type":"object","properties":{"id":{"description":"The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.","type":"string","example":"147f5ef0-1ed6-4711-b77f-489262f8bff7"},"name":{"description":"The SNI name to associate with the given certificate.\n","type":"string","example":"my-sni"},"created_at":{"description":"Unix epoch when the resource was created.\n","type":"integer","example":1422386534},"tags":{"description":"An optional set of strings associated with the SNIs for grouping and filtering.\n","type":"array","items":{"type":"string"}},"certificate":{"description":"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n","type":"object","properties":{"id":{"description":"The unique identifier or the name attribute of the Certificate whose SNIs","type":"string","example":"2e013e8-7623-4494-a347-6d29108ff68b"}}}}}},"next":{"description":"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","type":"string","example":"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969"}},"x-examples":{"Example 1":{"data":[{"id":"147f5ef0-1ed6-4711-b77f-489262f8bff7","name":"my-sni","created_at":1422386534,"tags":["user-level","low-priority"],"certificate":{"id":"a3ad71a8-6685-4b03-a101-980a953544f6"}},{"id":"b87eb55d-69a1-41d2-8653-8d706eecefc0","name":"my-sni","created_at":1422386534,"tags":["admin","high-priority","critical"],"certificate":{"id":"4e8d95d4-40f2-4818-adcb-30e00c349618"}}],"next":"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969"}}},"examples":{"Example SNI response":{"value":{"certificate":{"id":"e94215b0-9198-42ce-bf0b-98afff31b2a7"},"created_at":1685646239,"id":"cf3b640e-100e-4fa4-aef6-2dc0488d7a58","name":"my-sni","updated_at":1685646239}}}}}},"consumer-response-data":{"description":"The consumer object response body","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The unique identifier or the name attribute of the consumer.","type":"string","example":"a4407883-c166-43fd-80ca-3ca035b0cdb7"},"created_at":{"description":"Unix epoch when the resource was created.","type":"integer","example":1422386534},"username":{"description":"The unique username of the consumer. You must send either this field or` custom_i`d with the request.","type":"string","example":"my-username"},"custom_id":{"description":"Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.","type":"string","example":"my-custom-id"},"updated_at":{"description":"Unix epoch when the resource was created.","type":"string","example":"1422386534"},"tags":{"description":"An optional set of strings associated with the Consumer for grouping and filtering.\n","type":"array","items":{"type":"string","example":"admin"}}}}},"next":{"description":"Pagination information","type":"string","example":"http://localhost:8001/consumers?offset=6378122c-a0a1-438d-a5c6-efabae9fb969"}},"x-examples":{"Example 1":{"data":[{"id":"a4407883-c166-43fd-80ca-3ca035b0cdb7","created_at":1422386534,"username":"my-username","custom_id":"my-custom-id","tags":["user-level","low-priority"]},{"id":"01c23299-839c-49a5-a6d5-8864c09184af","created_at":1422386534,"username":"my-username","custom_id":"my-custom-id","tags":["admin","high-priority","critical"]}],"next":"http://localhost:8001/consumers?offset=6378122c-a0a1-438d-a5c6-efabae9fb969"}}}}}},"consumer-create-response":{"description":"New consumer created response","content":{"application/json":{"schema":{"type":"object","properties":{"created_at":{"description":"Unix epoch when the resource was created.\n","type":"integer","example":1684424758},"custom_id":{"description":"Field for the unique consumer ID","type":"string"},"id":{"description":"The unique id of the consumer.","type":"string","example":"c1a1f6f-2aa4-4e58-93ff-b56368f19b27"},"tags":{"description":"An optional set of strings associated with the Consumer for grouping and filtering.","type":"array","items":{"type":"string"}},"updated_at":{"description":"Unix epoch when the resource was updated.\n","type":"integer","example":1684424758},"username":{"description":"The unique username of the consumer.","type":"string"}},"x-examples":{"Example 1":{"id":"ec1a1f6f-2aa4-4e58-93ff-b56368f19b27","created_at":1422386534,"username":"my-username","custom_id":"my-custom-id","tags":["user-level","low-priority"]}}},"examples":{"Example 1":{"value":{"created_at":1684424758,"custom_id":"string","id":"c1a1f6f-2aa4-4e58-93ff-b56368f19b27","tags":["string"],"updated_at":1684424758,"username":"string"}}}}}},"plugin-response":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"description":"The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.","type":"string","example":"rate-limiting"},"created_at":{"description":"Unix epoch when the resource was created.","type":"integer"},"route":{"description":"If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used. Default: `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `route:{id:<route id>}` or `route:{name:<route name>}`.","type":"string","nullable":true},"service":{"description":"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.","type":"string","nullable":true},"consumer":{"description":"If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.)","type":"string","nullable":true},"instance_name":{"description":"The Plugin instance name.\n","type":"string","example":"rate-limiting-foo"},"config":{"description":"The configuration properties for the Plugin","type":"object","properties":{"hour":{"type":"integer","example":500},"minute":{"type":"integer","example":500}}},"protocols":{"description":"A list of the request protocols that will trigger this plugin.","type":"array","items":{"type":"string","enum":["http","grpc","grpcs","tls","tcp"],"default":"http"}},"enabled":{"description":"Whether the plugin is applied. Default: `true`.\n","type":"boolean","default":true},"tags":{"description":"An optional set of strings associated with the Plugin for grouping and filtering.\n","type":"array","items":{"type":"string"}}}},"x-examples":{"Example 1":{"id":"ce44eef5-41ed-47f6-baab-f725cecf98c7","name":"rate-limiting","created_at":1422386534,"route":null,"service":null,"consumer":null,"instance_name":"rate-limiting-foo","config":{"hour":500,"minute":20},"protocols":["http","https"],"enabled":true,"tags":["user-level","low-priority"],"ordering":{"before":["plugin-name"]}}},"examples":{"Plugin response":{"value":{"data":[{"id":"02621eee-8309-4bf6-b36b-a82017a5393e","name":"rate-limiting","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":{"hour":500,"minute":20},"protocols":["http","https"],"enabled":true,"tags":["user-level","low-priority"],"ordering":{"before":["plugin-name"]}},{"id":"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4","name":"rate-limiting","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":{"hour":500,"minute":20},"protocols":["tcp","tls"],"enabled":true,"tags":["admin","high-priority","critical"]}],"next":"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969"}}}}}},"key-set-response":{"description":"Key set object response body","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F"},"name":{"description":"The name to associate with the given key-set.\n","type":"string","example":"my-key_set"},"created_at":{"description":"Unix epoch when the resource was last created.","type":"integer","example":1422386534},"updated_at":{"description":"Unix epoch when the resource was last updated.\n","type":"integer","example":1422386534},"tags":{"description":"The name to associate with the given key-set.\n","type":"array","items":{"type":"string"}},"next":{"description":"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page\n","type":"string","example":"http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969"}},"x-examples":{"Example 1":{"id":"b58c7d9d-e54f-444c-b24d-cdfc4159f61e","name":"example-key-set","created_at":1422386534,"updated_at":1422386534,"tags":["idp-keys"],"next":"http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969"}}},"examples":{"example":{"value":{"id":"4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F","name":"my-key_set","created_at":1422386534,"updated_at":1422386534,"tags":["string"],"next":"http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969"}}}}}},"service-response":{"description":"The service response object is returned when creating a new service or retreiving an existing service.","content":{"application/json":{"schema":{"type":"object","properties":{"connect_timeout":{"type":"integer"},"created_at":{"description":"Unix epoch when the resource was last created.","type":"integer"},"enabled":{"description":"Service enabled boolean","type":"boolean"},"host":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"port":{"type":"integer"},"protocol":{"type":"string"},"read_timeout":{"type":"integer"},"retries":{"type":"integer"},"updated_at":{"type":"integer"},"write_timeout":{"type":"integer"}},"x-examples":{"Example 1":{"connect_timeout":6000,"created_at":1684437851,"enabled":true,"host":"example.com","id":"ebf4e826-b17a-4e23-9d58-2621c9faa135","name":"my-service","path":"/some_api","port":80,"protocol":"http","read_timeout":6000,"retries":5,"updated_at":1684437851,"write_timeout":6000}}},"examples":{"Returned Service":{"value":{"connect_timeout":0,"created_at":0,"enabled":true,"host":"string","id":"string","name":"string","path":"string","port":0,"protocol":"string","read_timeout":0,"retries":0,"updated_at":0,"write_timeout":0}}}}}},"certificate_response":{"description":"A certificate object represents a public certificate. These fields are _referenceable_.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"An array containing certificate information.","type":"array","items":{"type":"object","properties":{"cert":{"description":"PEM-encoded public certificate chain of the SSL key This field is referenceable and can be stored in a vault","type":"string","example":"-----BEGIN CERTIFICATE-----\\ncertificate-content\\n-----END CERTIFICATE-----"},"created_at":{"description":"Unix epoch when the resource was created","type":"integer","example":1422386534},"id":{"description":"The UUID representation of the certificate object.","type":"string","example":"7fca84d6-7d37-4a74-a7b0-93e576089a41"},"key":{"description":"PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","type":"string","example":" -----BEGIN RSA PRIVATE KEY-----..."},"metadata":{"description":"metadata obtained from the certificate","type":"object","properties":{"expiry":{"description":"The expiration date of the certificate","type":"string","example":"4840697418"},"issuer":{"description":"Information about the certificate issuer","type":"string","example":"CN=Example certificate name Self-Signed Certificate,O=example\\, https://example.com,C=UA"},"key_usages":{"description":"Key usage flags for the certificate","type":"array","items":{"type":"string","example":"KEY_USAGE_TYPE_KEY_CERT_SIGN"},"example":["KEY_USAGE_TYPE_DIGITAL_SIGNATURE","KEY_USAGE_TYPE_KEY_CERT_SIGN","KEY_USAGE_TYPE_CRL_SIGN","KEY_USAGE_TYPE_ENCIPHER_ONLY"]},"subject":{"description":"Information about the certificate","type":"string","example":"CN=cert_name,O=Example\\, https://example.com,C=UA"}}},"tags":{"description":"An optional set of strings associated with the Certificate for grouping and filtering","type":"array","items":{"type":"string","example":"high-level"},"example":["high-level","temporary"]},"updated_at":{"description":"Unix epoch when the resource was updated","type":"integer","example":1422386534}}}}},"x-examples":{"Example 1":{"data":[{"cert":"-----BEGIN CERTIFICATE-----\nMIIDgzCCAmugAwIBAgIEV6GD9DANBgkqhkiG9w0BAQsFADBbMScwJQYDVQQDDB5SZWdlcnkgU2Vs\nZi1TaWduZWQgQ2VydGlmaWNhdGUxIzAhBgNVBAoMGlJlZ2VyeSwgaHR0cHM6Ly9yZWdlcnkuY29t\nMQswCQYDVQQGEwJVQTAgFw0yMzA1MjUwMDAwMDBaGA8yMTIzMDUyNTE0MTAxOFowRTERMA8GA1UE\nAwwIYXNkYXNkYXMxIzAhBgNVBAoMGlJlZ2VyeSwgaHR0cHM6Ly9yZWdlcnkuY29tMQswCQYDVQQG\nEwJVQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKodSp1dIdaK6BVj90gAWZFH5AcQ\nHY/oRtmheZNWY+9kY3VtuIWVzhxuP3y+ZG5j/TuzDpIoH/aUfinwoQwDSgbhCrG7wbQhoihJQKU1\nXUjodI8aayQdSiHkE6Q1DXAPnFVOWXmSSA0djRyvNH9ixqjNTBcibt0bCiV9iOt2t/QajEGdF6ia\nYf9kjLkxQ/4XWkNgwPhL4aSOOObrdT4pVphHBogfvIwtBL4fI8ZI2qojYtfJM8f/kMdScvN7aZ8r\n0QKzapelJjFsMTIPOHmPg7HcKVjvpuVGCO9vAso/PURD+g6nXBxsrmQqkCe8Y/41tBJ5GF97+is4\noDuyQBjY2f8CAwEAAaNjMGEwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAYYwHQYDVR0O\nBBYEFJgYiJ7UCq9XaLE9Y0vYfHBVWlLlMB8GA1UdIwQYMBaAFJgYiJ7UCq9XaLE9Y0vYfHBVWlLl\nMA0GCSqGSIb3DQEBCwUAA4IBAQBMD8wnPXCYCxImu5+3fotKnmen4FnL1zd9E1nHFZbGvImsgUFz\nkfK3KTNrihkqVSrSoP02mUvDVUDZDUU9Lwd9DzUsRT9QdoSnSKdcS5b31Dk8D8evR2zpYWBwJvaZ\nrm3e3z/9zUXxo5W4Y8N4HL90HqTwA0L2KzPZoc3LaQTpbcPQy5C6BbPZ3eSJH4h7fX8V+korNDnN\nu+y5qfAXs6YNPozsQeFKgIB673+nI+cC/Y5toDQbFA6ibcXLMszlsJVN+Ko1QalcgwZjX7jG1TbA\nyrN1eYw5JwCJPLR5vXt+6qlQ0dHcAqlzb7VTiumzLPz72Z3atsfhJNpSQ3cvM+p7\n-----END CERTIFICATE-----","created_at":1685023857,"id":"e94215b0-9198-42ce-bf0b-98afff31b2a7","key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAqh1KnV0h1oroFWP3SABZkUfkBxAdj+hG2aF5k1Zj72RjdW24\nhZXOHG4/fL5kbmP9O7MOkigf9pR+KfChDANKBuEKsbvBtCGiKElApTVdSOh0jxpr\nJB1KIeQTpDUNcA+cVU5ZeZJIDR2NHK80f2LGqM1MFyJu3RsKJX2I63a39BqMQZ0X\nqJph/2SMuTFD/hdaQ2DA+EvhpI445ut1PilWmEcGiB+8jC0Evh8jxkjaqiNi18kz\nx/+Qx1Jy83tpnyvRArNql6UmMWwxMg84eY+DsdwpWO+m5UYI728Cyj89REP6Dqdc\nHGyuZCqQJ7xj/jW0EnkYX3v6KzigO7JAGNjZ/wIDAQABAoIBAByut6f0zgHIhf0l\nT8paFMAEKRRvySw8c8W6Di+jf1Ib0RE5oMUVTx1IEXhM+c4LGeV4+Vn3XfxLaUJV\nCjJmU5L5Wr5A9BYVHaxBPZ8dck8aspx2Td5W+erg89baAxwD5c4UWc2/tlpPwz00\n5VsdInXPt6am7Z5mMr3DftSEvdtwX+k2DQAHK+dpwe+w4P74ndmzWz9ljLlBi1Jq\nTo6xBtcpxAagLQccDV04Ml58pu81E4VY427pM9xg7RMb4bK18y4jm3YHUFNWy8dM\nHr38iPss8DDd1IGOPAkiim72ncun3adf97YGgdTM1odWJGFFydfWkDQadmmwhTYv\neBS2SXECgYEA4KtgbPsmy4G4VYuc4P0Zy/ZHPjEvhLx57h+mXUk1JZv6+Hp2F4Q9\neRt5D//Ca8wjDy1adr9OhZN66YS8U6Jg4scTselxpQc6RIclE6nSQpMEx5nzDFFc\nPI3xmXJ3naoAXw1r3pkhyivrmZ5291qiIILVUDyQR/zK6bw/sILIi70CgYEAwdZR\npsiZiaSCWArPQyzg5uLTbjvnB1qRAxluH6vwlowPYAK5FQnzDlEEVPPo3JdjAM8q\np4oLMYf3wJH8Ls8pOXqHRBBpwSNbmZZMR7L7ac8ls88/8WCOnvDiA7Ibv/v9+u9+\nsm1q3af9dguwL7ji9+5WudmOpMl9WmoGaMDeWmsCgYEArN3wUaplTUzAgsHrsYnN\nYYxbgNTjlSRYRQqBPWHozMlZr/q6BpovmpGy8sZ91+e4SiNBagEE7+5sMmV5aniU\nR6mZ09ilIq+O+89ojdqq96KbmOExi5bGe6lT7hePRfbaVkjDaQE2aJKmswqkyuon\nuRAyBYy0D0/I6VN5Rd07ZZkCgYA3KSBPUCKxUsls+JaGzUyrJ713T0CtjQ5bTW9T\nQADVNsJhViUJYa1zU4biDg8kR0h7QHko+FW7ILBWcrTLNVTL8JxxuCIAPmmgyW6n\nsL1vHO3jv4S40fuEK5SF7LeM6M8cC++IIy8YKOguIaFf00NzvrWbadf3+QbdJfLw\n+IHORQKBgQDOGcFOPRUV48emb6wkm45WYVMsBIsbiAwKbZ9uLdo108vK5x/nlE8Z\nOXC1xqkec312HAzzjCUxKpSfTaIr1gV6YDGDEeHrYZrwsNo2Q6mBRbL/ZweDTegd\nggsmaDVo4kHoApfm7qi+BwCNnehxUR2FhBPs57vHZXYbQBr4unlWGA==\n-----END RSA PRIVATE KEY-----","metadata":{"expiry":"4840697418","issuer":"CN=Regery Self-Signed Certificate,O=Regery\\, https://regery.com,C=UA","key_usages":["KEY_USAGE_TYPE_DIGITAL_SIGNATURE","KEY_USAGE_TYPE_KEY_CERT_SIGN","KEY_USAGE_TYPE_CRL_SIGN","KEY_USAGE_TYPE_ENCIPHER_ONLY"],"subject":"CN=asdasdas,O=Regery\\, https://regery.com,C=UA"},"tags":["tag1"],"updated_at":1685023857}]}}}}}},"consumer-groups-response":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"created_at":{"description":"Unix epoch when the resource was created.","type":"integer","example":1685551597},"id":{"description":"Consumer group ID","type":"string","example":"0cf03a37-8987-4c3b-a792-5b1db3eeedc6"},"name":{"description":"The name of the consumer group","type":"string","example":"example"},"tags":{"description":"An optional set of strings associated with the Consumer for grouping and filtering.\n","type":"array","items":{"type":"string"}},"updated_at":{"description":"The unix epoc representation of when the consumer group was updated.","type":"integer","example":1685551597}}}}},"x-examples":{"Example 1":{"data":[{"created_at":1685551597,"id":"0cf03a37-8987-4c3b-a792-5b1db3eeedc6","name":"test","tags":["tag1"],"updated_at":1685551597}]}}},"examples":{"Example consumer group response":{"value":{"data":[{"created_at":1685551597,"id":"0cf03a37-8987-4c3b-a792-5b1db3eeedc6","name":"test","tags":["tag1"],"updated_at":1685551597}]}}}},"application/xml":{"schema":{"type":"object","properties":{}}}}},"return-consumer-group":{"description":"The response body returns a consumer group and the associated consumers.","content":{"application/json":{"schema":{"type":"object","properties":{"consumer_group":{"type":"object","properties":{"created_at":{"description":"Unix epoch when the resource was created.","type":"integer","example":1685551597},"id":{"type":"string","format":"uuid","example":"04fbeacf-a9f1-4a5d-ae4a-b0407445db3f"},"name":{"description":"The name of the consumer group","type":"string","example":"example"},"tags":{"description":"An optional set of strings associated with the Consumer for grouping and filtering.\n","type":"array","items":{"type":"string"}},"updated_at":{"description":"The unix epoc representation of when the consumer group was updated.","type":"integer","example":1685551597}}},"consumers":{"type":"array","items":{"type":"object","properties":{"created_at":{"description":"Unix epoch when the resource was created.","type":"integer","example":1685551597},"custom_id":{"description":"A custom ID for the resource","type":"string","example":null,"nullable":true},"id":{"description":"The UUID of the consumer","type":"string","example":"0cf03a37-8987-4c3b-a792-5b1db3eeedc6"},"tags":{"type":"array","items":{"type":"string"}},"updated_at":{"description":"Unix epoch when the resource was updated.","type":"integer","example":1685551597},"username":{"description":"the username for the consumer","type":"string","example":"example-username"}}}}},"x-examples":{"Example 1":{"consumer_group":{"created_at":1685551597,"id":"0cf03a37-8987-4c3b-a792-5b1db3eeedc6","name":"test","tags":["tag1"],"updated_at":1685551597},"consumers":[{"created_at":1685023220,"custom_id":"Example-custom-id","id":"28384076-31e3-4c27-bd76-7edc57434382","tags":["string"],"updated_at":1685023220,"username":"ExampleUsername"}]}}}}}},"get-dp-client-cert":{"description":"Response body for retrieving a dp-client-certificate.","content":{"application/json":{"schema":{"type":"object","properties":{"item":{"type":"object","properties":{"id":{"description":"Unique ID of the certificate entity.","type":"string"},"created_at":{"description":"Date certificate was created.","type":"integer"},"updated_at":{"description":"Date certificate was last updated.","type":"integer"},"cert":{"description":"JSON escaped string of the certificate.","type":"string"}}}}}}}},"get-expected-config-hash":{"description":"Response body for retrieving the expected config hash of the runtime group.","content":{"application/json":{"schema":{"type":"object","properties":{"expected_hash":{"description":"The expected configuration hash.","type":"string"},"created_at":{"description":"Date the runtime group configuration was created.","type":"integer"},"updated_at":{"description":"Date the runtime group configuration was last updated.","type":"integer"}}}}}},"list-dp-client-certs":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Unique ID of the certificate entity.","type":"string"},"created_at":{"description":"Date certificate was created.","type":"integer"},"updated_at":{"description":"Date certificate was last updated.","type":"integer"},"cert":{"description":"JSON escaped string of the certificate.","type":"string"}}}},"page":{"type":"object","properties":{"total_count":{"type":"integer"},"next_cursor":{"type":"string"},"has_next_page":{"type":"boolean"}}}}}}}},"list-nodes":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"hostname":{"type":"string"},"last_ping":{"type":"integer"},"type":{"type":"string"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"},"config_hash":{"type":"string"},"compatibility_status":{"type":"object","properties":{"state":{"type":"string"}}}}}},"page":{"type":"object","properties":{"total_count":{"type":"integer"}}}}}}}},"list-nodes-eol":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"node_id":{"type":"string"},"node_version":{"type":"string"},"message":{"type":"string"}}}},"page":{"type":"object","properties":{"total_count":{"type":"integer"}}}}}}}},"get-node":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"item":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"hostname":{"type":"string"},"last_ping":{"type":"integer"},"type":{"type":"string"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"},"config_hash":{"type":"string"},"compatibility_status":{"type":"object","properties":{"state":{"type":"string"}}}}}}}}}},"list-plugin-schemas":{"description":"A paginated list response for a collection of custom plugin schemas.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"lua_schema":{"description":"The custom plugin schema; `jq -Rs '.' schema.lua`.","type":"string","example":"return { name = \\\"myplugin\\\", fields = { { config = { type = \\\"record\\\", fields = { } } } } }"},"name":{"description":"The custom plugin name determined by the custom plugin schema.","type":"string","example":"myplugin"},"created_at":{"description":"An ISO-8604 timestamp representation of custom plugin schema creation date.","type":"integer","example":1422386534},"updated_at":{"description":"An ISO-8604 timestamp representation of custom plugin schema update date.","type":"integer","example":1422412345}}}},"page":{"type":"object","properties":{"total_count":{"type":"integer"}}}}}}}},"plugin-schemas":{"description":"A response for a single custom plugin schema.","content":{"application/json":{"schema":{"type":"object","properties":{"item":{"type":"object","properties":{"lua_schema":{"description":"The custom plugin schema; `jq -Rs '.' schema.lua`.","type":"string","example":"return { name = \\\"myplugin\\\", fields = { { config = { type = \\\"record\\\", fields = { } } } } }"},"name":{"description":"The custom plugin name determined by the custom plugin schema.","type":"string","example":"myplugin"},"created_at":{"description":"An ISO-8604 timestamp representation of custom plugin schema creation date.","type":"integer","example":1422386534},"updated_at":{"description":"An ISO-8604 timestamp representation of custom plugin schema update date.","type":"integer","example":1422412345}}}}}}}},"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"}}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}}},"securitySchemes":{"konnectAccessToken":{"type":"http","scheme":"bearer","description":"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to\nauthenticate with."},"personalAccessToken":{"type":"http","scheme":"bearer","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard."}}},"tags":[{"description":"Gateway services","name":"Services"},{"description":"Gateway routes","name":"Routes"},{"description":"Plugins","name":"Plugins"},{"description":"Consumers","name":"Consumers"},{"description":"Consumer Groups","name":"consumer-groups"},{"description":"Certificates","name":"Certificates"},{"description":"SNIs","name":"SNIs"},{"description":"CA certificates","name":"CA Certificates"},{"description":"Upstreams","name":"Upstreams"},{"description":"Vaults","name":"Vaults"},{"description":"Keys","name":"Keys"},{"description":"Key-sets","name":"Key-sets"},{"description":"Information routes","name":"Information"},{"description":"Debug routes","name":"Debug"},{"description":"Target routes","name":"Targets"},{"description":"DP Nodes","name":"DP Nodes"},{"description":"DP Certificates","name":"DP Certificates"},{"description":"Custom Plugin Schemas","name":"Custom Plugin Schemas"}],"externalDocs":{"description":"Documentation for Kong Gateway and its APIs","url":"https://docs.konghq.com"},"security":[{"konnectAccessToken":[]},{"personalAccessToken":[]}]}
```
