openapi: 3.1.0 info: title: Konnect API version: 2.0.0 description: The Konnect platform API contact: name: Kong url: 'https://cloud.konghq.com' email: support@konghq.com license: name: Apache 2.0 url: 'https://www.apache.org/licenses/LICENSE-2.0.html' servers: - url: 'https://global.api.konghq.com' - url: 'https://us.api.konghq.com' - url: 'https://eu.api.konghq.com' - url: 'https://au.api.konghq.com' - url: 'https://me.api.konghq.com' - url: 'https://in.api.konghq.com' paths: /v0/serverless-cloud-gateways: post: x-speakeasy-entity-operation: terraform-resource: ServerlessCloudGateway#create terraform-datasource: null operationId: create-serverless-cloud-gateway summary: Create a new serverless cloud gateway description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Create a new serverless cloud gateway requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateServerlessCloudGatewayRequest' responses: '201': $ref: '#/components/responses/CreateServerlessCloudGatewayResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' servers: - url: 'https://global.api.konghq.com/' tags: - Serverless Cloud Gateways '/v0/serverless-cloud-gateways/{controlPlaneId}': parameters: - name: controlPlaneId in: path description: Id of the Serverless Cloud Gateway control plane required: true schema: type: string format: uuid example: bf138ba2-c9b1-4229-b268-04d9d8a6410b x-speakeasy-match: control_plane.id get: x-speakeasy-entity-operation: terraform-resource: ServerlessCloudGateway#read terraform-datasource: null operationId: get-serverless-cloud-gateway summary: Get the serverless cloud gateway description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Get the serverless cloud gateway responses: '200': $ref: '#/components/responses/RetrieveServerlessCloudGatewayResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Serverless Cloud Gateways delete: x-speakeasy-entity-operation: terraform-resource: ServerlessCloudGateway#delete terraform-datasource: null operationId: delete-serverless-cloud-gateway summary: Delete the serverless cloud gateway description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Delete the serverless cloud gateway responses: '204': description: No Content '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Serverless Cloud Gateways /v1/catalog-services: post: x-speakeasy-entity-operation: CatalogService#create operationId: create-catalog-service summary: Create Service description: Creates a service. requestBody: $ref: '#/components/requestBodies/CreateCatalogServiceRequest' responses: '201': $ref: '#/components/responses/CatalogServiceResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - Catalog Services '/v1/catalog-services/{id}': parameters: - name: id in: path description: The `id` of the service. required: true schema: type: string example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 get: x-speakeasy-entity-operation: terraform-resource: CatalogService#read terraform-datasource: null operationId: fetch-catalog-service summary: Fetch Service description: Fetches a service. responses: '200': $ref: '#/components/responses/CatalogServiceResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Catalog Services patch: x-speakeasy-entity-operation: CatalogService#update operationId: update-catalog-service summary: Update Service description: Updates a service. requestBody: $ref: '#/components/requestBodies/UpdateCatalogServiceRequest' responses: '200': $ref: '#/components/responses/CatalogServiceResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' tags: - Catalog Services delete: x-speakeasy-entity-operation: CatalogService#delete operationId: delete-catalog-service summary: Delete Service description: Deletes a service. responses: '204': description: Service was deleted successfully. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Catalog Services '/v1/cmeks/{cmekId}': parameters: - $ref: '#/components/parameters/cmekId' get: x-speakeasy-entity-operation: terraform-resource: CMEK#read terraform-datasource: null operationId: get-cmek summary: Get a CMEK description: Get a customer managed encryption key. responses: '200': $ref: '#/components/responses/CMEK' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - CMEK put: x-speakeasy-entity-operation: 'CMEK#create,update' operationId: put-cmek summary: Create or replace a CMEK description: Create or replace a customer managed encryption key. requestBody: $ref: '#/components/requestBodies/ReplaceCMEK' responses: '200': $ref: '#/components/responses/CMEK' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - CMEK delete: x-speakeasy-entity-operation: CMEK#delete operationId: delete-cmek summary: Delete a CMEK description: 'Delete a customer managed encryption key. Avoid revoking or deleting a KMS key and CMEK that is actively used by Konnect, as this can lead to data loss or service disruptions.' responses: '204': description: Success '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - CMEK /v1/integration-instances: post: x-speakeasy-entity-operation: IntegrationInstance#create operationId: create-integration-instance summary: Create Integration Instance description: Creates an integration instance. requestBody: $ref: '#/components/requestBodies/CreateIntegrationInstanceRequest' responses: '201': $ref: '#/components/responses/IntegrationInstanceResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - Integration Instances '/v1/integration-instances/{id}': parameters: - name: id in: path description: The `id` of the integration instance. required: true schema: type: string example: 3f51fa25-310a-421d-bd1a-007f859021a3 get: x-speakeasy-entity-operation: terraform-resource: IntegrationInstance#read terraform-datasource: null operationId: fetch-integration-instance summary: Fetch Integration Instance description: Fetches a integration instance. responses: '200': $ref: '#/components/responses/IntegrationInstanceResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Integration Instances patch: x-speakeasy-entity-operation: IntegrationInstance#update operationId: update-integration-instance summary: Update Integration Instance description: Updates an integration instance. requestBody: $ref: '#/components/requestBodies/UpdateIntegrationInstanceRequest' responses: '200': $ref: '#/components/responses/IntegrationInstanceResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' tags: - Integration Instances delete: x-speakeasy-entity-operation: IntegrationInstance#delete operationId: delete-integration-instance summary: Delete Integration Instance description: Deletes an integration instance. responses: '204': description: Integration Instance was deleted successfully. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Integration Instances '/v1/integration-instances/{integrationInstanceId}/auth-config': parameters: - name: integrationInstanceId in: path description: The `id` of the integration instance. required: true schema: type: string example: 3f51fa25-310a-421d-bd1a-007f859021a3 get: x-speakeasy-entity-operation: terraform-resource: IntegrationInstanceAuthConfig#read terraform-datasource: null operationId: get-integration-instance-auth-config summary: Get Integration Instance Auth Config description: Fetches auth config scoped to the given integration instance. responses: '200': $ref: '#/components/responses/IntegrationInstanceAuthConfigResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Integration Instance Auth Config put: x-speakeasy-entity-operation: 'IntegrationInstanceAuthConfig#create,update' operationId: upsert-integration-instance-auth-config summary: Upsert Integration Instance Auth Config description: Upserts auth config scoped to the given integration instance. requestBody: $ref: '#/components/requestBodies/UpsertIntegrationInstanceAuthConfigRequest' responses: '200': $ref: '#/components/responses/IntegrationInstanceAuthConfigResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Integration Instance Auth Config delete: x-speakeasy-entity-operation: IntegrationInstanceAuthConfig#delete operationId: delete-integration-instance-auth-config summary: Delete Integration Instance Auth Config description: Deletes the auth config scoped to the given integration instance. responses: '204': description: Integration Instance Auth Config was deleted successfully. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Integration Instance Auth Config '/v1/integration-instances/{integrationInstanceId}/auth-credential': parameters: - name: integrationInstanceId in: path description: The `id` of the integration instance. required: true schema: type: string example: 3f51fa25-310a-421d-bd1a-007f859021a3 post: x-speakeasy-entity-operation: IntegrationInstanceAuthCredential#create operationId: create-integration-instance-auth-credential summary: Create Integration Instance Auth Credential description: | Creates an auth credential scoped to the given integration instance. Auth credentials are singleton resources that have a 1-to-1 relationship with an integration instance. An attempt to create subsequent auth credentials for an instance will result in a 409 response. requestBody: $ref: '#/components/requestBodies/CreateIntegrationInstanceAuthCredentialRequest' responses: '201': $ref: '#/components/responses/IntegrationInstanceAuthCredentialResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' tags: - Integration Instance Auth Credentials get: x-speakeasy-entity-operation: terraform-resource: IntegrationInstanceAuthCredential#read terraform-datasource: null operationId: get-integration-instance-auth-credential summary: Get Integration Instance Auth Credential description: Fetches the auth credential scoped to the given integration instance. responses: '200': $ref: '#/components/responses/IntegrationInstanceAuthCredentialResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Integration Instance Auth Credentials delete: x-speakeasy-entity-operation: IntegrationInstanceAuthCredential#delete operationId: delete-integration-instance-auth-credential summary: Delete Integration Instance Auth Credential description: Deletes the auth credential scoped to the given integration instance. responses: '204': description: Integration Instance Auth Credential was deleted successfully. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Integration Instance Auth Credentials /v1/mesh/control-planes: get: x-speakeasy-entity-operation: MeshControlPlanes#get operationId: list-mesh-control-planes summary: List Control Planes description: Returns an array of control planes objects. parameters: - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/PageNumber' responses: '200': $ref: '#/components/responses/ListMeshControlPlanesResponse' '401': $ref: '#/components/responses/MeshControlPlaneUnauthorizedError' '403': $ref: '#/components/responses/MeshControlPlaneForbiddenError' tags: - Mesh post: x-speakeasy-entity-operation: terraform-resource: MeshControlPlane#create terraform-datasource: null operationId: create-cp summary: Create a new control plane description: Create a new control plane requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateMeshControlPlaneRequest' responses: '201': $ref: '#/components/responses/CreateMeshControlPlaneResponse' '400': $ref: '#/components/responses/CreateMeshControlPlaneValidationError' '401': $ref: '#/components/responses/MeshControlPlaneUnauthorizedError' '403': $ref: '#/components/responses/MeshControlPlaneForbiddenError' tags: - Mesh '/v1/mesh/control-planes/{cpId}': parameters: - name: cpId in: path description: Id of the Konnect resource required: true schema: type: string format: uuid example: bf138ba2-c9b1-4229-b268-04d9d8a6410b x-speakeasy-match: id x-speakeasy-param-suppress-computed-diff: true get: x-speakeasy-entity-operation: terraform-resource: MeshControlPlane#read terraform-datasource: null operationId: get-mesh-control-plane summary: Get the control plane description: Get the control plane responses: '200': $ref: '#/components/responses/RetrieveMeshControlPlaneResponse' '401': $ref: '#/components/responses/MeshControlPlaneUnauthorizedError' '403': $ref: '#/components/responses/MeshControlPlaneForbiddenError' '404': $ref: '#/components/responses/MeshControlPlaneNotFoundError' tags: - Mesh delete: x-speakeasy-entity-operation: terraform-resource: MeshControlPlane#delete terraform-datasource: null operationId: delete-mesh-control-plane summary: Delete the control plane description: Delete the control plane responses: '204': description: No Content '400': $ref: '#/components/responses/DeleteMeshControlPlaneValidationError' '401': $ref: '#/components/responses/MeshControlPlaneUnauthorizedError' '403': $ref: '#/components/responses/MeshControlPlaneForbiddenError' '404': $ref: '#/components/responses/MeshControlPlaneNotFoundError' tags: - Mesh x-speakeasy-retries: strategy: backoff backoff: initialInterval: 1000 maxInterval: 60000 maxElapsedTime: 360000 exponent: 2 statusCodes: - 400 retryConnectionErrors: true put: x-speakeasy-entity-operation: terraform-resource: MeshControlPlane#update terraform-datasource: null operationId: update-cp summary: Update a whole control plane description: Update a whole control plane requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PutMeshControlPlaneRequest' responses: '200': $ref: '#/components/responses/PutMeshControlPlaneResponse' '400': $ref: '#/components/responses/PutMeshControlPlaneValidationError' '401': $ref: '#/components/responses/MeshControlPlaneUnauthorizedError' '403': $ref: '#/components/responses/MeshControlPlaneForbiddenError' '404': $ref: '#/components/responses/MeshControlPlaneNotFoundError' tags: - Mesh /v1/realms: post: x-speakeasy-entity-operation: terraform-resource: Realm#create terraform-datasource: null operationId: create-realm summary: Create a realm description: | Create a new Realm. Centrally Managed Consumers are created within a Realm. Each Realm can be restricted to a specific set of control planes if needed using `allowed_control_planes` or `allow_all_control_planes`. `ttl` and `negative_ttl` control how long the consumers are kept in memory by a running Gateway. Any `consumer_groups` added to the Realm are automatically applied to all consumers within this Realm. requestBody: $ref: '#/components/requestBodies/CreateConsumerRealm' responses: '201': $ref: '#/components/responses/CreateConsumerRealmResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' tags: - Realms '/v1/realms/{realmId}': parameters: - $ref: '#/components/parameters/realmId' get: x-speakeasy-entity-operation: terraform-resource: Realm#read terraform-datasource: null operationId: get-realm summary: Get a realm description: 'Fetch the details of a specific realm, identified by its UUID' responses: '200': description: success content: application/json: schema: $ref: '#/components/schemas/ConsumerRealm' tags: - Realms patch: x-speakeasy-entity-operation: terraform-resource: Realm#update terraform-datasource: null operationId: update-realm summary: Update a realm description: | Update a realm's details. Any consumers already cached in a running Gateway will not be affected body the changes to the Realm until `ttl` minutes have passed. requestBody: $ref: '#/components/requestBodies/UpdateConsumerRealm' responses: '200': description: success content: application/json: schema: $ref: '#/components/schemas/ConsumerRealm' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' tags: - Realms delete: x-speakeasy-entity-operation: terraform-resource: Realm#delete terraform-datasource: null operationId: delete-realm summary: Delete a realm description: | Delete a Realm, and all consumers and credentials containined within the Realm. Only empty Realms can be deleted, unless you specify `?force=true` as a query string parameter in your request. parameters: - name: force in: query description: | If set to "true", the realm and all consumers and credentials will be deleted when running `terraform destroy`. If set to "false", the realm will not be deleted until all child entities are manually removed. This will IRREVERSIBLY DELETE ALL REGISTERED CONSUMERS AND THEIR CREDENTIALS. Only set to "true" if you want this behavior. schema: type: string default: 'false' enum: - 'true' - 'false' x-speakeasy-name-override: force_destroy responses: '204': description: success '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '404': $ref: '#/components/responses/NotFound' tags: - Realms '/v1/realms/{realmId}/consumers': parameters: - $ref: '#/components/parameters/realmIdForChildren' post: x-speakeasy-entity-operation: terraform-resource: CentralizedConsumer#create terraform-datasource: null operationId: create-consumer-in-realm summary: Create a consumer description: | Create a new consumer in this Realm. It will be available to use for authentication within a few seconds, unless the consumer's username is blocked in the Gateway. If this is the case, the new consumer will be available in `negative_ttl` (see the Realm definition) seconds. requestBody: $ref: '#/components/requestBodies/CreateConsumer' responses: '201': $ref: '#/components/responses/CreateConsumerResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '404': $ref: '#/components/responses/NotFound' tags: - Centrally Managed Consumers '/v1/realms/{realmId}/consumers/{consumerId}': parameters: - $ref: '#/components/parameters/realmIdForChildren' - $ref: '#/components/parameters/consumerId' get: x-speakeasy-entity-operation: terraform-resource: CentralizedConsumer#read terraform-datasource: null operationId: get-consumer-from-realm summary: Get a consumer description: | Get a consumer from the given realm. responses: '200': description: success content: application/json: schema: $ref: '#/components/schemas/CentralizedConsumer' '404': $ref: '#/components/responses/NotFound' tags: - Centrally Managed Consumers patch: x-speakeasy-entity-operation: terraform-resource: CentralizedConsumer#update terraform-datasource: null operationId: update-consumer-in-realm summary: Update a consumer description: | Update a Consumer's details. Any consumers already cached in a running Gateway will not be affected body the changes to the Realm until `ttl` minutes have passed. requestBody: $ref: '#/components/requestBodies/UpdateConsumer' responses: '200': description: success content: application/json: schema: $ref: '#/components/schemas/CentralizedConsumer' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '404': $ref: '#/components/responses/NotFound' tags: - Centrally Managed Consumers delete: x-speakeasy-entity-operation: terraform-resource: CentralizedConsumer#delete terraform-datasource: null operationId: delete-consumer-in-realm summary: Delete a consumer description: | Delete a consumer. This operation removes the consumer from the system, causing all future authentication requests using keys associated with that consumer to fail. However, it does not immediately invalidate any cached keys stored in the gateway's state. These keys may remain usable until the cache expires, based on the TTL (Time-To-Live) configured for the realm. responses: '204': description: success '404': description: not found tags: - Centrally Managed Consumers '/v1/realms/{realmId}/consumers/{consumerId}/keys': parameters: - $ref: '#/components/parameters/realmIdForChildren' - $ref: '#/components/parameters/centralizedConsumerIdForChildren' post: x-speakeasy-entity-operation: terraform-resource: CentralizedConsumerKey#create terraform-datasource: null operationId: create-consumer-key summary: Create a key description: | This operation generates an API key for the specified consumer. The key is returned only at the time of creation and will not be retrievable in any subsequent GET requests on the entity. The API supports two key creation types: `new` and `legacy`. * `new`: The recommended and more efficient option. The API automatically generates the key and returns it during this operation. * `legacy`: Allows you to provide your own secret. This approach has a performance impact when proxying requests, as it involves additional processing and resource usage. Note: Regardless of the type selected, the key is only returned by the API when a key is created. It is not retrievable in the future. requestBody: $ref: '#/components/requestBodies/CreateApiKey' responses: '201': description: success content: application/json: schema: $ref: '#/components/schemas/CreateApiKeyResult' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '404': $ref: '#/components/responses/NotFound' tags: - Centrally Managed Keys '/v1/realms/{realmId}/consumers/{consumerId}/keys/{keyId}': parameters: - $ref: '#/components/parameters/realmIdForChildren' - $ref: '#/components/parameters/centralizedConsumerIdForChildren' - $ref: '#/components/parameters/keyId' get: x-speakeasy-entity-operation: terraform-resource: CentralizedConsumerKey#read terraform-datasource: null operationId: get-consumer-key summary: Get a key description: | Returns the key entity. This operation does **NOT** return the key itself. The key is only available at the time of creation. responses: '200': description: success content: application/json: schema: $ref: '#/components/schemas/ApiKey' '404': $ref: '#/components/responses/NotFound' tags: - Centrally Managed Keys delete: x-speakeasy-entity-operation: terraform-resource: CentralizedConsumerKey#delete terraform-datasource: null operationId: delete-consumer-key summary: Delete a key description: | Delete a key. This operation removes the key from the system, causing all future authentication requests using this key to fail. However, it does not immediately invalidate any cached keys stored in the gateway's state. These keys may remain usable until the cache expires, based on the TTL (Time-To-Live) configured for the realm. responses: '204': description: success '404': description: not found tags: - Centrally Managed Keys /v2/api-products: post: x-speakeasy-entity-operation: terraform-resource: ApiProduct#create terraform-datasource: null operationId: create-api-product summary: Create API Product description: | An API Product packages together associated APIs and their operations, backed by thorough documentation, with the objective of making API consumption straightforward for developers. requestBody: $ref: '#/components/requestBodies/CreateAPIProductRequest' responses: '201': $ref: '#/components/responses/APIProductResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API Products '/v2/api-products/{apiProductId}/documents': parameters: - name: apiProductId in: path description: The API product identifier required: true schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a post: x-speakeasy-entity-operation: terraform-resource: APIProductDocument#create terraform-datasource: null operationId: create-api-product-document summary: Create API Product Document description: Creates a document for an API product. requestBody: $ref: '#/components/requestBodies/CreateAPIProductDocumentRequest' responses: '201': $ref: '#/components/responses/APIProductDocumentResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' '409': $ref: '#/components/responses/SlugConflict' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API Product Documentation '/v2/api-products/{apiProductId}/documents/{id}': parameters: - name: apiProductId in: path description: The API product identifier required: true schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a - name: id in: path description: The document identifier related to the API product required: true schema: type: string format: uuid example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb get: x-speakeasy-entity-operation: terraform-resource: APIProductDocument#read terraform-datasource: null operationId: get-api-product-document summary: Fetch API Product Document description: Returns a document for the API product. responses: '200': $ref: '#/components/responses/APIProductDocumentResponse' '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' tags: - API Product Documentation patch: x-speakeasy-entity-operation: terraform-resource: APIProductDocument#update terraform-datasource: null operationId: update-api-product-document summary: Update an API Product Document description: Updates a document for an API product. requestBody: $ref: '#/components/requestBodies/UpdateAPIProductDocumentRequest' responses: '200': $ref: '#/components/responses/APIProductDocumentResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' '409': $ref: '#/components/responses/SlugConflict' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API Product Documentation delete: x-speakeasy-entity-operation: terraform-resource: APIProductDocument#delete terraform-datasource: null operationId: delete-api-product-document summary: Delete API Product Documentation description: Removes a document from an API product. responses: '204': description: Document for the API product was deleted successfully. '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' tags: - API Product Documentation '/v2/api-products/{apiProductId}/product-versions': parameters: - name: apiProductId in: path description: The API Product ID required: true schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a post: x-speakeasy-entity-operation: terraform-resource: ApiProductVersion#create terraform-datasource: null operationId: create-api-product-version summary: Create API Product Version description: Creates a version of an API product. requestBody: $ref: '#/components/requestBodies/CreateAPIProductVersionRequest' responses: '201': $ref: '#/components/responses/APIProductVersionResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' '409': $ref: '#/components/responses/ApiProductImplementationConflict' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API Product Versions '/v2/api-products/{apiProductId}/product-versions/{apiProductVersionId}/specifications': parameters: - name: apiProductId in: path description: The API product identifier required: true schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a - name: apiProductVersionId in: path description: The API product version identifier required: true schema: type: string format: uuid example: 9f5061ce-78f6-4452-9108-ad7c02821fd5 post: x-speakeasy-entity-operation: terraform-resource: APIProductSpecification#create terraform-datasource: null operationId: create-api-product-version-spec summary: Create API Product Version Specification description: | Creates a specification for a version of an API product. **Note:** You can only have one specification for a product version. requestBody: $ref: '#/components/requestBodies/CreateAPIProductVersionSpecRequest' responses: '201': $ref: '#/components/responses/APIProductVersionSpecResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' '409': $ref: '#/components/responses/VersionSpecConflict' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API Product Version Specification '/v2/api-products/{apiProductId}/product-versions/{apiProductVersionId}/specifications/{specificationId}': parameters: - name: apiProductId in: path description: The API product identifier required: true schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a - name: apiProductVersionId in: path description: The API product version identifier required: true schema: type: string format: uuid example: 9f5061ce-78f6-4452-9108-ad7c02821fd5 - name: specificationId in: path description: The API product version specification identifier required: true schema: type: string format: uuid example: 742ff9f1-fb89-4aeb-a599-f0e278c7aeaa x-speakeasy-match: id get: x-speakeasy-entity-operation: terraform-resource: APIProductSpecification#read terraform-datasource: null operationId: get-api-product-version-spec summary: Fetch API Product Version Specification description: Returns a specification for the version of an API product. responses: '200': $ref: '#/components/responses/APIProductVersionSpecResponse' '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' tags: - API Product Version Specification patch: x-speakeasy-entity-operation: terraform-resource: APIProductSpecification#update terraform-datasource: null operationId: update-api-product-version-spec summary: Update an API Product Version Specification description: Updates a specification from an API product version. requestBody: $ref: '#/components/requestBodies/UpdateAPIProductVersionSpecRequest' responses: '200': $ref: '#/components/responses/APIProductVersionSpecResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' '409': $ref: '#/components/responses/VersionSpecHiddenConflict' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API Product Version Specification delete: x-speakeasy-entity-operation: terraform-resource: APIProductSpecification#delete terraform-datasource: null operationId: delete-api-product-version-spec summary: Delete API Product Version Specification description: Removes a specification from a verion of an API product. responses: '204': description: Specification for the version of an API product was deleted successfully. '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' tags: - API Product Version Specification '/v2/api-products/{apiProductId}/product-versions/{id}': parameters: - name: apiProductId in: path description: The API product identifier required: true schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a - name: id in: path description: The API product version identifier required: true schema: type: string format: uuid example: 9f5061ce-78f6-4452-9108-ad7c02821fd5 get: x-speakeasy-entity-operation: terraform-resource: ApiProductVersion#read terraform-datasource: null operationId: get-api-product-version summary: Fetch API Product Version description: Returns a version of an API product. responses: '200': $ref: '#/components/responses/APIProductVersionResponse' '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' tags: - API Product Versions patch: x-speakeasy-entity-operation: terraform-resource: ApiProductVersion#update terraform-datasource: null operationId: update-api-product-version summary: Update an API Product Version description: Updates an API product version. requestBody: $ref: '#/components/requestBodies/UpdateAPIProductVersionRequest' responses: '200': $ref: '#/components/responses/APIProductVersionResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' '409': $ref: '#/components/responses/ApiProductImplementationConflict' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API Product Versions delete: x-speakeasy-entity-operation: terraform-resource: ApiProductVersion#delete terraform-datasource: null operationId: delete-api-product-version summary: Delete API Product Version description: Removes an API product version. responses: '204': description: API product version was deleted successfully. '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' tags: - API Product Versions '/v2/api-products/{id}': parameters: - name: id in: path description: API product identifier required: true schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a get: x-speakeasy-entity-operation: terraform-resource: ApiProduct#read terraform-datasource: null operationId: get-api-product summary: Fetch API product description: Returns an API product. responses: '200': $ref: '#/components/responses/APIProductResponse' '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' tags: - API Products patch: x-speakeasy-entity-operation: terraform-resource: ApiProduct#update terraform-datasource: null operationId: update-api-product summary: Update an individual API product description: Updates an API product. requestBody: $ref: '#/components/requestBodies/UpdateAPIProductRequest' responses: '200': $ref: '#/components/responses/APIProductResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API Products delete: x-speakeasy-entity-operation: terraform-resource: ApiProduct#delete terraform-datasource: null operationId: delete-api-product summary: Delete API Product description: Removes an individual API product. responses: '204': description: API product was deleted successfully. '401': $ref: '#/components/responses/ApiProductUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ApiProductNotFound' tags: - API Products /v2/application-auth-strategies: post: x-speakeasy-entity-operation: terraform-resource: ApplicationAuthStrategy#create terraform-datasource: null operationId: create-app-auth-strategy summary: Create App Auth Strategy description: Creates an application auth strategy. requestBody: $ref: '#/components/requestBodies/CreateAppAuthStrategy' responses: '201': $ref: '#/components/responses/CreateAppAuthStrategy' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - App Auth Strategies '/v2/application-auth-strategies/{authStrategyId}': parameters: - $ref: '#/components/parameters/AuthStrategyId' get: x-speakeasy-entity-operation: terraform-resource: ApplicationAuthStrategy#read terraform-datasource: null operationId: get-app-auth-strategy summary: Get App Auth Strategy description: Returns an application auth strategy. responses: '200': $ref: '#/components/responses/GetAppAuthStrategy' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - App Auth Strategies patch: x-speakeasy-entity-operation: terraform-resource: ApplicationAuthStrategy#update terraform-datasource: null operationId: update-app-auth-strategy summary: Update App Auth Strategy description: Updates an application auth strategy. requestBody: $ref: '#/components/requestBodies/UpdateAppAuthStrategy' responses: '200': $ref: '#/components/responses/UpdateAppAuthStrategy' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - App Auth Strategies delete: x-speakeasy-entity-operation: terraform-resource: ApplicationAuthStrategy#delete terraform-datasource: null operationId: delete-app-auth-strategy summary: Delete App Auth Strategy description: Deletes an application auth strategy. An application auth strategy can be deleted ONLY if it's not used by any product version within any portal regardless of their publication statuses. If an application auth strategy is still in use the request will result in an HTTP 409 CONFLICT. responses: '204': description: No Content. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' tags: - App Auth Strategies /v2/audit-log-destinations: post: x-speakeasy-entity-operation: terraform-resource: AuditLogDestination#create terraform-datasource: null operationId: create-audit-log-destination summary: Create Audit Log Destination description: Creates a configuration for the audit log destination. requestBody: $ref: '#/components/requestBodies/CreateAuditLogDestination' responses: '201': $ref: '#/components/responses/AuditLogDestinationSingle' '400': $ref: '#/components/responses/AuditLogDestinationBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - Audit Logs '/v2/audit-log-destinations/{auditLogDestinationId}': parameters: - $ref: '#/components/parameters/AuditLogDestinationId' get: x-speakeasy-entity-operation: terraform-resource: AuditLogDestination#read terraform-datasource: null operationId: get-audit-log-destination summary: Get Audit Log Destination description: Returns configuration for the audit log destination. responses: '200': $ref: '#/components/responses/AuditLogDestinationSingle' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Audit Logs patch: x-speakeasy-entity-operation: terraform-resource: AuditLogDestination#update terraform-datasource: null operationId: update-audit-log-destination summary: Update Audit Log Destination description: Updates configuration for the audit log destination. requestBody: $ref: '#/components/requestBodies/UpdateAuditLogDestination' responses: '200': $ref: '#/components/responses/AuditLogDestinationSingle' '400': $ref: '#/components/responses/AuditLogDestinationBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Audit Logs delete: x-speakeasy-entity-operation: terraform-resource: AuditLogDestination#delete terraform-datasource: null operationId: delete-audit-log-destination summary: Delete Audit Log Destination description: Deletes configuration for the audit log destination. responses: '204': description: No Content '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' tags: - Audit Logs /v2/audit-log-webhook: patch: x-speakeasy-entity-operation: terraform-resource: - AuditLog#create - AuditLog#update terraform-datasource: null operationId: update-audit-log-webhook summary: Update Audit Log Webhook description: Updates the configuration for a webhook to receive audit logs. requestBody: $ref: '#/components/requestBodies/UpdateAuditLogWebhook' responses: '200': $ref: '#/components/responses/AuditLogWebhook' '400': $ref: '#/components/responses/WebhookBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - Audit Logs get: x-speakeasy-entity-operation: terraform-resource: AuditLog#read terraform-datasource: null operationId: get-audit-log-webhook summary: Get Audit Log Webhook description: Returns configuration for the audit log webhook. responses: '200': $ref: '#/components/responses/AuditLogWebhook' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - Audit Logs /v2/cloud-gateways/configurations: put: x-speakeasy-entity-operation: terraform-resource: 'CloudGatewayConfiguration#create,update' terraform-datasource: null operationId: create-configuration summary: Create Configuration description: | Creates a new configuration for a control-plane (restricted by permitted control-plane permissions for configurations). This request will replace any existing configuration for the requested control_plane_id and control_plane_geo by performing a diff. From this diff, new resources detected in the requested configuration will be added, resources not found in the request configuration but in the previous will be deleted, and resources found in both will be updated to the requested configuration. Networks referenced in this request that are in an offline state will automatically initialize (i.e. move to an initializing state). requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateConfigurationRequest' responses: '200': $ref: '#/components/responses/CreateConfigurationResponse' '400': $ref: '#/components/responses/CloudGatewaysBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/CloudGatewaysForbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/CloudGatewaysConflict' servers: - url: 'https://global.api.konghq.com/' tags: - Data-Plane Group Configurations x-speakeasy-group: CloudGateways '/v2/cloud-gateways/configurations/{configurationId}': get: x-speakeasy-entity-operation: terraform-resource: CloudGatewayConfiguration#get terraform-datasource: null operationId: get-configuration summary: Get Configuration description: Retrieves a configuration by ID (restricted by permitted control-plane read). parameters: - $ref: '#/components/parameters/ConfigurationId' responses: '200': $ref: '#/components/responses/RetrieveConfigurationResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Data-Plane Group Configurations x-speakeasy-group: CloudGateways /v2/cloud-gateways/custom-domains: post: x-speakeasy-entity-operation: terraform-resource: CloudGatewayCustomDomain#create terraform-datasource: null operationId: create-custom-domains summary: Create Custom Domain description: | Creates a new custom domain for a control-plane (restricted by permitted control-plane associate-custom-domain action). requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCustomDomainRequest' responses: '201': $ref: '#/components/responses/CreateCustomDomainResponse' '400': $ref: '#/components/responses/CloudGatewaysBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' servers: - url: 'https://global.api.konghq.com/' tags: - Custom Domains x-speakeasy-group: CloudGateways '/v2/cloud-gateways/custom-domains/{customDomainId}': get: x-speakeasy-entity-operation: terraform-resource: CloudGatewayCustomDomain#read terraform-datasource: null operationId: get-custom-domain summary: Get Custom Domain description: Retrieves a custom domain by ID (restricted by permitted control-plane reads). parameters: - $ref: '#/components/parameters/CustomDomainId' responses: '200': $ref: '#/components/responses/RetrieveCustomDomainResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Custom Domains x-speakeasy-group: CloudGateways delete: x-speakeasy-entity-operation: terraform-resource: CloudGatewayCustomDomain#delete terraform-datasource: null operationId: delete-custom-domain summary: Delete Custom Domain description: Deletes a custom domain by ID (restricted by permitted control-plane reads). parameters: - $ref: '#/components/parameters/CustomDomainId' responses: '204': description: No Content '400': $ref: '#/components/responses/CloudGatewaysBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Custom Domains x-speakeasy-group: CloudGateways x-speakeasy-retries: strategy: backoff backoff: initialInterval: 10000 maxInterval: 60000 maxElapsedTime: 1800000 exponent: 1.5 statusCodes: - 400 retryConnectionErrors: false /v2/cloud-gateways/networks: post: x-speakeasy-entity-operation: terraform-resource: CloudGatewayNetwork#create terraform-datasource: null operationId: create-network summary: Create Network description: Creates a new network for a given provider account. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateNetworkRequest' responses: '201': $ref: '#/components/responses/CreateNetworkResponse' '400': $ref: '#/components/responses/CloudGatewaysBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/CloudGatewaysForbidden' '409': $ref: '#/components/responses/Conflict' servers: - url: 'https://global.api.konghq.com/' tags: - Networks x-speakeasy-group: CloudGateways '/v2/cloud-gateways/networks/{networkId}': get: x-speakeasy-entity-operation: terraform-resource: CloudGatewayNetwork#read terraform-datasource: null operationId: get-network summary: Get Network description: Retrieves a network by ID. parameters: - $ref: '#/components/parameters/NetworkId' responses: '200': $ref: '#/components/responses/RetrieveNetworkResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Networks x-speakeasy-group: CloudGateways patch: x-speakeasy-entity-operation: terraform-resource: CloudGatewayNetwork#update terraform-datasource: null operationId: update-network summary: Update Network description: Updates a network by ID. parameters: - $ref: '#/components/parameters/NetworkId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PatchNetworkRequest' responses: '200': $ref: '#/components/responses/PatchNetworkResponse' '400': $ref: '#/components/responses/CloudGatewaysBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/CloudGatewaysForbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' servers: - url: 'https://global.api.konghq.com/' tags: - Networks x-speakeasy-group: CloudGateways delete: x-speakeasy-entity-operation: terraform-resource: CloudGatewayNetwork#delete terraform-datasource: null operationId: delete-network summary: Delete Network description: Deletes a network by ID. parameters: - $ref: '#/components/parameters/NetworkId' responses: '204': description: No Content '400': $ref: '#/components/responses/CloudGatewaysBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Networks x-speakeasy-group: CloudGateways x-speakeasy-retries: strategy: backoff backoff: initialInterval: 10000 maxInterval: 60000 maxElapsedTime: 1800000 exponent: 1.5 statusCodes: - 400 retryConnectionErrors: false '/v2/cloud-gateways/networks/{networkId}/private-dns': post: x-speakeasy-entity-operation: terraform-resource: CloudGatewayPrivateDns#create terraform-datasource: null operationId: create-private-dns summary: Create Private DNS description: Creates a new Private DNS for a given network. parameters: - name: networkId in: path description: The network to operate on. required: true schema: $ref: '#/components/schemas/NetworkId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePrivateDnsRequest' responses: '201': $ref: '#/components/responses/CreatePrivateDnsResponse' '400': $ref: '#/components/responses/CloudGatewaysBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' servers: - url: 'https://global.api.konghq.com/' tags: - Private DNS x-speakeasy-group: CloudGateways x-speakeasy-retries: strategy: backoff backoff: initialInterval: 30000 maxInterval: 60000 maxElapsedTime: 3600000 exponent: 1.5 statusCodes: - 400 retryConnectionErrors: false '/v2/cloud-gateways/networks/{networkId}/private-dns/{privateDnsId}': get: x-speakeasy-entity-operation: terraform-resource: CloudGatewayPrivateDns#read terraform-datasource: null operationId: get-private-dns summary: Get Private DNS description: Retrieves a Private DNS by ID for a given network. parameters: - name: networkId in: path description: The network to operate on. required: true schema: $ref: '#/components/schemas/NetworkId' - $ref: '#/components/parameters/PrivateDnsId' responses: '200': $ref: '#/components/responses/RetrievePrivateDnsResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Private DNS x-speakeasy-group: CloudGateways patch: x-speakeasy-entity-operation: terraform-resource: CloudGatewayPrivateDns#update terraform-datasource: null operationId: update-private-dns summary: Update Private DNS description: Updates a Private DNS by ID for a given network. parameters: - name: networkId in: path description: The network to operate on. required: true schema: $ref: '#/components/schemas/NetworkId' - $ref: '#/components/parameters/PrivateDnsId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PatchPrivateDnsRequest' responses: '200': $ref: '#/components/responses/PatchPrivateDnsResponse' '400': $ref: '#/components/responses/CloudGatewaysBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' servers: - url: 'https://global.api.konghq.com/' tags: - Private DNS x-speakeasy-group: CloudGateways delete: x-speakeasy-entity-operation: terraform-resource: CloudGatewayPrivateDns#delete terraform-datasource: null operationId: delete-private-dns summary: Delete Private DNS description: Deletes a Private DNS by ID for a given network. parameters: - name: networkId in: path description: The network to operate on. required: true schema: $ref: '#/components/schemas/NetworkId' - $ref: '#/components/parameters/PrivateDnsId' responses: '204': description: No Content '400': $ref: '#/components/responses/CloudGatewaysBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Private DNS x-speakeasy-group: CloudGateways x-speakeasy-retries: strategy: backoff backoff: initialInterval: 10000 maxInterval: 60000 maxElapsedTime: 1800000 exponent: 1.5 statusCodes: - 400 retryConnectionErrors: false '/v2/cloud-gateways/networks/{networkId}/transit-gateways': post: x-speakeasy-entity-operation: terraform-resource: CloudGatewayTransitGateway#create terraform-datasource: null operationId: create-transit-gateway summary: Create Transit Gateway description: Creates a new transit gateway for a given network. parameters: - name: networkId in: path description: The network to operate on. required: true schema: $ref: '#/components/schemas/NetworkId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateTransitGatewayRequest' responses: '201': $ref: '#/components/responses/CreateTransitGatewayResponse' '400': $ref: '#/components/responses/CloudGatewaysBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' servers: - url: 'https://global.api.konghq.com/' tags: - Transit Gateways x-speakeasy-group: CloudGateways x-speakeasy-retries: strategy: backoff backoff: initialInterval: 30000 maxInterval: 60000 maxElapsedTime: 3600000 exponent: 1.5 statusCodes: - 400 retryConnectionErrors: false '/v2/cloud-gateways/networks/{networkId}/transit-gateways/{transitGatewayId}': get: x-speakeasy-entity-operation: terraform-resource: CloudGatewayTransitGateway#read terraform-datasource: null operationId: get-transit-gateway summary: Get Transit Gateway description: Retrieves a transit gateway by ID for a given network. parameters: - name: networkId in: path description: The network to operate on. required: true schema: $ref: '#/components/schemas/NetworkId' - $ref: '#/components/parameters/TransitGatewayId' responses: '200': $ref: '#/components/responses/RetrieveTransitGatewayResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Transit Gateways x-speakeasy-group: CloudGateways delete: x-speakeasy-entity-operation: terraform-resource: CloudGatewayTransitGateway#delete terraform-datasource: null operationId: delete-transit-gateway summary: Delete Transit Gateway description: Deletes a transit gateway by ID for a given network. parameters: - name: networkId in: path description: The network to operate on. required: true schema: $ref: '#/components/schemas/NetworkId' - $ref: '#/components/parameters/TransitGatewayId' responses: '204': description: No Content '400': $ref: '#/components/responses/CloudGatewaysBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Transit Gateways x-speakeasy-group: CloudGateways x-speakeasy-retries: strategy: backoff backoff: initialInterval: 10000 maxInterval: 60000 maxElapsedTime: 1800000 exponent: 1.5 statusCodes: - 400 retryConnectionErrors: false /v2/cloud-gateways/provider-accounts: get: x-speakeasy-entity-operation: CloudGatewayProviderAccountList#read operationId: list-provider-accounts summary: List Provider Accounts description: Returns a a paginated collection of provider accounts for an organization. parameters: - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/PageNumber' responses: '200': $ref: '#/components/responses/ListProviderAccountsResponse' '400': $ref: '#/components/responses/CloudGatewaysBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' servers: - url: 'https://global.api.konghq.com/' tags: - Provider Accounts x-speakeasy-group: CloudGateways /v2/control-planes: get: x-speakeasy-entity-operation: GatewayControlPlaneList#read operationId: list-control-planes summary: List Control Planes description: Returns an array of control plane objects containing information about the Konnect Control Planes. parameters: - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/ControlPlaneFilter' - $ref: '#/components/parameters/FilterByLabels' - $ref: '#/components/parameters/ControlPlaneSort' responses: '200': $ref: '#/components/responses/ListControlPlanesResponse' '400': $ref: '#/components/responses/ControlPlanesBadRequest' '401': $ref: '#/components/responses/ControlPlaneUnauthenticated' '403': $ref: '#/components/responses/ControlPlanePermissionDenied' '500': $ref: '#/components/responses/Internal' '503': $ref: '#/components/responses/ServiceUnavailable' tags: - Control Planes parameters: [] post: x-speakeasy-entity-operation: terraform-resource: GatewayControlPlane#create terraform-datasource: null operationId: create-control-plane summary: Create Control Plane description: Create a control plane in the Konnect Organization. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateControlPlaneRequest' responses: '201': $ref: '#/components/responses/CreateControlPlaneResponse' '400': $ref: '#/components/responses/ControlPlanesBadRequest' '401': $ref: '#/components/responses/ControlPlaneUnauthenticated' '403': $ref: '#/components/responses/ControlPlanePermissionDenied' '409': $ref: '#/components/responses/ControlPlaneConflict' '500': $ref: '#/components/responses/InternalServerError' '503': $ref: '#/components/responses/ServiceUnavailable' tags: - Control Planes '/v2/control-planes/{controlPlaneId}/config-stores': post: x-speakeasy-entity-operation: terraform-resource: GatewayConfigStore#create terraform-datasource: null operationId: create-config-store summary: Create Config Store description: Create a Config Store parameters: - $ref: '#/components/parameters/controlPlaneId' requestBody: $ref: '#/components/requestBodies/CreateConfigStoreRequest' responses: '201': $ref: '#/components/responses/ConfigStoreResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ConfigStoreUnauthorized' '403': $ref: '#/components/responses/Forbidden' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - Config Stores '/v2/control-planes/{controlPlaneId}/config-stores/{configStoreId}': parameters: - $ref: '#/components/parameters/controlPlaneId' - $ref: '#/components/parameters/configStoreId' get: x-speakeasy-entity-operation: terraform-resource: GatewayConfigStore#read terraform-datasource: null operationId: get-config-store summary: Fetch Config Store description: Returns a Config Store responses: '200': $ref: '#/components/responses/ConfigStoreResponse' '401': $ref: '#/components/responses/ConfigStoreUnauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - Config Stores put: x-speakeasy-entity-operation: terraform-resource: GatewayConfigStore#update terraform-datasource: null operationId: update-config-store summary: Update an individual Config Store description: Updates a Config Store requestBody: $ref: '#/components/requestBodies/UpdateConfigStoreRequest' responses: '200': $ref: '#/components/responses/ConfigStoreResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ConfigStoreUnauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/ConfigStoreNotFound' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - Config Stores delete: x-speakeasy-entity-operation: terraform-resource: GatewayConfigStore#delete terraform-datasource: null operationId: delete-config-store summary: Delete Config Store description: Removes a config store parameters: - name: force in: query description: '[Overlay change] Always cascade delete when being managed with declarative configuation' required: true schema: type: string const: 'true' responses: '204': description: Config Store was deleted successfully. '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ConfigStoreUnauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - Config Stores '/v2/control-planes/{controlPlaneId}/core-entities/ca_certificates': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayCACertificate#create operationId: create-ca_certificate summary: Create a new CA Certificate description: Create a new CA Certificate requestBody: description: Description of the new CA Certificate for creation required: true content: application/json: schema: $ref: '#/components/schemas/CACertificate' responses: '201': description: Successfully created CA Certificate content: application/json: schema: $ref: '#/components/schemas/CACertificate' '401': $ref: '#/components/responses/HTTP401Error' tags: - CA Certificates '/v2/control-planes/{controlPlaneId}/core-entities/ca_certificates/{CACertificateId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayCACertificate#delete operationId: delete-ca_certificate summary: Delete a CA Certificate description: Delete a CA Certificate parameters: - $ref: '#/components/parameters/CACertificateId' responses: '204': description: Successfully deleted CA Certificate or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - CA Certificates get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayCACertificate#read operationId: get-ca_certificate summary: Fetch a CA Certificate description: Get a CA Certificate using ID. responses: '200': description: Successfully fetched CA Certificate content: application/json: schema: $ref: '#/components/schemas/CACertificate' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - CA Certificates parameters: - $ref: '#/components/parameters/CACertificateId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayCACertificate#update operationId: upsert-ca_certificate summary: Upsert a CA Certificate description: Create or Update CA Certificate using ID. requestBody: description: Description of the CA Certificate required: true content: application/json: schema: $ref: '#/components/schemas/CACertificate' responses: '200': description: Successfully upserted CA Certificate content: application/json: schema: $ref: '#/components/schemas/CACertificate' '401': $ref: '#/components/responses/HTTP401Error' tags: - CA Certificates '/v2/control-planes/{controlPlaneId}/core-entities/certificates': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayCertificate#create operationId: create-certificate summary: Create a new Certificate description: Create a new Certificate requestBody: description: Description of the new Certificate for creation required: true content: application/json: schema: $ref: '#/components/schemas/Certificate' responses: '201': description: Successfully created Certificate content: application/json: schema: $ref: '#/components/schemas/Certificate' '401': $ref: '#/components/responses/HTTP401Error' tags: - Certificates '/v2/control-planes/{controlPlaneId}/core-entities/certificates/{CertificateId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayCertificate#delete operationId: delete-certificate summary: Delete a Certificate description: Delete a Certificate parameters: - $ref: '#/components/parameters/CertificateId' responses: '204': description: Successfully deleted Certificate or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Certificates get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayCertificate#read operationId: get-certificate summary: Fetch a Certificate description: Get a Certificate using ID. responses: '200': description: Successfully fetched Certificate content: application/json: schema: $ref: '#/components/schemas/Certificate' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Certificates parameters: - $ref: '#/components/parameters/CertificateId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayCertificate#update operationId: upsert-certificate summary: Upsert a Certificate description: Create or Update Certificate using ID. requestBody: description: Description of the Certificate required: true content: application/json: schema: $ref: '#/components/schemas/Certificate' responses: '200': description: Successfully upserted Certificate content: application/json: schema: $ref: '#/components/schemas/Certificate' '401': $ref: '#/components/responses/HTTP401Error' tags: - Certificates '/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayConsumerGroup#create operationId: create-consumer_group summary: Create a new Consumer Group description: Create a new Consumer Group requestBody: description: Description of the new Consumer Group for creation required: true content: application/json: schema: $ref: '#/components/schemas/ConsumerGroup' responses: '201': description: Successfully created Consumer Group content: application/json: schema: $ref: '#/components/schemas/ConsumerGroup' '401': $ref: '#/components/responses/HTTP401Error' tags: - Consumer Groups '/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayConsumerGroup#delete operationId: delete-consumer_group summary: Delete a Consumer Group description: Delete a Consumer Group parameters: - $ref: '#/components/parameters/ConsumerGroupId' responses: '204': description: Successfully deleted Consumer Group or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Consumer Groups get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayConsumerGroup#read operationId: get-consumer_group summary: Fetch a Consumer Group description: Get a Consumer Group using ID. responses: '200': description: Successfully fetched Consumer Group content: application/json: schema: $ref: '#/components/schemas/ConsumerGroupInsideWrapper' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Consumer Groups parameters: - $ref: '#/components/parameters/ConsumerGroupId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayConsumerGroup#update operationId: upsert-consumer_group summary: Upsert a Consumer Group description: Create or Update Consumer Group using ID. requestBody: description: Description of the Consumer Group required: true content: application/json: schema: $ref: '#/components/schemas/ConsumerGroup' responses: '200': description: Successfully upserted Consumer Group content: application/json: schema: $ref: '#/components/schemas/ConsumerGroup' '401': $ref: '#/components/responses/HTTP401Error' tags: - Consumer Groups '/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers': parameters: - $ref: '#/components/parameters/ConsumerGroupIdManageConsumers' - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: GatewayConsumerGroupMember#create operationId: add-consumer-to-group summary: Add consumer to consumer group description: Add a consumer to a consumer group requestBody: content: application/json: schema: type: object properties: consumer: type: string example: cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b x-speakeasy-name-override: consumer_id responses: '201': description: Consumer added to group tags: - Consumer Groups '/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers/{ConsumerId}': delete: x-speakeasy-entity-operation: GatewayConsumerGroupMember#delete operationId: remove-consumer-from-group summary: Remove consumer from consumer group description: Remove a consumer from a consumer group responses: '204': description: Consumer removed from group tags: - Consumer Groups parameters: - $ref: '#/components/parameters/ConsumerGroupIdManageConsumers' - name: ConsumerId in: path required: true schema: type: string - $ref: '#/components/parameters/controlPlaneId' '/v2/control-planes/{controlPlaneId}/core-entities/consumers': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayConsumer#create operationId: create-consumer summary: Create a new Consumer description: Create a new Consumer requestBody: description: Description of the new Consumer for creation required: true content: application/json: schema: $ref: '#/components/schemas/Consumer' responses: '201': description: Successfully created Consumer content: application/json: schema: $ref: '#/components/schemas/Consumer' '401': $ref: '#/components/responses/HTTP401Error' tags: - Consumers '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayConsumer#delete operationId: delete-consumer summary: Delete a Consumer description: Delete a Consumer parameters: - $ref: '#/components/parameters/ConsumerId' responses: '204': description: Successfully deleted Consumer or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Consumers get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayConsumer#read operationId: get-consumer summary: Fetch a Consumer description: Get a Consumer using ID or username. responses: '200': description: Successfully fetched Consumer content: application/json: schema: $ref: '#/components/schemas/Consumer' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Consumers parameters: - $ref: '#/components/parameters/ConsumerId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayConsumer#update operationId: upsert-consumer summary: Upsert a Consumer description: Create or Update Consumer using ID or username. requestBody: description: Description of the Consumer required: true content: application/json: schema: $ref: '#/components/schemas/Consumer' responses: '200': description: Successfully upserted Consumer content: application/json: schema: $ref: '#/components/schemas/Consumer' '401': $ref: '#/components/responses/HTTP401Error' tags: - Consumers '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/acls': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayACL#create operationId: create-acl-with-consumer summary: Create a new ACL associated with a Consumer description: Create a new ACL associated with a Consumer parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' requestBody: description: Description of new ACL for creation required: true content: application/json: schema: $ref: '#/components/schemas/ACLWithoutParents' responses: '201': description: Successfully created ACL content: application/json: schema: $ref: '#/components/schemas/ACL' tags: - ACLs '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/acls/{ACLId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayACL#delete operationId: delete-acl-with-consumer summary: Delete a an ACL associated with a Consumer description: Delete a an ACL associated with a Consumer using ID. parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' - $ref: '#/components/parameters/ACLId' responses: '204': description: Successfully deleted ACL or the resource didn't exist tags: - ACLs get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayACL#read operationId: get-acl-with-consumer summary: Fetch an ACL associated with a Consumer description: Get an ACL associated with a Consumer using ID. parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' - $ref: '#/components/parameters/ACLId' responses: '200': description: Successfully fetched ACL content: application/json: schema: $ref: '#/components/schemas/ACL' '404': description: Resource does not exist tags: - ACLs parameters: - $ref: '#/components/parameters/controlPlaneId' '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/basic-auth': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayBasicAuth#create operationId: create-basic-auth-with-consumer summary: Create a new Basic-auth credential associated with a Consumer description: Create a new Basic-auth credential associated with a Consumer parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' requestBody: description: Description of new Basic-auth credential for creation required: true content: application/json: schema: $ref: '#/components/schemas/BasicAuthWithoutParents' responses: '201': description: Successfully created Basic-auth credential content: application/json: schema: $ref: '#/components/schemas/BasicAuth' tags: - Basic-auth credentials '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/basic-auth/{BasicAuthId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayBasicAuth#delete operationId: delete-basic-auth-with-consumer summary: Delete a a Basic-auth credential associated with a Consumer description: Delete a a Basic-auth credential associated with a Consumer using ID. parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' - $ref: '#/components/parameters/BasicAuthId' responses: '204': description: Successfully deleted Basic-auth credential or the resource didn't exist tags: - Basic-auth credentials get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayBasicAuth#read operationId: get-basic-auth-with-consumer summary: Fetch a Basic-auth credential associated with a Consumer description: Get a Basic-auth credential associated with a Consumer using ID. parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' - $ref: '#/components/parameters/BasicAuthId' responses: '200': description: Successfully fetched Basic-auth credential content: application/json: schema: $ref: '#/components/schemas/BasicAuth' '404': description: Resource does not exist tags: - Basic-auth credentials parameters: - $ref: '#/components/parameters/controlPlaneId' '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/hmac-auth': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayHMACAuth#create operationId: create-hmac-auth-with-consumer summary: Create a new HMAC-auth credential associated with a Consumer description: Create a new HMAC-auth credential associated with a Consumer parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' requestBody: description: Description of new HMAC-auth credential for creation required: true content: application/json: schema: $ref: '#/components/schemas/HMACAuthWithoutParents' responses: '201': description: Successfully created HMAC-auth credential content: application/json: schema: $ref: '#/components/schemas/HMACAuth' tags: - HMAC-auth credentials '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/hmac-auth/{HMACAuthId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayHMACAuth#delete operationId: delete-hmac-auth-with-consumer summary: Delete a a HMAC-auth credential associated with a Consumer description: Delete a a HMAC-auth credential associated with a Consumer using ID. parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' - $ref: '#/components/parameters/HMACAuthId' responses: '204': description: Successfully deleted HMAC-auth credential or the resource didn't exist tags: - HMAC-auth credentials get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayHMACAuth#read operationId: get-hmac-auth-with-consumer summary: Fetch a HMAC-auth credential associated with a Consumer description: Get a HMAC-auth credential associated with a Consumer using ID. parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' - $ref: '#/components/parameters/HMACAuthId' responses: '200': description: Successfully fetched HMAC-auth credential content: application/json: schema: $ref: '#/components/schemas/HMACAuth' '404': description: Resource does not exist tags: - HMAC-auth credentials parameters: - $ref: '#/components/parameters/controlPlaneId' '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/jwt': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayJWT#create operationId: create-jwt-with-consumer summary: Create a new JWT associated with a Consumer description: Create a new JWT associated with a Consumer parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' requestBody: description: Description of new JWT for creation content: application/json: schema: $ref: '#/components/schemas/JWTWithoutParents' responses: '201': description: Successfully created JWT content: application/json: schema: $ref: '#/components/schemas/JWT' tags: - JWTs '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/jwt/{JWTId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayJWT#delete operationId: delete-jwt-with-consumer summary: Delete a a JWT associated with a Consumer description: Delete a a JWT associated with a Consumer using ID. parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' - $ref: '#/components/parameters/JWTId' responses: '204': description: Successfully deleted JWT or the resource didn't exist tags: - JWTs get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayJWT#read operationId: get-jwt-with-consumer summary: Fetch a JWT associated with a Consumer description: Get a JWT associated with a Consumer using ID. parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' - $ref: '#/components/parameters/JWTId' responses: '200': description: Successfully fetched JWT content: application/json: schema: $ref: '#/components/schemas/JWT' '404': description: Resource does not exist tags: - JWTs parameters: - $ref: '#/components/parameters/controlPlaneId' '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/key-auth': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayKeyAuth#create operationId: create-key-auth-with-consumer summary: Create a new API-key associated with a Consumer description: Create a new API-key associated with a Consumer parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' requestBody: description: Description of new API-key for creation content: application/json: schema: $ref: '#/components/schemas/KeyAuthWithoutParents' responses: '201': description: Successfully created API-key content: application/json: schema: $ref: '#/components/schemas/KeyAuth' tags: - API-keys '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/key-auth/{KeyAuthId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayKeyAuth#delete operationId: delete-key-auth-with-consumer summary: Delete a an API-key associated with a Consumer description: Delete a an API-key associated with a Consumer using ID. parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' - $ref: '#/components/parameters/KeyAuthId' responses: '204': description: Successfully deleted API-key or the resource didn't exist tags: - API-keys get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayKeyAuth#read operationId: get-key-auth-with-consumer summary: Fetch an API-key associated with a Consumer description: Get an API-key associated with a Consumer using ID. parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' - $ref: '#/components/parameters/KeyAuthId' responses: '200': description: Successfully fetched API-key content: application/json: schema: $ref: '#/components/schemas/KeyAuth' '404': description: Resource does not exist tags: - API-keys parameters: - $ref: '#/components/parameters/controlPlaneId' '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/mtls-auth': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayMTLSAuth#create operationId: create-mtls-auth-with-consumer summary: Create a new MTLS-auth credential associated with a Consumer description: Create a new MTLS-auth credential associated with a Consumer parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' requestBody: description: Description of new MTLS-auth credential for creation required: true content: application/json: schema: $ref: '#/components/schemas/MTLSAuthWithoutParents' responses: '201': description: Successfully created MTLS-auth credential content: application/json: schema: $ref: '#/components/schemas/MTLSAuth' tags: - MTLS-auth credentials '/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/mtls-auth/{MTLSAuthId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayMTLSAuth#delete operationId: delete-mtls-auth-with-consumer summary: Delete a a MTLS-auth credential associated with a Consumer description: Delete a a MTLS-auth credential associated with a Consumer using ID. parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' - $ref: '#/components/parameters/MTLSAuthId' responses: '204': description: Successfully deleted MTLS-auth credential or the resource didn't exist tags: - MTLS-auth credentials get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayMTLSAuth#read operationId: get-mtls-auth-with-consumer summary: Fetch a MTLS-auth credential associated with a Consumer description: Get a MTLS-auth credential associated with a Consumer using ID. parameters: - $ref: '#/components/parameters/ConsumerIdForNestedEntities' - $ref: '#/components/parameters/MTLSAuthId' responses: '200': description: Successfully fetched MTLS-auth credential content: application/json: schema: $ref: '#/components/schemas/MTLSAuth' '404': description: Resource does not exist tags: - MTLS-auth credentials parameters: - $ref: '#/components/parameters/controlPlaneId' '/v2/control-planes/{controlPlaneId}/core-entities/custom-plugins': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayCustomPluginStreaming#create operationId: create-custom-plugin summary: Create a new CustomPlugin description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Create a new CustomPlugin requestBody: description: Description of the new CustomPlugin for creation required: true content: application/json: schema: $ref: '#/components/schemas/CustomPlugin' responses: '201': description: Successfully created CustomPlugin content: application/json: schema: $ref: '#/components/schemas/CustomPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - CustomPlugins '/v2/control-planes/{controlPlaneId}/core-entities/custom-plugins/{CustomPluginId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayCustomPluginStreaming#delete operationId: delete-custom-plugin summary: Delete a CustomPlugin description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Delete a CustomPlugin parameters: - $ref: '#/components/parameters/CustomPluginId' responses: '204': description: Successfully deleted CustomPlugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - CustomPlugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayCustomPluginStreaming#read operationId: get-custom-plugin summary: Fetch a CustomPlugin description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Get a CustomPlugin using ID or name. responses: '200': description: Successfully fetched CustomPlugin content: application/json: schema: $ref: '#/components/schemas/CustomPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - CustomPlugins parameters: - $ref: '#/components/parameters/CustomPluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayCustomPluginStreaming#update operationId: upsert-custom-plugin summary: Upsert a CustomPlugin description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Create or Update CustomPlugin using ID or name. requestBody: description: Description of the CustomPlugin required: true content: application/json: schema: $ref: '#/components/schemas/CustomPlugin' responses: '200': description: Successfully upserted CustomPlugin content: application/json: schema: $ref: '#/components/schemas/CustomPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - CustomPlugins '/v2/control-planes/{controlPlaneId}/core-entities/key-sets': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayKeySet#create operationId: create-key-set summary: Create a new KeySet description: Create a new KeySet requestBody: description: Description of the new KeySet for creation content: application/json: schema: $ref: '#/components/schemas/KeySet' responses: '201': description: Successfully created KeySet content: application/json: schema: $ref: '#/components/schemas/KeySet' '401': $ref: '#/components/responses/HTTP401Error' tags: - KeySets '/v2/control-planes/{controlPlaneId}/core-entities/key-sets/{KeySetId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayKeySet#delete operationId: delete-key-set summary: Delete a KeySet description: Delete a KeySet parameters: - $ref: '#/components/parameters/KeySetId' responses: '204': description: Successfully deleted KeySet or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - KeySets get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayKeySet#read operationId: get-key-set summary: Fetch a KeySet description: Get a KeySet using ID or name. responses: '200': description: Successfully fetched KeySet content: application/json: schema: $ref: '#/components/schemas/KeySet' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - KeySets parameters: - $ref: '#/components/parameters/KeySetId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayKeySet#update operationId: upsert-key-set summary: Upsert a KeySet description: Create or Update KeySet using ID or name. requestBody: description: Description of the KeySet content: application/json: schema: $ref: '#/components/schemas/KeySet' responses: '200': description: Successfully upserted KeySet content: application/json: schema: $ref: '#/components/schemas/KeySet' '401': $ref: '#/components/responses/HTTP401Error' tags: - KeySets '/v2/control-planes/{controlPlaneId}/core-entities/keys': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayKey#create operationId: create-key summary: Create a new Key description: Create a new Key requestBody: description: Description of the new Key for creation required: true content: application/json: schema: $ref: '#/components/schemas/Key' responses: '201': description: Successfully created Key content: application/json: schema: $ref: '#/components/schemas/Key' '401': $ref: '#/components/responses/HTTP401Error' tags: - Keys '/v2/control-planes/{controlPlaneId}/core-entities/keys/{KeyId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayKey#delete operationId: delete-key summary: Delete a Key description: Delete a Key parameters: - $ref: '#/components/parameters/KeyId' responses: '204': description: Successfully deleted Key or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Keys get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayKey#read operationId: get-key summary: Fetch a Key description: Get a Key using ID or name. responses: '200': description: Successfully fetched Key content: application/json: schema: $ref: '#/components/schemas/Key' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Keys parameters: - $ref: '#/components/parameters/KeyId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayKey#update operationId: upsert-key summary: Upsert a Key description: Create or Update Key using ID or name. requestBody: description: Description of the Key required: true content: application/json: schema: $ref: '#/components/schemas/Key' responses: '200': description: Successfully upserted Key content: application/json: schema: $ref: '#/components/schemas/Key' '401': $ref: '#/components/responses/HTTP401Error' tags: - Keys '/v2/control-planes/{controlPlaneId}/core-entities/partials': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPartial#create operationId: create-partial summary: Create a new Partial description: Create a new Partial requestBody: description: Description of the new Partial for creation required: true content: application/json: schema: $ref: '#/components/schemas/Partial' responses: '201': description: Successfully created Partial content: application/json: schema: $ref: '#/components/schemas/Partial' '401': $ref: '#/components/responses/HTTP401Error' tags: - Partials '/v2/control-planes/{controlPlaneId}/core-entities/partials/{PartialId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPartial#delete operationId: delete-partial summary: Delete a Partial description: Delete a Partial parameters: - $ref: '#/components/parameters/PartialId' responses: '204': description: Successfully deleted Partial or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Partials get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPartial#read operationId: get-partial summary: Fetch a Partial description: Get a Partial using ID. responses: '200': description: Successfully fetched Partial content: application/json: schema: $ref: '#/components/schemas/Partial' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Partials parameters: - $ref: '#/components/parameters/PartialId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPartial#update operationId: upsert-partial summary: Upsert a Partial description: Create or Update Partial using ID. requestBody: description: Description of the Partial required: true content: application/json: schema: $ref: '#/components/schemas/Partial' responses: '200': description: Successfully upserted Partial content: application/json: schema: $ref: '#/components/schemas/Partial' '401': $ref: '#/components/responses/HTTP401Error' tags: - Partials '/v2/control-planes/{controlPlaneId}/core-entities/plugin-schemas': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-resource: GatewayCustomPluginSchema#create terraform-datasource: null operationId: create-plugin-schemas summary: Upload custom plugin schema description: Upload a custom plugin schema associated with a control plane. requestBody: $ref: '#/components/requestBodies/create-plugin-schemas' responses: '201': $ref: '#/components/responses/plugin-schemas' '400': $ref: '#/components/responses/KonnectCPLegacyBadRequest' '401': $ref: '#/components/responses/KonnectCPLegacyUnauthorized' '403': $ref: '#/components/responses/KonnectCPLegacyForbidden' '409': $ref: '#/components/responses/KonnectCPLegacyConflict' tags: - Custom Plugin Schemas '/v2/control-planes/{controlPlaneId}/core-entities/plugin-schemas/{name}': parameters: - $ref: '#/components/parameters/controlPlaneId' - name: name in: path description: The custom plugin name required: true schema: type: string example: myplugin get: x-speakeasy-entity-operation: terraform-resource: GatewayCustomPluginSchema#read terraform-datasource: null operationId: get-plugin-schema summary: Fetch 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/KonnectCPLegacyUnauthorized' '403': $ref: '#/components/responses/KonnectCPLegacyForbidden' '404': $ref: '#/components/responses/KonnectCPLegacyNotFound' tags: - Custom Plugin Schemas delete: x-speakeasy-entity-operation: terraform-resource: GatewayCustomPluginSchema#delete terraform-datasource: null 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/KonnectCPLegacyUnauthorized' '403': $ref: '#/components/responses/KonnectCPLegacyForbidden' '404': $ref: '#/components/responses/KonnectCPLegacyNotFound' tags: - Custom Plugin Schemas put: x-speakeasy-entity-operation: terraform-resource: GatewayCustomPluginSchema#update terraform-datasource: null 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' '400': $ref: '#/components/responses/KonnectCPLegacyBadRequest' '401': $ref: '#/components/responses/KonnectCPLegacyUnauthorized' '403': $ref: '#/components/responses/KonnectCPLegacyForbidden' '404': $ref: '#/components/responses/KonnectCPLegacyNotFound' tags: - Custom Plugin Schemas '/v2/control-planes/{controlPlaneId}/core-entities/plugins': parameters: - $ref: '#/components/parameters/controlPlaneId' post: operationId: create-plugin summary: Create a new Plugin description: Create a new Plugin requestBody: description: Description of the new Plugin for creation required: true content: application/json: schema: $ref: '#/components/schemas/Plugin' responses: '201': description: Successfully created Plugin content: application/json: schema: $ref: '#/components/schemas/Plugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}': delete: operationId: delete-plugin summary: Delete a Plugin description: Delete a Plugin parameters: - $ref: '#/components/parameters/PluginId' responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: operationId: get-plugin summary: Fetch a Plugin description: Get a Plugin using ID. responses: '200': description: Successfully fetched Plugin content: application/json: schema: $ref: '#/components/schemas/Plugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: operationId: upsert-plugin summary: Upsert a Plugin description: Create or Update Plugin using ID. requestBody: description: Description of the Plugin required: true content: application/json: schema: $ref: '#/components/schemas/Plugin' responses: '200': description: Successfully upserted Plugin content: application/json: schema: $ref: '#/components/schemas/Plugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#ACL': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginACL#delete operationId: delete-acl-plugin summary: Delete a ACL plugin description: Delete a ACL plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginACL#read operationId: get-acl-plugin summary: Get a ACL plugin description: Get a ACL plugin responses: '200': description: ACL plugin content: application/json: schema: $ref: '#/components/schemas/ACLPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginACL#update operationId: update-acl-plugin summary: Update a ACL plugin description: Update a ACL plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ACLPlugin' responses: '200': description: ACL plugin content: application/json: schema: $ref: '#/components/schemas/ACLPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Acme': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAcme#delete operationId: delete-acme-plugin summary: Delete a Acme plugin description: Delete a Acme plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAcme#read operationId: get-acme-plugin summary: Get a Acme plugin description: Get a Acme plugin responses: '200': description: Acme plugin content: application/json: schema: $ref: '#/components/schemas/AcmePlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAcme#update operationId: update-acme-plugin summary: Update a Acme plugin description: Update a Acme plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AcmePlugin' responses: '200': description: Acme plugin content: application/json: schema: $ref: '#/components/schemas/AcmePlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiAwsGuardrails': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiAwsGuardrails#delete operationId: delete-aiawsguardrails-plugin summary: Delete a AiAwsGuardrails plugin description: Delete a AiAwsGuardrails plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiAwsGuardrails#read operationId: get-aiawsguardrails-plugin summary: Get a AiAwsGuardrails plugin description: Get a AiAwsGuardrails plugin responses: '200': description: AiAwsGuardrails plugin content: application/json: schema: $ref: '#/components/schemas/AiAwsGuardrailsPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiAwsGuardrails#update operationId: update-aiawsguardrails-plugin summary: Update a AiAwsGuardrails plugin description: Update a AiAwsGuardrails plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiAwsGuardrailsPlugin' responses: '200': description: AiAwsGuardrails plugin content: application/json: schema: $ref: '#/components/schemas/AiAwsGuardrailsPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiAzureContentSafety': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiAzureContentSafety#delete operationId: delete-aiazurecontentsafety-plugin summary: Delete a AiAzureContentSafety plugin description: Delete a AiAzureContentSafety plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiAzureContentSafety#read operationId: get-aiazurecontentsafety-plugin summary: Get a AiAzureContentSafety plugin description: Get a AiAzureContentSafety plugin responses: '200': description: AiAzureContentSafety plugin content: application/json: schema: $ref: '#/components/schemas/AiAzureContentSafetyPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiAzureContentSafety#update operationId: update-aiazurecontentsafety-plugin summary: Update a AiAzureContentSafety plugin description: Update a AiAzureContentSafety plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiAzureContentSafetyPlugin' responses: '200': description: AiAzureContentSafety plugin content: application/json: schema: $ref: '#/components/schemas/AiAzureContentSafetyPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiPromptCompressor': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptCompressor#delete operationId: delete-aipromptcompressor-plugin summary: Delete a AiPromptCompressor plugin description: Delete a AiPromptCompressor plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptCompressor#read operationId: get-aipromptcompressor-plugin summary: Get a AiPromptCompressor plugin description: Get a AiPromptCompressor plugin responses: '200': description: AiPromptCompressor plugin content: application/json: schema: $ref: '#/components/schemas/AiPromptCompressorPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptCompressor#update operationId: update-aipromptcompressor-plugin summary: Update a AiPromptCompressor plugin description: Update a AiPromptCompressor plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiPromptCompressorPlugin' responses: '200': description: AiPromptCompressor plugin content: application/json: schema: $ref: '#/components/schemas/AiPromptCompressorPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiPromptDecorator': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptDecorator#delete operationId: delete-aipromptdecorator-plugin summary: Delete a AiPromptDecorator plugin description: Delete a AiPromptDecorator plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptDecorator#read operationId: get-aipromptdecorator-plugin summary: Get a AiPromptDecorator plugin description: Get a AiPromptDecorator plugin responses: '200': description: AiPromptDecorator plugin content: application/json: schema: $ref: '#/components/schemas/AiPromptDecoratorPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptDecorator#update operationId: update-aipromptdecorator-plugin summary: Update a AiPromptDecorator plugin description: Update a AiPromptDecorator plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiPromptDecoratorPlugin' responses: '200': description: AiPromptDecorator plugin content: application/json: schema: $ref: '#/components/schemas/AiPromptDecoratorPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiPromptGuard': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptGuard#delete operationId: delete-aipromptguard-plugin summary: Delete a AiPromptGuard plugin description: Delete a AiPromptGuard plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptGuard#read operationId: get-aipromptguard-plugin summary: Get a AiPromptGuard plugin description: Get a AiPromptGuard plugin responses: '200': description: AiPromptGuard plugin content: application/json: schema: $ref: '#/components/schemas/AiPromptGuardPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptGuard#update operationId: update-aipromptguard-plugin summary: Update a AiPromptGuard plugin description: Update a AiPromptGuard plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiPromptGuardPlugin' responses: '200': description: AiPromptGuard plugin content: application/json: schema: $ref: '#/components/schemas/AiPromptGuardPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiPromptTemplate': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptTemplate#delete operationId: delete-aiprompttemplate-plugin summary: Delete a AiPromptTemplate plugin description: Delete a AiPromptTemplate plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptTemplate#read operationId: get-aiprompttemplate-plugin summary: Get a AiPromptTemplate plugin description: Get a AiPromptTemplate plugin responses: '200': description: AiPromptTemplate plugin content: application/json: schema: $ref: '#/components/schemas/AiPromptTemplatePlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptTemplate#update operationId: update-aiprompttemplate-plugin summary: Update a AiPromptTemplate plugin description: Update a AiPromptTemplate plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiPromptTemplatePlugin' responses: '200': description: AiPromptTemplate plugin content: application/json: schema: $ref: '#/components/schemas/AiPromptTemplatePlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiProxy': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiProxy#delete operationId: delete-aiproxy-plugin summary: Delete a AiProxy plugin description: Delete a AiProxy plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiProxy#read operationId: get-aiproxy-plugin summary: Get a AiProxy plugin description: Get a AiProxy plugin responses: '200': description: AiProxy plugin content: application/json: schema: $ref: '#/components/schemas/AiProxyPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiProxy#update operationId: update-aiproxy-plugin summary: Update a AiProxy plugin description: Update a AiProxy plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiProxyPlugin' responses: '200': description: AiProxy plugin content: application/json: schema: $ref: '#/components/schemas/AiProxyPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiProxyAdvanced': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiProxyAdvanced#delete operationId: delete-aiproxyadvanced-plugin summary: Delete a AiProxyAdvanced plugin description: Delete a AiProxyAdvanced plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiProxyAdvanced#read operationId: get-aiproxyadvanced-plugin summary: Get a AiProxyAdvanced plugin description: Get a AiProxyAdvanced plugin responses: '200': description: AiProxyAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/AiProxyAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiProxyAdvanced#update operationId: update-aiproxyadvanced-plugin summary: Update a AiProxyAdvanced plugin description: Update a AiProxyAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiProxyAdvancedPlugin' responses: '200': description: AiProxyAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/AiProxyAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiRagInjector': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiRagInjector#delete operationId: delete-airaginjector-plugin summary: Delete a AiRagInjector plugin description: Delete a AiRagInjector plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiRagInjector#read operationId: get-airaginjector-plugin summary: Get a AiRagInjector plugin description: Get a AiRagInjector plugin responses: '200': description: AiRagInjector plugin content: application/json: schema: $ref: '#/components/schemas/AiRagInjectorPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiRagInjector#update operationId: update-airaginjector-plugin summary: Update a AiRagInjector plugin description: Update a AiRagInjector plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiRagInjectorPlugin' responses: '200': description: AiRagInjector plugin content: application/json: schema: $ref: '#/components/schemas/AiRagInjectorPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiRateLimitingAdvanced': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiRateLimitingAdvanced#delete operationId: delete-airatelimitingadvanced-plugin summary: Delete a AiRateLimitingAdvanced plugin description: Delete a AiRateLimitingAdvanced plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiRateLimitingAdvanced#read operationId: get-airatelimitingadvanced-plugin summary: Get a AiRateLimitingAdvanced plugin description: Get a AiRateLimitingAdvanced plugin responses: '200': description: AiRateLimitingAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/AiRateLimitingAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiRateLimitingAdvanced#update operationId: update-airatelimitingadvanced-plugin summary: Update a AiRateLimitingAdvanced plugin description: Update a AiRateLimitingAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiRateLimitingAdvancedPlugin' responses: '200': description: AiRateLimitingAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/AiRateLimitingAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiRequestTransformer': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiRequestTransformer#delete operationId: delete-airequesttransformer-plugin summary: Delete a AiRequestTransformer plugin description: Delete a AiRequestTransformer plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiRequestTransformer#read operationId: get-airequesttransformer-plugin summary: Get a AiRequestTransformer plugin description: Get a AiRequestTransformer plugin responses: '200': description: AiRequestTransformer plugin content: application/json: schema: $ref: '#/components/schemas/AiRequestTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiRequestTransformer#update operationId: update-airequesttransformer-plugin summary: Update a AiRequestTransformer plugin description: Update a AiRequestTransformer plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiRequestTransformerPlugin' responses: '200': description: AiRequestTransformer plugin content: application/json: schema: $ref: '#/components/schemas/AiRequestTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiResponseTransformer': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiResponseTransformer#delete operationId: delete-airesponsetransformer-plugin summary: Delete a AiResponseTransformer plugin description: Delete a AiResponseTransformer plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiResponseTransformer#read operationId: get-airesponsetransformer-plugin summary: Get a AiResponseTransformer plugin description: Get a AiResponseTransformer plugin responses: '200': description: AiResponseTransformer plugin content: application/json: schema: $ref: '#/components/schemas/AiResponseTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiResponseTransformer#update operationId: update-airesponsetransformer-plugin summary: Update a AiResponseTransformer plugin description: Update a AiResponseTransformer plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiResponseTransformerPlugin' responses: '200': description: AiResponseTransformer plugin content: application/json: schema: $ref: '#/components/schemas/AiResponseTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiSanitizer': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiSanitizer#delete operationId: delete-aisanitizer-plugin summary: Delete a AiSanitizer plugin description: Delete a AiSanitizer plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiSanitizer#read operationId: get-aisanitizer-plugin summary: Get a AiSanitizer plugin description: Get a AiSanitizer plugin responses: '200': description: AiSanitizer plugin content: application/json: schema: $ref: '#/components/schemas/AiSanitizerPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiSanitizer#update operationId: update-aisanitizer-plugin summary: Update a AiSanitizer plugin description: Update a AiSanitizer plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiSanitizerPlugin' responses: '200': description: AiSanitizer plugin content: application/json: schema: $ref: '#/components/schemas/AiSanitizerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiSemanticCache': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiSemanticCache#delete operationId: delete-aisemanticcache-plugin summary: Delete a AiSemanticCache plugin description: Delete a AiSemanticCache plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiSemanticCache#read operationId: get-aisemanticcache-plugin summary: Get a AiSemanticCache plugin description: Get a AiSemanticCache plugin responses: '200': description: AiSemanticCache plugin content: application/json: schema: $ref: '#/components/schemas/AiSemanticCachePlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiSemanticCache#update operationId: update-aisemanticcache-plugin summary: Update a AiSemanticCache plugin description: Update a AiSemanticCache plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiSemanticCachePlugin' responses: '200': description: AiSemanticCache plugin content: application/json: schema: $ref: '#/components/schemas/AiSemanticCachePlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiSemanticPromptGuard': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiSemanticPromptGuard#delete operationId: delete-aisemanticpromptguard-plugin summary: Delete a AiSemanticPromptGuard plugin description: Delete a AiSemanticPromptGuard plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiSemanticPromptGuard#read operationId: get-aisemanticpromptguard-plugin summary: Get a AiSemanticPromptGuard plugin description: Get a AiSemanticPromptGuard plugin responses: '200': description: AiSemanticPromptGuard plugin content: application/json: schema: $ref: '#/components/schemas/AiSemanticPromptGuardPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiSemanticPromptGuard#update operationId: update-aisemanticpromptguard-plugin summary: Update a AiSemanticPromptGuard plugin description: Update a AiSemanticPromptGuard plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiSemanticPromptGuardPlugin' responses: '200': description: AiSemanticPromptGuard plugin content: application/json: schema: $ref: '#/components/schemas/AiSemanticPromptGuardPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AwsLambda': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAwsLambda#delete operationId: delete-awslambda-plugin summary: Delete a AwsLambda plugin description: Delete a AwsLambda plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAwsLambda#read operationId: get-awslambda-plugin summary: Get a AwsLambda plugin description: Get a AwsLambda plugin responses: '200': description: AwsLambda plugin content: application/json: schema: $ref: '#/components/schemas/AwsLambdaPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAwsLambda#update operationId: update-awslambda-plugin summary: Update a AwsLambda plugin description: Update a AwsLambda plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AwsLambdaPlugin' responses: '200': description: AwsLambda plugin content: application/json: schema: $ref: '#/components/schemas/AwsLambdaPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AzureFunctions': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAzureFunctions#delete operationId: delete-azurefunctions-plugin summary: Delete a AzureFunctions plugin description: Delete a AzureFunctions plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAzureFunctions#read operationId: get-azurefunctions-plugin summary: Get a AzureFunctions plugin description: Get a AzureFunctions plugin responses: '200': description: AzureFunctions plugin content: application/json: schema: $ref: '#/components/schemas/AzureFunctionsPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAzureFunctions#update operationId: update-azurefunctions-plugin summary: Update a AzureFunctions plugin description: Update a AzureFunctions plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AzureFunctionsPlugin' responses: '200': description: AzureFunctions plugin content: application/json: schema: $ref: '#/components/schemas/AzureFunctionsPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#BasicAuth': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginBasicAuth#delete operationId: delete-basicauth-plugin summary: Delete a BasicAuth plugin description: Delete a BasicAuth plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginBasicAuth#read operationId: get-basicauth-plugin summary: Get a BasicAuth plugin description: Get a BasicAuth plugin responses: '200': description: BasicAuth plugin content: application/json: schema: $ref: '#/components/schemas/BasicAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginBasicAuth#update operationId: update-basicauth-plugin summary: Update a BasicAuth plugin description: Update a BasicAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BasicAuthPlugin' responses: '200': description: BasicAuth plugin content: application/json: schema: $ref: '#/components/schemas/BasicAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#BotDetection': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginBotDetection#delete operationId: delete-botdetection-plugin summary: Delete a BotDetection plugin description: Delete a BotDetection plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginBotDetection#read operationId: get-botdetection-plugin summary: Get a BotDetection plugin description: Get a BotDetection plugin responses: '200': description: BotDetection plugin content: application/json: schema: $ref: '#/components/schemas/BotDetectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginBotDetection#update operationId: update-botdetection-plugin summary: Update a BotDetection plugin description: Update a BotDetection plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BotDetectionPlugin' responses: '200': description: BotDetection plugin content: application/json: schema: $ref: '#/components/schemas/BotDetectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Canary': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginCanary#delete operationId: delete-canary-plugin summary: Delete a Canary plugin description: Delete a Canary plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginCanary#read operationId: get-canary-plugin summary: Get a Canary plugin description: Get a Canary plugin responses: '200': description: Canary plugin content: application/json: schema: $ref: '#/components/schemas/CanaryPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginCanary#update operationId: update-canary-plugin summary: Update a Canary plugin description: Update a Canary plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CanaryPlugin' responses: '200': description: Canary plugin content: application/json: schema: $ref: '#/components/schemas/CanaryPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Confluent': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginConfluent#delete operationId: delete-confluent-plugin summary: Delete a Confluent plugin description: Delete a Confluent plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginConfluent#read operationId: get-confluent-plugin summary: Get a Confluent plugin description: Get a Confluent plugin responses: '200': description: Confluent plugin content: application/json: schema: $ref: '#/components/schemas/ConfluentPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginConfluent#update operationId: update-confluent-plugin summary: Update a Confluent plugin description: Update a Confluent plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConfluentPlugin' responses: '200': description: Confluent plugin content: application/json: schema: $ref: '#/components/schemas/ConfluentPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#ConfluentConsume': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginConfluentConsume#delete operationId: delete-confluentconsume-plugin summary: Delete a ConfluentConsume plugin description: Delete a ConfluentConsume plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginConfluentConsume#read operationId: get-confluentconsume-plugin summary: Get a ConfluentConsume plugin description: Get a ConfluentConsume plugin responses: '200': description: ConfluentConsume plugin content: application/json: schema: $ref: '#/components/schemas/ConfluentConsumePlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginConfluentConsume#update operationId: update-confluentconsume-plugin summary: Update a ConfluentConsume plugin description: Update a ConfluentConsume plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConfluentConsumePlugin' responses: '200': description: ConfluentConsume plugin content: application/json: schema: $ref: '#/components/schemas/ConfluentConsumePlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#CorrelationId': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginCorrelationId#delete operationId: delete-correlationid-plugin summary: Delete a CorrelationId plugin description: Delete a CorrelationId plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginCorrelationId#read operationId: get-correlationid-plugin summary: Get a CorrelationId plugin description: Get a CorrelationId plugin responses: '200': description: CorrelationId plugin content: application/json: schema: $ref: '#/components/schemas/CorrelationIdPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginCorrelationId#update operationId: update-correlationid-plugin summary: Update a CorrelationId plugin description: Update a CorrelationId plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CorrelationIdPlugin' responses: '200': description: CorrelationId plugin content: application/json: schema: $ref: '#/components/schemas/CorrelationIdPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Cors': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginCors#delete operationId: delete-cors-plugin summary: Delete a Cors plugin description: Delete a Cors plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginCors#read operationId: get-cors-plugin summary: Get a Cors plugin description: Get a Cors plugin responses: '200': description: Cors plugin content: application/json: schema: $ref: '#/components/schemas/CorsPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginCors#update operationId: update-cors-plugin summary: Update a Cors plugin description: Update a Cors plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CorsPlugin' responses: '200': description: Cors plugin content: application/json: schema: $ref: '#/components/schemas/CorsPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Datadog': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDatadog#delete operationId: delete-datadog-plugin summary: Delete a Datadog plugin description: Delete a Datadog plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDatadog#read operationId: get-datadog-plugin summary: Get a Datadog plugin description: Get a Datadog plugin responses: '200': description: Datadog plugin content: application/json: schema: $ref: '#/components/schemas/DatadogPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDatadog#update operationId: update-datadog-plugin summary: Update a Datadog plugin description: Update a Datadog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DatadogPlugin' responses: '200': description: Datadog plugin content: application/json: schema: $ref: '#/components/schemas/DatadogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#DatadogTracing': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDatadogTracing#delete operationId: delete-datadogtracing-plugin summary: Delete a DatadogTracing plugin description: Delete a DatadogTracing plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDatadogTracing#read operationId: get-datadogtracing-plugin summary: Get a DatadogTracing plugin description: Get a DatadogTracing plugin responses: '200': description: DatadogTracing plugin content: application/json: schema: $ref: '#/components/schemas/DatadogTracingPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDatadogTracing#update operationId: update-datadogtracing-plugin summary: Update a DatadogTracing plugin description: Update a DatadogTracing plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DatadogTracingPlugin' responses: '200': description: DatadogTracing plugin content: application/json: schema: $ref: '#/components/schemas/DatadogTracingPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Datakit': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDatakit#delete operationId: delete-datakit-plugin summary: Delete a Datakit plugin description: Delete a Datakit plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDatakit#read operationId: get-datakit-plugin summary: Get a Datakit plugin description: Get a Datakit plugin responses: '200': description: Datakit plugin content: application/json: schema: $ref: '#/components/schemas/DatakitPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDatakit#update operationId: update-datakit-plugin summary: Update a Datakit plugin description: Update a Datakit plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DatakitPlugin' responses: '200': description: Datakit plugin content: application/json: schema: $ref: '#/components/schemas/DatakitPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Degraphql': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDegraphql#delete operationId: delete-degraphql-plugin summary: Delete a Degraphql plugin description: Delete a Degraphql plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDegraphql#read operationId: get-degraphql-plugin summary: Get a Degraphql plugin description: Get a Degraphql plugin responses: '200': description: Degraphql plugin content: application/json: schema: $ref: '#/components/schemas/DegraphqlPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDegraphql#update operationId: update-degraphql-plugin summary: Update a Degraphql plugin description: Update a Degraphql plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DegraphqlPlugin' responses: '200': description: Degraphql plugin content: application/json: schema: $ref: '#/components/schemas/DegraphqlPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#ExitTransformer': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginExitTransformer#delete operationId: delete-exittransformer-plugin summary: Delete a ExitTransformer plugin description: Delete a ExitTransformer plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginExitTransformer#read operationId: get-exittransformer-plugin summary: Get a ExitTransformer plugin description: Get a ExitTransformer plugin responses: '200': description: ExitTransformer plugin content: application/json: schema: $ref: '#/components/schemas/ExitTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginExitTransformer#update operationId: update-exittransformer-plugin summary: Update a ExitTransformer plugin description: Update a ExitTransformer plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExitTransformerPlugin' responses: '200': description: ExitTransformer plugin content: application/json: schema: $ref: '#/components/schemas/ExitTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#FileLog': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginFileLog#delete operationId: delete-filelog-plugin summary: Delete a FileLog plugin description: Delete a FileLog plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginFileLog#read operationId: get-filelog-plugin summary: Get a FileLog plugin description: Get a FileLog plugin responses: '200': description: FileLog plugin content: application/json: schema: $ref: '#/components/schemas/FileLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginFileLog#update operationId: update-filelog-plugin summary: Update a FileLog plugin description: Update a FileLog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FileLogPlugin' responses: '200': description: FileLog plugin content: application/json: schema: $ref: '#/components/schemas/FileLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#ForwardProxy': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginForwardProxy#delete operationId: delete-forwardproxy-plugin summary: Delete a ForwardProxy plugin description: Delete a ForwardProxy plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginForwardProxy#read operationId: get-forwardproxy-plugin summary: Get a ForwardProxy plugin description: Get a ForwardProxy plugin responses: '200': description: ForwardProxy plugin content: application/json: schema: $ref: '#/components/schemas/ForwardProxyPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginForwardProxy#update operationId: update-forwardproxy-plugin summary: Update a ForwardProxy plugin description: Update a ForwardProxy plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ForwardProxyPlugin' responses: '200': description: ForwardProxy plugin content: application/json: schema: $ref: '#/components/schemas/ForwardProxyPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#GraphqlProxyCacheAdvanced': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGraphqlProxyCacheAdvanced#delete operationId: delete-graphqlproxycacheadvanced-plugin summary: Delete a GraphqlProxyCacheAdvanced plugin description: Delete a GraphqlProxyCacheAdvanced plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGraphqlProxyCacheAdvanced#read operationId: get-graphqlproxycacheadvanced-plugin summary: Get a GraphqlProxyCacheAdvanced plugin description: Get a GraphqlProxyCacheAdvanced plugin responses: '200': description: GraphqlProxyCacheAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/GraphqlProxyCacheAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGraphqlProxyCacheAdvanced#update operationId: update-graphqlproxycacheadvanced-plugin summary: Update a GraphqlProxyCacheAdvanced plugin description: Update a GraphqlProxyCacheAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GraphqlProxyCacheAdvancedPlugin' responses: '200': description: GraphqlProxyCacheAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/GraphqlProxyCacheAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#GraphqlRateLimitingAdvanced': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGraphqlRateLimitingAdvanced#delete operationId: delete-graphqlratelimitingadvanced-plugin summary: Delete a GraphqlRateLimitingAdvanced plugin description: Delete a GraphqlRateLimitingAdvanced plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGraphqlRateLimitingAdvanced#read operationId: get-graphqlratelimitingadvanced-plugin summary: Get a GraphqlRateLimitingAdvanced plugin description: Get a GraphqlRateLimitingAdvanced plugin responses: '200': description: GraphqlRateLimitingAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/GraphqlRateLimitingAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGraphqlRateLimitingAdvanced#update operationId: update-graphqlratelimitingadvanced-plugin summary: Update a GraphqlRateLimitingAdvanced plugin description: Update a GraphqlRateLimitingAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GraphqlRateLimitingAdvancedPlugin' responses: '200': description: GraphqlRateLimitingAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/GraphqlRateLimitingAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#GrpcGateway': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGrpcGateway#delete operationId: delete-grpcgateway-plugin summary: Delete a GrpcGateway plugin description: Delete a GrpcGateway plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGrpcGateway#read operationId: get-grpcgateway-plugin summary: Get a GrpcGateway plugin description: Get a GrpcGateway plugin responses: '200': description: GrpcGateway plugin content: application/json: schema: $ref: '#/components/schemas/GrpcGatewayPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGrpcGateway#update operationId: update-grpcgateway-plugin summary: Update a GrpcGateway plugin description: Update a GrpcGateway plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GrpcGatewayPlugin' responses: '200': description: GrpcGateway plugin content: application/json: schema: $ref: '#/components/schemas/GrpcGatewayPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#GrpcWeb': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGrpcWeb#delete operationId: delete-grpcweb-plugin summary: Delete a GrpcWeb plugin description: Delete a GrpcWeb plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGrpcWeb#read operationId: get-grpcweb-plugin summary: Get a GrpcWeb plugin description: Get a GrpcWeb plugin responses: '200': description: GrpcWeb plugin content: application/json: schema: $ref: '#/components/schemas/GrpcWebPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGrpcWeb#update operationId: update-grpcweb-plugin summary: Update a GrpcWeb plugin description: Update a GrpcWeb plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GrpcWebPlugin' responses: '200': description: GrpcWeb plugin content: application/json: schema: $ref: '#/components/schemas/GrpcWebPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#HeaderCertAuth': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginHeaderCertAuth#delete operationId: delete-headercertauth-plugin summary: Delete a HeaderCertAuth plugin description: Delete a HeaderCertAuth plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginHeaderCertAuth#read operationId: get-headercertauth-plugin summary: Get a HeaderCertAuth plugin description: Get a HeaderCertAuth plugin responses: '200': description: HeaderCertAuth plugin content: application/json: schema: $ref: '#/components/schemas/HeaderCertAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginHeaderCertAuth#update operationId: update-headercertauth-plugin summary: Update a HeaderCertAuth plugin description: Update a HeaderCertAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/HeaderCertAuthPlugin' responses: '200': description: HeaderCertAuth plugin content: application/json: schema: $ref: '#/components/schemas/HeaderCertAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#HmacAuth': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginHmacAuth#delete operationId: delete-hmacauth-plugin summary: Delete a HmacAuth plugin description: Delete a HmacAuth plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginHmacAuth#read operationId: get-hmacauth-plugin summary: Get a HmacAuth plugin description: Get a HmacAuth plugin responses: '200': description: HmacAuth plugin content: application/json: schema: $ref: '#/components/schemas/HmacAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginHmacAuth#update operationId: update-hmacauth-plugin summary: Update a HmacAuth plugin description: Update a HmacAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/HmacAuthPlugin' responses: '200': description: HmacAuth plugin content: application/json: schema: $ref: '#/components/schemas/HmacAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#HttpLog': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginHttpLog#delete operationId: delete-httplog-plugin summary: Delete a HttpLog plugin description: Delete a HttpLog plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginHttpLog#read operationId: get-httplog-plugin summary: Get a HttpLog plugin description: Get a HttpLog plugin responses: '200': description: HttpLog plugin content: application/json: schema: $ref: '#/components/schemas/HttpLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginHttpLog#update operationId: update-httplog-plugin summary: Update a HttpLog plugin description: Update a HttpLog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/HttpLogPlugin' responses: '200': description: HttpLog plugin content: application/json: schema: $ref: '#/components/schemas/HttpLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#InjectionProtection': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginInjectionProtection#delete operationId: delete-injectionprotection-plugin summary: Delete a InjectionProtection plugin description: Delete a InjectionProtection plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginInjectionProtection#read operationId: get-injectionprotection-plugin summary: Get a InjectionProtection plugin description: Get a InjectionProtection plugin responses: '200': description: InjectionProtection plugin content: application/json: schema: $ref: '#/components/schemas/InjectionProtectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginInjectionProtection#update operationId: update-injectionprotection-plugin summary: Update a InjectionProtection plugin description: Update a InjectionProtection plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InjectionProtectionPlugin' responses: '200': description: InjectionProtection plugin content: application/json: schema: $ref: '#/components/schemas/InjectionProtectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#IpRestriction': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginIpRestriction#delete operationId: delete-iprestriction-plugin summary: Delete a IpRestriction plugin description: Delete a IpRestriction plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginIpRestriction#read operationId: get-iprestriction-plugin summary: Get a IpRestriction plugin description: Get a IpRestriction plugin responses: '200': description: IpRestriction plugin content: application/json: schema: $ref: '#/components/schemas/IpRestrictionPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginIpRestriction#update operationId: update-iprestriction-plugin summary: Update a IpRestriction plugin description: Update a IpRestriction plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/IpRestrictionPlugin' responses: '200': description: IpRestriction plugin content: application/json: schema: $ref: '#/components/schemas/IpRestrictionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Jq': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJq#delete operationId: delete-jq-plugin summary: Delete a Jq plugin description: Delete a Jq plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJq#read operationId: get-jq-plugin summary: Get a Jq plugin description: Get a Jq plugin responses: '200': description: Jq plugin content: application/json: schema: $ref: '#/components/schemas/JqPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJq#update operationId: update-jq-plugin summary: Update a Jq plugin description: Update a Jq plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JqPlugin' responses: '200': description: Jq plugin content: application/json: schema: $ref: '#/components/schemas/JqPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#JsonThreatProtection': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJsonThreatProtection#delete operationId: delete-jsonthreatprotection-plugin summary: Delete a JsonThreatProtection plugin description: Delete a JsonThreatProtection plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJsonThreatProtection#read operationId: get-jsonthreatprotection-plugin summary: Get a JsonThreatProtection plugin description: Get a JsonThreatProtection plugin responses: '200': description: JsonThreatProtection plugin content: application/json: schema: $ref: '#/components/schemas/JsonThreatProtectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJsonThreatProtection#update operationId: update-jsonthreatprotection-plugin summary: Update a JsonThreatProtection plugin description: Update a JsonThreatProtection plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonThreatProtectionPlugin' responses: '200': description: JsonThreatProtection plugin content: application/json: schema: $ref: '#/components/schemas/JsonThreatProtectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#JweDecrypt': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJweDecrypt#delete operationId: delete-jwedecrypt-plugin summary: Delete a JweDecrypt plugin description: Delete a JweDecrypt plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJweDecrypt#read operationId: get-jwedecrypt-plugin summary: Get a JweDecrypt plugin description: Get a JweDecrypt plugin responses: '200': description: JweDecrypt plugin content: application/json: schema: $ref: '#/components/schemas/JweDecryptPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJweDecrypt#update operationId: update-jwedecrypt-plugin summary: Update a JweDecrypt plugin description: Update a JweDecrypt plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JweDecryptPlugin' responses: '200': description: JweDecrypt plugin content: application/json: schema: $ref: '#/components/schemas/JweDecryptPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Jwt': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJwt#delete operationId: delete-jwt-plugin summary: Delete a Jwt plugin description: Delete a Jwt plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJwt#read operationId: get-jwt-plugin summary: Get a Jwt plugin description: Get a Jwt plugin responses: '200': description: Jwt plugin content: application/json: schema: $ref: '#/components/schemas/JwtPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJwt#update operationId: update-jwt-plugin summary: Update a Jwt plugin description: Update a Jwt plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JwtPlugin' responses: '200': description: Jwt plugin content: application/json: schema: $ref: '#/components/schemas/JwtPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#JwtSigner': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJwtSigner#delete operationId: delete-jwtsigner-plugin summary: Delete a JwtSigner plugin description: Delete a JwtSigner plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJwtSigner#read operationId: get-jwtsigner-plugin summary: Get a JwtSigner plugin description: Get a JwtSigner plugin responses: '200': description: JwtSigner plugin content: application/json: schema: $ref: '#/components/schemas/JwtSignerPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJwtSigner#update operationId: update-jwtsigner-plugin summary: Update a JwtSigner plugin description: Update a JwtSigner plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JwtSignerPlugin' responses: '200': description: JwtSigner plugin content: application/json: schema: $ref: '#/components/schemas/JwtSignerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#KafkaConsume': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKafkaConsume#delete operationId: delete-kafkaconsume-plugin summary: Delete a KafkaConsume plugin description: Delete a KafkaConsume plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKafkaConsume#read operationId: get-kafkaconsume-plugin summary: Get a KafkaConsume plugin description: Get a KafkaConsume plugin responses: '200': description: KafkaConsume plugin content: application/json: schema: $ref: '#/components/schemas/KafkaConsumePlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKafkaConsume#update operationId: update-kafkaconsume-plugin summary: Update a KafkaConsume plugin description: Update a KafkaConsume plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KafkaConsumePlugin' responses: '200': description: KafkaConsume plugin content: application/json: schema: $ref: '#/components/schemas/KafkaConsumePlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#KafkaLog': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKafkaLog#delete operationId: delete-kafkalog-plugin summary: Delete a KafkaLog plugin description: Delete a KafkaLog plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKafkaLog#read operationId: get-kafkalog-plugin summary: Get a KafkaLog plugin description: Get a KafkaLog plugin responses: '200': description: KafkaLog plugin content: application/json: schema: $ref: '#/components/schemas/KafkaLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKafkaLog#update operationId: update-kafkalog-plugin summary: Update a KafkaLog plugin description: Update a KafkaLog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KafkaLogPlugin' responses: '200': description: KafkaLog plugin content: application/json: schema: $ref: '#/components/schemas/KafkaLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#KafkaUpstream': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKafkaUpstream#delete operationId: delete-kafkaupstream-plugin summary: Delete a KafkaUpstream plugin description: Delete a KafkaUpstream plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKafkaUpstream#read operationId: get-kafkaupstream-plugin summary: Get a KafkaUpstream plugin description: Get a KafkaUpstream plugin responses: '200': description: KafkaUpstream plugin content: application/json: schema: $ref: '#/components/schemas/KafkaUpstreamPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKafkaUpstream#update operationId: update-kafkaupstream-plugin summary: Update a KafkaUpstream plugin description: Update a KafkaUpstream plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KafkaUpstreamPlugin' responses: '200': description: KafkaUpstream plugin content: application/json: schema: $ref: '#/components/schemas/KafkaUpstreamPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#KeyAuth': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKeyAuth#delete operationId: delete-keyauth-plugin summary: Delete a KeyAuth plugin description: Delete a KeyAuth plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKeyAuth#read operationId: get-keyauth-plugin summary: Get a KeyAuth plugin description: Get a KeyAuth plugin responses: '200': description: KeyAuth plugin content: application/json: schema: $ref: '#/components/schemas/KeyAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKeyAuth#update operationId: update-keyauth-plugin summary: Update a KeyAuth plugin description: Update a KeyAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KeyAuthPlugin' responses: '200': description: KeyAuth plugin content: application/json: schema: $ref: '#/components/schemas/KeyAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#KeyAuthEnc': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKeyAuthEnc#delete operationId: delete-keyauthenc-plugin summary: Delete a KeyAuthEnc plugin description: Delete a KeyAuthEnc plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKeyAuthEnc#read operationId: get-keyauthenc-plugin summary: Get a KeyAuthEnc plugin description: Get a KeyAuthEnc plugin responses: '200': description: KeyAuthEnc plugin content: application/json: schema: $ref: '#/components/schemas/KeyAuthEncPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKeyAuthEnc#update operationId: update-keyauthenc-plugin summary: Update a KeyAuthEnc plugin description: Update a KeyAuthEnc plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KeyAuthEncPlugin' responses: '200': description: KeyAuthEnc plugin content: application/json: schema: $ref: '#/components/schemas/KeyAuthEncPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#LdapAuth': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginLdapAuth#delete operationId: delete-ldapauth-plugin summary: Delete a LdapAuth plugin description: Delete a LdapAuth plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginLdapAuth#read operationId: get-ldapauth-plugin summary: Get a LdapAuth plugin description: Get a LdapAuth plugin responses: '200': description: LdapAuth plugin content: application/json: schema: $ref: '#/components/schemas/LdapAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginLdapAuth#update operationId: update-ldapauth-plugin summary: Update a LdapAuth plugin description: Update a LdapAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LdapAuthPlugin' responses: '200': description: LdapAuth plugin content: application/json: schema: $ref: '#/components/schemas/LdapAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#LdapAuthAdvanced': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginLdapAuthAdvanced#delete operationId: delete-ldapauthadvanced-plugin summary: Delete a LdapAuthAdvanced plugin description: Delete a LdapAuthAdvanced plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginLdapAuthAdvanced#read operationId: get-ldapauthadvanced-plugin summary: Get a LdapAuthAdvanced plugin description: Get a LdapAuthAdvanced plugin responses: '200': description: LdapAuthAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/LdapAuthAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginLdapAuthAdvanced#update operationId: update-ldapauthadvanced-plugin summary: Update a LdapAuthAdvanced plugin description: Update a LdapAuthAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LdapAuthAdvancedPlugin' responses: '200': description: LdapAuthAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/LdapAuthAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Loggly': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginLoggly#delete operationId: delete-loggly-plugin summary: Delete a Loggly plugin description: Delete a Loggly plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginLoggly#read operationId: get-loggly-plugin summary: Get a Loggly plugin description: Get a Loggly plugin responses: '200': description: Loggly plugin content: application/json: schema: $ref: '#/components/schemas/LogglyPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginLoggly#update operationId: update-loggly-plugin summary: Update a Loggly plugin description: Update a Loggly plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LogglyPlugin' responses: '200': description: Loggly plugin content: application/json: schema: $ref: '#/components/schemas/LogglyPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Mocking': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginMocking#delete operationId: delete-mocking-plugin summary: Delete a Mocking plugin description: Delete a Mocking plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginMocking#read operationId: get-mocking-plugin summary: Get a Mocking plugin description: Get a Mocking plugin responses: '200': description: Mocking plugin content: application/json: schema: $ref: '#/components/schemas/MockingPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginMocking#update operationId: update-mocking-plugin summary: Update a Mocking plugin description: Update a Mocking plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MockingPlugin' responses: '200': description: Mocking plugin content: application/json: schema: $ref: '#/components/schemas/MockingPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#MtlsAuth': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginMtlsAuth#delete operationId: delete-mtlsauth-plugin summary: Delete a MtlsAuth plugin description: Delete a MtlsAuth plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginMtlsAuth#read operationId: get-mtlsauth-plugin summary: Get a MtlsAuth plugin description: Get a MtlsAuth plugin responses: '200': description: MtlsAuth plugin content: application/json: schema: $ref: '#/components/schemas/MtlsAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginMtlsAuth#update operationId: update-mtlsauth-plugin summary: Update a MtlsAuth plugin description: Update a MtlsAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MtlsAuthPlugin' responses: '200': description: MtlsAuth plugin content: application/json: schema: $ref: '#/components/schemas/MtlsAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#OasValidation': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOasValidation#delete operationId: delete-oasvalidation-plugin summary: Delete a OasValidation plugin description: Delete a OasValidation plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOasValidation#read operationId: get-oasvalidation-plugin summary: Get a OasValidation plugin description: Get a OasValidation plugin responses: '200': description: OasValidation plugin content: application/json: schema: $ref: '#/components/schemas/OasValidationPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOasValidation#update operationId: update-oasvalidation-plugin summary: Update a OasValidation plugin description: Update a OasValidation plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OasValidationPlugin' responses: '200': description: OasValidation plugin content: application/json: schema: $ref: '#/components/schemas/OasValidationPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Oauth2Introspection': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOauth2Introspection#delete operationId: delete-oauth2introspection-plugin summary: Delete a Oauth2Introspection plugin description: Delete a Oauth2Introspection plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOauth2Introspection#read operationId: get-oauth2introspection-plugin summary: Get a Oauth2Introspection plugin description: Get a Oauth2Introspection plugin responses: '200': description: Oauth2Introspection plugin content: application/json: schema: $ref: '#/components/schemas/Oauth2IntrospectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOauth2Introspection#update operationId: update-oauth2introspection-plugin summary: Update a Oauth2Introspection plugin description: Update a Oauth2Introspection plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Oauth2IntrospectionPlugin' responses: '200': description: Oauth2Introspection plugin content: application/json: schema: $ref: '#/components/schemas/Oauth2IntrospectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Opa': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOpa#delete operationId: delete-opa-plugin summary: Delete a Opa plugin description: Delete a Opa plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOpa#read operationId: get-opa-plugin summary: Get a Opa plugin description: Get a Opa plugin responses: '200': description: Opa plugin content: application/json: schema: $ref: '#/components/schemas/OpaPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOpa#update operationId: update-opa-plugin summary: Update a Opa plugin description: Update a Opa plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpaPlugin' responses: '200': description: Opa plugin content: application/json: schema: $ref: '#/components/schemas/OpaPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#OpenidConnect': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOpenidConnect#delete operationId: delete-openidconnect-plugin summary: Delete a OpenidConnect plugin description: Delete a OpenidConnect plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOpenidConnect#read operationId: get-openidconnect-plugin summary: Get a OpenidConnect plugin description: Get a OpenidConnect plugin responses: '200': description: OpenidConnect plugin content: application/json: schema: $ref: '#/components/schemas/OpenidConnectPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOpenidConnect#update operationId: update-openidconnect-plugin summary: Update a OpenidConnect plugin description: Update a OpenidConnect plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpenidConnectPlugin' responses: '200': description: OpenidConnect plugin content: application/json: schema: $ref: '#/components/schemas/OpenidConnectPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Opentelemetry': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOpentelemetry#delete operationId: delete-opentelemetry-plugin summary: Delete a Opentelemetry plugin description: Delete a Opentelemetry plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOpentelemetry#read operationId: get-opentelemetry-plugin summary: Get a Opentelemetry plugin description: Get a Opentelemetry plugin responses: '200': description: Opentelemetry plugin content: application/json: schema: $ref: '#/components/schemas/OpentelemetryPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOpentelemetry#update operationId: update-opentelemetry-plugin summary: Update a Opentelemetry plugin description: Update a Opentelemetry plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpentelemetryPlugin' responses: '200': description: Opentelemetry plugin content: application/json: schema: $ref: '#/components/schemas/OpentelemetryPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#PostFunction': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginPostFunction#delete operationId: delete-postfunction-plugin summary: Delete a PostFunction plugin description: Delete a PostFunction plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginPostFunction#read operationId: get-postfunction-plugin summary: Get a PostFunction plugin description: Get a PostFunction plugin responses: '200': description: PostFunction plugin content: application/json: schema: $ref: '#/components/schemas/PostFunctionPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginPostFunction#update operationId: update-postfunction-plugin summary: Update a PostFunction plugin description: Update a PostFunction plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostFunctionPlugin' responses: '200': description: PostFunction plugin content: application/json: schema: $ref: '#/components/schemas/PostFunctionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#PreFunction': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginPreFunction#delete operationId: delete-prefunction-plugin summary: Delete a PreFunction plugin description: Delete a PreFunction plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginPreFunction#read operationId: get-prefunction-plugin summary: Get a PreFunction plugin description: Get a PreFunction plugin responses: '200': description: PreFunction plugin content: application/json: schema: $ref: '#/components/schemas/PreFunctionPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginPreFunction#update operationId: update-prefunction-plugin summary: Update a PreFunction plugin description: Update a PreFunction plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PreFunctionPlugin' responses: '200': description: PreFunction plugin content: application/json: schema: $ref: '#/components/schemas/PreFunctionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Prometheus': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginPrometheus#delete operationId: delete-prometheus-plugin summary: Delete a Prometheus plugin description: Delete a Prometheus plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginPrometheus#read operationId: get-prometheus-plugin summary: Get a Prometheus plugin description: Get a Prometheus plugin responses: '200': description: Prometheus plugin content: application/json: schema: $ref: '#/components/schemas/PrometheusPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginPrometheus#update operationId: update-prometheus-plugin summary: Update a Prometheus plugin description: Update a Prometheus plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PrometheusPlugin' responses: '200': description: Prometheus plugin content: application/json: schema: $ref: '#/components/schemas/PrometheusPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#ProxyCache': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginProxyCache#delete operationId: delete-proxycache-plugin summary: Delete a ProxyCache plugin description: Delete a ProxyCache plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginProxyCache#read operationId: get-proxycache-plugin summary: Get a ProxyCache plugin description: Get a ProxyCache plugin responses: '200': description: ProxyCache plugin content: application/json: schema: $ref: '#/components/schemas/ProxyCachePlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginProxyCache#update operationId: update-proxycache-plugin summary: Update a ProxyCache plugin description: Update a ProxyCache plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProxyCachePlugin' responses: '200': description: ProxyCache plugin content: application/json: schema: $ref: '#/components/schemas/ProxyCachePlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#ProxyCacheAdvanced': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginProxyCacheAdvanced#delete operationId: delete-proxycacheadvanced-plugin summary: Delete a ProxyCacheAdvanced plugin description: Delete a ProxyCacheAdvanced plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginProxyCacheAdvanced#read operationId: get-proxycacheadvanced-plugin summary: Get a ProxyCacheAdvanced plugin description: Get a ProxyCacheAdvanced plugin responses: '200': description: ProxyCacheAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/ProxyCacheAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginProxyCacheAdvanced#update operationId: update-proxycacheadvanced-plugin summary: Update a ProxyCacheAdvanced plugin description: Update a ProxyCacheAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProxyCacheAdvancedPlugin' responses: '200': description: ProxyCacheAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/ProxyCacheAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#RateLimiting': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRateLimiting#delete operationId: delete-ratelimiting-plugin summary: Delete a RateLimiting plugin description: Delete a RateLimiting plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRateLimiting#read operationId: get-ratelimiting-plugin summary: Get a RateLimiting plugin description: Get a RateLimiting plugin responses: '200': description: RateLimiting plugin content: application/json: schema: $ref: '#/components/schemas/RateLimitingPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRateLimiting#update operationId: update-ratelimiting-plugin summary: Update a RateLimiting plugin description: Update a RateLimiting plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RateLimitingPlugin' responses: '200': description: RateLimiting plugin content: application/json: schema: $ref: '#/components/schemas/RateLimitingPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#RateLimitingAdvanced': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRateLimitingAdvanced#delete operationId: delete-ratelimitingadvanced-plugin summary: Delete a RateLimitingAdvanced plugin description: Delete a RateLimitingAdvanced plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRateLimitingAdvanced#read operationId: get-ratelimitingadvanced-plugin summary: Get a RateLimitingAdvanced plugin description: Get a RateLimitingAdvanced plugin responses: '200': description: RateLimitingAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/RateLimitingAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRateLimitingAdvanced#update operationId: update-ratelimitingadvanced-plugin summary: Update a RateLimitingAdvanced plugin description: Update a RateLimitingAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RateLimitingAdvancedPlugin' responses: '200': description: RateLimitingAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/RateLimitingAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Redirect': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRedirect#delete operationId: delete-redirect-plugin summary: Delete a Redirect plugin description: Delete a Redirect plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRedirect#read operationId: get-redirect-plugin summary: Get a Redirect plugin description: Get a Redirect plugin responses: '200': description: Redirect plugin content: application/json: schema: $ref: '#/components/schemas/RedirectPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRedirect#update operationId: update-redirect-plugin summary: Update a Redirect plugin description: Update a Redirect plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RedirectPlugin' responses: '200': description: Redirect plugin content: application/json: schema: $ref: '#/components/schemas/RedirectPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#RequestCallout': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestCallout#delete operationId: delete-requestcallout-plugin summary: Delete a RequestCallout plugin description: Delete a RequestCallout plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestCallout#read operationId: get-requestcallout-plugin summary: Get a RequestCallout plugin description: Get a RequestCallout plugin responses: '200': description: RequestCallout plugin content: application/json: schema: $ref: '#/components/schemas/RequestCalloutPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestCallout#update operationId: update-requestcallout-plugin summary: Update a RequestCallout plugin description: Update a RequestCallout plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestCalloutPlugin' responses: '200': description: RequestCallout plugin content: application/json: schema: $ref: '#/components/schemas/RequestCalloutPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#RequestSizeLimiting': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestSizeLimiting#delete operationId: delete-requestsizelimiting-plugin summary: Delete a RequestSizeLimiting plugin description: Delete a RequestSizeLimiting plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestSizeLimiting#read operationId: get-requestsizelimiting-plugin summary: Get a RequestSizeLimiting plugin description: Get a RequestSizeLimiting plugin responses: '200': description: RequestSizeLimiting plugin content: application/json: schema: $ref: '#/components/schemas/RequestSizeLimitingPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestSizeLimiting#update operationId: update-requestsizelimiting-plugin summary: Update a RequestSizeLimiting plugin description: Update a RequestSizeLimiting plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestSizeLimitingPlugin' responses: '200': description: RequestSizeLimiting plugin content: application/json: schema: $ref: '#/components/schemas/RequestSizeLimitingPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#RequestTermination': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestTermination#delete operationId: delete-requesttermination-plugin summary: Delete a RequestTermination plugin description: Delete a RequestTermination plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestTermination#read operationId: get-requesttermination-plugin summary: Get a RequestTermination plugin description: Get a RequestTermination plugin responses: '200': description: RequestTermination plugin content: application/json: schema: $ref: '#/components/schemas/RequestTerminationPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestTermination#update operationId: update-requesttermination-plugin summary: Update a RequestTermination plugin description: Update a RequestTermination plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestTerminationPlugin' responses: '200': description: RequestTermination plugin content: application/json: schema: $ref: '#/components/schemas/RequestTerminationPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#RequestTransformer': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestTransformer#delete operationId: delete-requesttransformer-plugin summary: Delete a RequestTransformer plugin description: Delete a RequestTransformer plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestTransformer#read operationId: get-requesttransformer-plugin summary: Get a RequestTransformer plugin description: Get a RequestTransformer plugin responses: '200': description: RequestTransformer plugin content: application/json: schema: $ref: '#/components/schemas/RequestTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestTransformer#update operationId: update-requesttransformer-plugin summary: Update a RequestTransformer plugin description: Update a RequestTransformer plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestTransformerPlugin' responses: '200': description: RequestTransformer plugin content: application/json: schema: $ref: '#/components/schemas/RequestTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#RequestTransformerAdvanced': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestTransformerAdvanced#delete operationId: delete-requesttransformeradvanced-plugin summary: Delete a RequestTransformerAdvanced plugin description: Delete a RequestTransformerAdvanced plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestTransformerAdvanced#read operationId: get-requesttransformeradvanced-plugin summary: Get a RequestTransformerAdvanced plugin description: Get a RequestTransformerAdvanced plugin responses: '200': description: RequestTransformerAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/RequestTransformerAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestTransformerAdvanced#update operationId: update-requesttransformeradvanced-plugin summary: Update a RequestTransformerAdvanced plugin description: Update a RequestTransformerAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestTransformerAdvancedPlugin' responses: '200': description: RequestTransformerAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/RequestTransformerAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#RequestValidator': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestValidator#delete operationId: delete-requestvalidator-plugin summary: Delete a RequestValidator plugin description: Delete a RequestValidator plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestValidator#read operationId: get-requestvalidator-plugin summary: Get a RequestValidator plugin description: Get a RequestValidator plugin responses: '200': description: RequestValidator plugin content: application/json: schema: $ref: '#/components/schemas/RequestValidatorPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestValidator#update operationId: update-requestvalidator-plugin summary: Update a RequestValidator plugin description: Update a RequestValidator plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestValidatorPlugin' responses: '200': description: RequestValidator plugin content: application/json: schema: $ref: '#/components/schemas/RequestValidatorPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#ResponseRatelimiting': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginResponseRatelimiting#delete operationId: delete-responseratelimiting-plugin summary: Delete a ResponseRatelimiting plugin description: Delete a ResponseRatelimiting plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginResponseRatelimiting#read operationId: get-responseratelimiting-plugin summary: Get a ResponseRatelimiting plugin description: Get a ResponseRatelimiting plugin responses: '200': description: ResponseRatelimiting plugin content: application/json: schema: $ref: '#/components/schemas/ResponseRatelimitingPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginResponseRatelimiting#update operationId: update-responseratelimiting-plugin summary: Update a ResponseRatelimiting plugin description: Update a ResponseRatelimiting plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResponseRatelimitingPlugin' responses: '200': description: ResponseRatelimiting plugin content: application/json: schema: $ref: '#/components/schemas/ResponseRatelimitingPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#ResponseTransformer': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginResponseTransformer#delete operationId: delete-responsetransformer-plugin summary: Delete a ResponseTransformer plugin description: Delete a ResponseTransformer plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginResponseTransformer#read operationId: get-responsetransformer-plugin summary: Get a ResponseTransformer plugin description: Get a ResponseTransformer plugin responses: '200': description: ResponseTransformer plugin content: application/json: schema: $ref: '#/components/schemas/ResponseTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginResponseTransformer#update operationId: update-responsetransformer-plugin summary: Update a ResponseTransformer plugin description: Update a ResponseTransformer plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResponseTransformerPlugin' responses: '200': description: ResponseTransformer plugin content: application/json: schema: $ref: '#/components/schemas/ResponseTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#ResponseTransformerAdvanced': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginResponseTransformerAdvanced#delete operationId: delete-responsetransformeradvanced-plugin summary: Delete a ResponseTransformerAdvanced plugin description: Delete a ResponseTransformerAdvanced plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginResponseTransformerAdvanced#read operationId: get-responsetransformeradvanced-plugin summary: Get a ResponseTransformerAdvanced plugin description: Get a ResponseTransformerAdvanced plugin responses: '200': description: ResponseTransformerAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/ResponseTransformerAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginResponseTransformerAdvanced#update operationId: update-responsetransformeradvanced-plugin summary: Update a ResponseTransformerAdvanced plugin description: Update a ResponseTransformerAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResponseTransformerAdvancedPlugin' responses: '200': description: ResponseTransformerAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/ResponseTransformerAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#RouteByHeader': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRouteByHeader#delete operationId: delete-routebyheader-plugin summary: Delete a RouteByHeader plugin description: Delete a RouteByHeader plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRouteByHeader#read operationId: get-routebyheader-plugin summary: Get a RouteByHeader plugin description: Get a RouteByHeader plugin responses: '200': description: RouteByHeader plugin content: application/json: schema: $ref: '#/components/schemas/RouteByHeaderPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRouteByHeader#update operationId: update-routebyheader-plugin summary: Update a RouteByHeader plugin description: Update a RouteByHeader plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RouteByHeaderPlugin' responses: '200': description: RouteByHeader plugin content: application/json: schema: $ref: '#/components/schemas/RouteByHeaderPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#RouteTransformerAdvanced': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRouteTransformerAdvanced#delete operationId: delete-routetransformeradvanced-plugin summary: Delete a RouteTransformerAdvanced plugin description: Delete a RouteTransformerAdvanced plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRouteTransformerAdvanced#read operationId: get-routetransformeradvanced-plugin summary: Get a RouteTransformerAdvanced plugin description: Get a RouteTransformerAdvanced plugin responses: '200': description: RouteTransformerAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/RouteTransformerAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRouteTransformerAdvanced#update operationId: update-routetransformeradvanced-plugin summary: Update a RouteTransformerAdvanced plugin description: Update a RouteTransformerAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RouteTransformerAdvancedPlugin' responses: '200': description: RouteTransformerAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/RouteTransformerAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Saml': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSaml#delete operationId: delete-saml-plugin summary: Delete a Saml plugin description: Delete a Saml plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSaml#read operationId: get-saml-plugin summary: Get a Saml plugin description: Get a Saml plugin responses: '200': description: Saml plugin content: application/json: schema: $ref: '#/components/schemas/SamlPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSaml#update operationId: update-saml-plugin summary: Update a Saml plugin description: Update a Saml plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SamlPlugin' responses: '200': description: Saml plugin content: application/json: schema: $ref: '#/components/schemas/SamlPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#ServiceProtection': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginServiceProtection#delete operationId: delete-serviceprotection-plugin summary: Delete a ServiceProtection plugin description: Delete a ServiceProtection plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginServiceProtection#read operationId: get-serviceprotection-plugin summary: Get a ServiceProtection plugin description: Get a ServiceProtection plugin responses: '200': description: ServiceProtection plugin content: application/json: schema: $ref: '#/components/schemas/ServiceProtectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginServiceProtection#update operationId: update-serviceprotection-plugin summary: Update a ServiceProtection plugin description: Update a ServiceProtection plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ServiceProtectionPlugin' responses: '200': description: ServiceProtection plugin content: application/json: schema: $ref: '#/components/schemas/ServiceProtectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Session': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSession#delete operationId: delete-session-plugin summary: Delete a Session plugin description: Delete a Session plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSession#read operationId: get-session-plugin summary: Get a Session plugin description: Get a Session plugin responses: '200': description: Session plugin content: application/json: schema: $ref: '#/components/schemas/SessionPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSession#update operationId: update-session-plugin summary: Update a Session plugin description: Update a Session plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SessionPlugin' responses: '200': description: Session plugin content: application/json: schema: $ref: '#/components/schemas/SessionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#SolaceUpstream': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSolaceUpstream#delete operationId: delete-solaceupstream-plugin summary: Delete a SolaceUpstream plugin description: Delete a SolaceUpstream plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSolaceUpstream#read operationId: get-solaceupstream-plugin summary: Get a SolaceUpstream plugin description: Get a SolaceUpstream plugin responses: '200': description: SolaceUpstream plugin content: application/json: schema: $ref: '#/components/schemas/SolaceUpstreamPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSolaceUpstream#update operationId: update-solaceupstream-plugin summary: Update a SolaceUpstream plugin description: Update a SolaceUpstream plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SolaceUpstreamPlugin' responses: '200': description: SolaceUpstream plugin content: application/json: schema: $ref: '#/components/schemas/SolaceUpstreamPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#StandardWebhooks': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginStandardWebhooks#delete operationId: delete-standardwebhooks-plugin summary: Delete a StandardWebhooks plugin description: Delete a StandardWebhooks plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginStandardWebhooks#read operationId: get-standardwebhooks-plugin summary: Get a StandardWebhooks plugin description: Get a StandardWebhooks plugin responses: '200': description: StandardWebhooks plugin content: application/json: schema: $ref: '#/components/schemas/StandardWebhooksPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginStandardWebhooks#update operationId: update-standardwebhooks-plugin summary: Update a StandardWebhooks plugin description: Update a StandardWebhooks plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StandardWebhooksPlugin' responses: '200': description: StandardWebhooks plugin content: application/json: schema: $ref: '#/components/schemas/StandardWebhooksPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Statsd': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginStatsd#delete operationId: delete-statsd-plugin summary: Delete a Statsd plugin description: Delete a Statsd plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginStatsd#read operationId: get-statsd-plugin summary: Get a Statsd plugin description: Get a Statsd plugin responses: '200': description: Statsd plugin content: application/json: schema: $ref: '#/components/schemas/StatsdPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginStatsd#update operationId: update-statsd-plugin summary: Update a Statsd plugin description: Update a Statsd plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StatsdPlugin' responses: '200': description: Statsd plugin content: application/json: schema: $ref: '#/components/schemas/StatsdPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#StatsdAdvanced': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginStatsdAdvanced#delete operationId: delete-statsdadvanced-plugin summary: Delete a StatsdAdvanced plugin description: Delete a StatsdAdvanced plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginStatsdAdvanced#read operationId: get-statsdadvanced-plugin summary: Get a StatsdAdvanced plugin description: Get a StatsdAdvanced plugin responses: '200': description: StatsdAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/StatsdAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginStatsdAdvanced#update operationId: update-statsdadvanced-plugin summary: Update a StatsdAdvanced plugin description: Update a StatsdAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StatsdAdvancedPlugin' responses: '200': description: StatsdAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/StatsdAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Syslog': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSyslog#delete operationId: delete-syslog-plugin summary: Delete a Syslog plugin description: Delete a Syslog plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSyslog#read operationId: get-syslog-plugin summary: Get a Syslog plugin description: Get a Syslog plugin responses: '200': description: Syslog plugin content: application/json: schema: $ref: '#/components/schemas/SyslogPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSyslog#update operationId: update-syslog-plugin summary: Update a Syslog plugin description: Update a Syslog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SyslogPlugin' responses: '200': description: Syslog plugin content: application/json: schema: $ref: '#/components/schemas/SyslogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#TcpLog': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginTcpLog#delete operationId: delete-tcplog-plugin summary: Delete a TcpLog plugin description: Delete a TcpLog plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginTcpLog#read operationId: get-tcplog-plugin summary: Get a TcpLog plugin description: Get a TcpLog plugin responses: '200': description: TcpLog plugin content: application/json: schema: $ref: '#/components/schemas/TcpLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginTcpLog#update operationId: update-tcplog-plugin summary: Update a TcpLog plugin description: Update a TcpLog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TcpLogPlugin' responses: '200': description: TcpLog plugin content: application/json: schema: $ref: '#/components/schemas/TcpLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#TlsHandshakeModifier': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginTlsHandshakeModifier#delete operationId: delete-tlshandshakemodifier-plugin summary: Delete a TlsHandshakeModifier plugin description: Delete a TlsHandshakeModifier plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginTlsHandshakeModifier#read operationId: get-tlshandshakemodifier-plugin summary: Get a TlsHandshakeModifier plugin description: Get a TlsHandshakeModifier plugin responses: '200': description: TlsHandshakeModifier plugin content: application/json: schema: $ref: '#/components/schemas/TlsHandshakeModifierPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginTlsHandshakeModifier#update operationId: update-tlshandshakemodifier-plugin summary: Update a TlsHandshakeModifier plugin description: Update a TlsHandshakeModifier plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TlsHandshakeModifierPlugin' responses: '200': description: TlsHandshakeModifier plugin content: application/json: schema: $ref: '#/components/schemas/TlsHandshakeModifierPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#TlsMetadataHeaders': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginTlsMetadataHeaders#delete operationId: delete-tlsmetadataheaders-plugin summary: Delete a TlsMetadataHeaders plugin description: Delete a TlsMetadataHeaders plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginTlsMetadataHeaders#read operationId: get-tlsmetadataheaders-plugin summary: Get a TlsMetadataHeaders plugin description: Get a TlsMetadataHeaders plugin responses: '200': description: TlsMetadataHeaders plugin content: application/json: schema: $ref: '#/components/schemas/TlsMetadataHeadersPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginTlsMetadataHeaders#update operationId: update-tlsmetadataheaders-plugin summary: Update a TlsMetadataHeaders plugin description: Update a TlsMetadataHeaders plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TlsMetadataHeadersPlugin' responses: '200': description: TlsMetadataHeaders plugin content: application/json: schema: $ref: '#/components/schemas/TlsMetadataHeadersPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#UdpLog': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginUdpLog#delete operationId: delete-udplog-plugin summary: Delete a UdpLog plugin description: Delete a UdpLog plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginUdpLog#read operationId: get-udplog-plugin summary: Get a UdpLog plugin description: Get a UdpLog plugin responses: '200': description: UdpLog plugin content: application/json: schema: $ref: '#/components/schemas/UdpLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginUdpLog#update operationId: update-udplog-plugin summary: Update a UdpLog plugin description: Update a UdpLog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UdpLogPlugin' responses: '200': description: UdpLog plugin content: application/json: schema: $ref: '#/components/schemas/UdpLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#UpstreamOauth': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginUpstreamOauth#delete operationId: delete-upstreamoauth-plugin summary: Delete a UpstreamOauth plugin description: Delete a UpstreamOauth plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginUpstreamOauth#read operationId: get-upstreamoauth-plugin summary: Get a UpstreamOauth plugin description: Get a UpstreamOauth plugin responses: '200': description: UpstreamOauth plugin content: application/json: schema: $ref: '#/components/schemas/UpstreamOauthPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginUpstreamOauth#update operationId: update-upstreamoauth-plugin summary: Update a UpstreamOauth plugin description: Update a UpstreamOauth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpstreamOauthPlugin' responses: '200': description: UpstreamOauth plugin content: application/json: schema: $ref: '#/components/schemas/UpstreamOauthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#UpstreamTimeout': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginUpstreamTimeout#delete operationId: delete-upstreamtimeout-plugin summary: Delete a UpstreamTimeout plugin description: Delete a UpstreamTimeout plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginUpstreamTimeout#read operationId: get-upstreamtimeout-plugin summary: Get a UpstreamTimeout plugin description: Get a UpstreamTimeout plugin responses: '200': description: UpstreamTimeout plugin content: application/json: schema: $ref: '#/components/schemas/UpstreamTimeoutPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginUpstreamTimeout#update operationId: update-upstreamtimeout-plugin summary: Update a UpstreamTimeout plugin description: Update a UpstreamTimeout plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpstreamTimeoutPlugin' responses: '200': description: UpstreamTimeout plugin content: application/json: schema: $ref: '#/components/schemas/UpstreamTimeoutPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#VaultAuth': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginVaultAuth#delete operationId: delete-vaultauth-plugin summary: Delete a VaultAuth plugin description: Delete a VaultAuth plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginVaultAuth#read operationId: get-vaultauth-plugin summary: Get a VaultAuth plugin description: Get a VaultAuth plugin responses: '200': description: VaultAuth plugin content: application/json: schema: $ref: '#/components/schemas/VaultAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginVaultAuth#update operationId: update-vaultauth-plugin summary: Update a VaultAuth plugin description: Update a VaultAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VaultAuthPlugin' responses: '200': description: VaultAuth plugin content: application/json: schema: $ref: '#/components/schemas/VaultAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#WebsocketSizeLimit': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginWebsocketSizeLimit#delete operationId: delete-websocketsizelimit-plugin summary: Delete a WebsocketSizeLimit plugin description: Delete a WebsocketSizeLimit plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginWebsocketSizeLimit#read operationId: get-websocketsizelimit-plugin summary: Get a WebsocketSizeLimit plugin description: Get a WebsocketSizeLimit plugin responses: '200': description: WebsocketSizeLimit plugin content: application/json: schema: $ref: '#/components/schemas/WebsocketSizeLimitPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginWebsocketSizeLimit#update operationId: update-websocketsizelimit-plugin summary: Update a WebsocketSizeLimit plugin description: Update a WebsocketSizeLimit plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebsocketSizeLimitPlugin' responses: '200': description: WebsocketSizeLimit plugin content: application/json: schema: $ref: '#/components/schemas/WebsocketSizeLimitPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#WebsocketValidator': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginWebsocketValidator#delete operationId: delete-websocketvalidator-plugin summary: Delete a WebsocketValidator plugin description: Delete a WebsocketValidator plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginWebsocketValidator#read operationId: get-websocketvalidator-plugin summary: Get a WebsocketValidator plugin description: Get a WebsocketValidator plugin responses: '200': description: WebsocketValidator plugin content: application/json: schema: $ref: '#/components/schemas/WebsocketValidatorPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginWebsocketValidator#update operationId: update-websocketvalidator-plugin summary: Update a WebsocketValidator plugin description: Update a WebsocketValidator plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebsocketValidatorPlugin' responses: '200': description: WebsocketValidator plugin content: application/json: schema: $ref: '#/components/schemas/WebsocketValidatorPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#XmlThreatProtection': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginXmlThreatProtection#delete operationId: delete-xmlthreatprotection-plugin summary: Delete a XmlThreatProtection plugin description: Delete a XmlThreatProtection plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginXmlThreatProtection#read operationId: get-xmlthreatprotection-plugin summary: Get a XmlThreatProtection plugin description: Get a XmlThreatProtection plugin responses: '200': description: XmlThreatProtection plugin content: application/json: schema: $ref: '#/components/schemas/XmlThreatProtectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginXmlThreatProtection#update operationId: update-xmlthreatprotection-plugin summary: Update a XmlThreatProtection plugin description: Update a XmlThreatProtection plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/XmlThreatProtectionPlugin' responses: '200': description: XmlThreatProtection plugin content: application/json: schema: $ref: '#/components/schemas/XmlThreatProtectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Zipkin': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginZipkin#delete operationId: delete-zipkin-plugin summary: Delete a Zipkin plugin description: Delete a Zipkin plugin responses: '204': description: Successfully deleted Plugin or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginZipkin#read operationId: get-zipkin-plugin summary: Get a Zipkin plugin description: Get a Zipkin plugin responses: '200': description: Zipkin plugin content: application/json: schema: $ref: '#/components/schemas/ZipkinPlugin' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Plugins parameters: - $ref: '#/components/parameters/PluginId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginZipkin#update operationId: update-zipkin-plugin summary: Update a Zipkin plugin description: Update a Zipkin plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ZipkinPlugin' responses: '200': description: Zipkin plugin content: application/json: schema: $ref: '#/components/schemas/ZipkinPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#ACL': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginACL#create operationId: create-acl-plugin summary: Create a ACL plugin description: Create a ACL plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ACLPlugin' responses: '201': description: Created ACL plugin content: application/json: schema: $ref: '#/components/schemas/ACLPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Acme': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAcme#create operationId: create-acme-plugin summary: Create a Acme plugin description: Create a Acme plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AcmePlugin' responses: '201': description: Created Acme plugin content: application/json: schema: $ref: '#/components/schemas/AcmePlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiAwsGuardrails': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiAwsGuardrails#create operationId: create-aiawsguardrails-plugin summary: Create a AiAwsGuardrails plugin description: Create a AiAwsGuardrails plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiAwsGuardrailsPlugin' responses: '201': description: Created AiAwsGuardrails plugin content: application/json: schema: $ref: '#/components/schemas/AiAwsGuardrailsPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiAzureContentSafety': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiAzureContentSafety#create operationId: create-aiazurecontentsafety-plugin summary: Create a AiAzureContentSafety plugin description: Create a AiAzureContentSafety plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiAzureContentSafetyPlugin' responses: '201': description: Created AiAzureContentSafety plugin content: application/json: schema: $ref: '#/components/schemas/AiAzureContentSafetyPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiPromptCompressor': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptCompressor#create operationId: create-aipromptcompressor-plugin summary: Create a AiPromptCompressor plugin description: Create a AiPromptCompressor plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiPromptCompressorPlugin' responses: '201': description: Created AiPromptCompressor plugin content: application/json: schema: $ref: '#/components/schemas/AiPromptCompressorPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiPromptDecorator': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptDecorator#create operationId: create-aipromptdecorator-plugin summary: Create a AiPromptDecorator plugin description: Create a AiPromptDecorator plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiPromptDecoratorPlugin' responses: '201': description: Created AiPromptDecorator plugin content: application/json: schema: $ref: '#/components/schemas/AiPromptDecoratorPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiPromptGuard': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptGuard#create operationId: create-aipromptguard-plugin summary: Create a AiPromptGuard plugin description: Create a AiPromptGuard plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiPromptGuardPlugin' responses: '201': description: Created AiPromptGuard plugin content: application/json: schema: $ref: '#/components/schemas/AiPromptGuardPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiPromptTemplate': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiPromptTemplate#create operationId: create-aiprompttemplate-plugin summary: Create a AiPromptTemplate plugin description: Create a AiPromptTemplate plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiPromptTemplatePlugin' responses: '201': description: Created AiPromptTemplate plugin content: application/json: schema: $ref: '#/components/schemas/AiPromptTemplatePlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiProxy': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiProxy#create operationId: create-aiproxy-plugin summary: Create a AiProxy plugin description: Create a AiProxy plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiProxyPlugin' responses: '201': description: Created AiProxy plugin content: application/json: schema: $ref: '#/components/schemas/AiProxyPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiProxyAdvanced': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiProxyAdvanced#create operationId: create-aiproxyadvanced-plugin summary: Create a AiProxyAdvanced plugin description: Create a AiProxyAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiProxyAdvancedPlugin' responses: '201': description: Created AiProxyAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/AiProxyAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiRagInjector': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiRagInjector#create operationId: create-airaginjector-plugin summary: Create a AiRagInjector plugin description: Create a AiRagInjector plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiRagInjectorPlugin' responses: '201': description: Created AiRagInjector plugin content: application/json: schema: $ref: '#/components/schemas/AiRagInjectorPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiRateLimitingAdvanced': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiRateLimitingAdvanced#create operationId: create-airatelimitingadvanced-plugin summary: Create a AiRateLimitingAdvanced plugin description: Create a AiRateLimitingAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiRateLimitingAdvancedPlugin' responses: '201': description: Created AiRateLimitingAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/AiRateLimitingAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiRequestTransformer': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiRequestTransformer#create operationId: create-airequesttransformer-plugin summary: Create a AiRequestTransformer plugin description: Create a AiRequestTransformer plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiRequestTransformerPlugin' responses: '201': description: Created AiRequestTransformer plugin content: application/json: schema: $ref: '#/components/schemas/AiRequestTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiResponseTransformer': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiResponseTransformer#create operationId: create-airesponsetransformer-plugin summary: Create a AiResponseTransformer plugin description: Create a AiResponseTransformer plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiResponseTransformerPlugin' responses: '201': description: Created AiResponseTransformer plugin content: application/json: schema: $ref: '#/components/schemas/AiResponseTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiSanitizer': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiSanitizer#create operationId: create-aisanitizer-plugin summary: Create a AiSanitizer plugin description: Create a AiSanitizer plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiSanitizerPlugin' responses: '201': description: Created AiSanitizer plugin content: application/json: schema: $ref: '#/components/schemas/AiSanitizerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiSemanticCache': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiSemanticCache#create operationId: create-aisemanticcache-plugin summary: Create a AiSemanticCache plugin description: Create a AiSemanticCache plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiSemanticCachePlugin' responses: '201': description: Created AiSemanticCache plugin content: application/json: schema: $ref: '#/components/schemas/AiSemanticCachePlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AiSemanticPromptGuard': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAiSemanticPromptGuard#create operationId: create-aisemanticpromptguard-plugin summary: Create a AiSemanticPromptGuard plugin description: Create a AiSemanticPromptGuard plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiSemanticPromptGuardPlugin' responses: '201': description: Created AiSemanticPromptGuard plugin content: application/json: schema: $ref: '#/components/schemas/AiSemanticPromptGuardPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AwsLambda': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAwsLambda#create operationId: create-awslambda-plugin summary: Create a AwsLambda plugin description: Create a AwsLambda plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AwsLambdaPlugin' responses: '201': description: Created AwsLambda plugin content: application/json: schema: $ref: '#/components/schemas/AwsLambdaPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#AzureFunctions': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginAzureFunctions#create operationId: create-azurefunctions-plugin summary: Create a AzureFunctions plugin description: Create a AzureFunctions plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AzureFunctionsPlugin' responses: '201': description: Created AzureFunctions plugin content: application/json: schema: $ref: '#/components/schemas/AzureFunctionsPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#BasicAuth': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginBasicAuth#create operationId: create-basicauth-plugin summary: Create a BasicAuth plugin description: Create a BasicAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BasicAuthPlugin' responses: '201': description: Created BasicAuth plugin content: application/json: schema: $ref: '#/components/schemas/BasicAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#BotDetection': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginBotDetection#create operationId: create-botdetection-plugin summary: Create a BotDetection plugin description: Create a BotDetection plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BotDetectionPlugin' responses: '201': description: Created BotDetection plugin content: application/json: schema: $ref: '#/components/schemas/BotDetectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Canary': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginCanary#create operationId: create-canary-plugin summary: Create a Canary plugin description: Create a Canary plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CanaryPlugin' responses: '201': description: Created Canary plugin content: application/json: schema: $ref: '#/components/schemas/CanaryPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Confluent': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginConfluent#create operationId: create-confluent-plugin summary: Create a Confluent plugin description: Create a Confluent plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConfluentPlugin' responses: '201': description: Created Confluent plugin content: application/json: schema: $ref: '#/components/schemas/ConfluentPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#ConfluentConsume': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginConfluentConsume#create operationId: create-confluentconsume-plugin summary: Create a ConfluentConsume plugin description: Create a ConfluentConsume plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConfluentConsumePlugin' responses: '201': description: Created ConfluentConsume plugin content: application/json: schema: $ref: '#/components/schemas/ConfluentConsumePlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#CorrelationId': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginCorrelationId#create operationId: create-correlationid-plugin summary: Create a CorrelationId plugin description: Create a CorrelationId plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CorrelationIdPlugin' responses: '201': description: Created CorrelationId plugin content: application/json: schema: $ref: '#/components/schemas/CorrelationIdPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Cors': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginCors#create operationId: create-cors-plugin summary: Create a Cors plugin description: Create a Cors plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CorsPlugin' responses: '201': description: Created Cors plugin content: application/json: schema: $ref: '#/components/schemas/CorsPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Datadog': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDatadog#create operationId: create-datadog-plugin summary: Create a Datadog plugin description: Create a Datadog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DatadogPlugin' responses: '201': description: Created Datadog plugin content: application/json: schema: $ref: '#/components/schemas/DatadogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#DatadogTracing': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDatadogTracing#create operationId: create-datadogtracing-plugin summary: Create a DatadogTracing plugin description: Create a DatadogTracing plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DatadogTracingPlugin' responses: '201': description: Created DatadogTracing plugin content: application/json: schema: $ref: '#/components/schemas/DatadogTracingPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Datakit': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDatakit#create operationId: create-datakit-plugin summary: Create a Datakit plugin description: Create a Datakit plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DatakitPlugin' responses: '201': description: Created Datakit plugin content: application/json: schema: $ref: '#/components/schemas/DatakitPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Degraphql': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginDegraphql#create operationId: create-degraphql-plugin summary: Create a Degraphql plugin description: Create a Degraphql plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DegraphqlPlugin' responses: '201': description: Created Degraphql plugin content: application/json: schema: $ref: '#/components/schemas/DegraphqlPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#ExitTransformer': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginExitTransformer#create operationId: create-exittransformer-plugin summary: Create a ExitTransformer plugin description: Create a ExitTransformer plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExitTransformerPlugin' responses: '201': description: Created ExitTransformer plugin content: application/json: schema: $ref: '#/components/schemas/ExitTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#FileLog': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginFileLog#create operationId: create-filelog-plugin summary: Create a FileLog plugin description: Create a FileLog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FileLogPlugin' responses: '201': description: Created FileLog plugin content: application/json: schema: $ref: '#/components/schemas/FileLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#ForwardProxy': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginForwardProxy#create operationId: create-forwardproxy-plugin summary: Create a ForwardProxy plugin description: Create a ForwardProxy plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ForwardProxyPlugin' responses: '201': description: Created ForwardProxy plugin content: application/json: schema: $ref: '#/components/schemas/ForwardProxyPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#GraphqlProxyCacheAdvanced': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGraphqlProxyCacheAdvanced#create operationId: create-graphqlproxycacheadvanced-plugin summary: Create a GraphqlProxyCacheAdvanced plugin description: Create a GraphqlProxyCacheAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GraphqlProxyCacheAdvancedPlugin' responses: '201': description: Created GraphqlProxyCacheAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/GraphqlProxyCacheAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#GraphqlRateLimitingAdvanced': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGraphqlRateLimitingAdvanced#create operationId: create-graphqlratelimitingadvanced-plugin summary: Create a GraphqlRateLimitingAdvanced plugin description: Create a GraphqlRateLimitingAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GraphqlRateLimitingAdvancedPlugin' responses: '201': description: Created GraphqlRateLimitingAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/GraphqlRateLimitingAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#GrpcGateway': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGrpcGateway#create operationId: create-grpcgateway-plugin summary: Create a GrpcGateway plugin description: Create a GrpcGateway plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GrpcGatewayPlugin' responses: '201': description: Created GrpcGateway plugin content: application/json: schema: $ref: '#/components/schemas/GrpcGatewayPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#GrpcWeb': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginGrpcWeb#create operationId: create-grpcweb-plugin summary: Create a GrpcWeb plugin description: Create a GrpcWeb plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GrpcWebPlugin' responses: '201': description: Created GrpcWeb plugin content: application/json: schema: $ref: '#/components/schemas/GrpcWebPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#HeaderCertAuth': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginHeaderCertAuth#create operationId: create-headercertauth-plugin summary: Create a HeaderCertAuth plugin description: Create a HeaderCertAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/HeaderCertAuthPlugin' responses: '201': description: Created HeaderCertAuth plugin content: application/json: schema: $ref: '#/components/schemas/HeaderCertAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#HmacAuth': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginHmacAuth#create operationId: create-hmacauth-plugin summary: Create a HmacAuth plugin description: Create a HmacAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/HmacAuthPlugin' responses: '201': description: Created HmacAuth plugin content: application/json: schema: $ref: '#/components/schemas/HmacAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#HttpLog': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginHttpLog#create operationId: create-httplog-plugin summary: Create a HttpLog plugin description: Create a HttpLog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/HttpLogPlugin' responses: '201': description: Created HttpLog plugin content: application/json: schema: $ref: '#/components/schemas/HttpLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#InjectionProtection': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginInjectionProtection#create operationId: create-injectionprotection-plugin summary: Create a InjectionProtection plugin description: Create a InjectionProtection plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InjectionProtectionPlugin' responses: '201': description: Created InjectionProtection plugin content: application/json: schema: $ref: '#/components/schemas/InjectionProtectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#IpRestriction': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginIpRestriction#create operationId: create-iprestriction-plugin summary: Create a IpRestriction plugin description: Create a IpRestriction plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/IpRestrictionPlugin' responses: '201': description: Created IpRestriction plugin content: application/json: schema: $ref: '#/components/schemas/IpRestrictionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Jq': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJq#create operationId: create-jq-plugin summary: Create a Jq plugin description: Create a Jq plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JqPlugin' responses: '201': description: Created Jq plugin content: application/json: schema: $ref: '#/components/schemas/JqPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#JsonThreatProtection': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJsonThreatProtection#create operationId: create-jsonthreatprotection-plugin summary: Create a JsonThreatProtection plugin description: Create a JsonThreatProtection plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JsonThreatProtectionPlugin' responses: '201': description: Created JsonThreatProtection plugin content: application/json: schema: $ref: '#/components/schemas/JsonThreatProtectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#JweDecrypt': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJweDecrypt#create operationId: create-jwedecrypt-plugin summary: Create a JweDecrypt plugin description: Create a JweDecrypt plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JweDecryptPlugin' responses: '201': description: Created JweDecrypt plugin content: application/json: schema: $ref: '#/components/schemas/JweDecryptPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Jwt': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJwt#create operationId: create-jwt-plugin summary: Create a Jwt plugin description: Create a Jwt plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JwtPlugin' responses: '201': description: Created Jwt plugin content: application/json: schema: $ref: '#/components/schemas/JwtPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#JwtSigner': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginJwtSigner#create operationId: create-jwtsigner-plugin summary: Create a JwtSigner plugin description: Create a JwtSigner plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JwtSignerPlugin' responses: '201': description: Created JwtSigner plugin content: application/json: schema: $ref: '#/components/schemas/JwtSignerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#KafkaConsume': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKafkaConsume#create operationId: create-kafkaconsume-plugin summary: Create a KafkaConsume plugin description: Create a KafkaConsume plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KafkaConsumePlugin' responses: '201': description: Created KafkaConsume plugin content: application/json: schema: $ref: '#/components/schemas/KafkaConsumePlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#KafkaLog': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKafkaLog#create operationId: create-kafkalog-plugin summary: Create a KafkaLog plugin description: Create a KafkaLog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KafkaLogPlugin' responses: '201': description: Created KafkaLog plugin content: application/json: schema: $ref: '#/components/schemas/KafkaLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#KafkaUpstream': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKafkaUpstream#create operationId: create-kafkaupstream-plugin summary: Create a KafkaUpstream plugin description: Create a KafkaUpstream plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KafkaUpstreamPlugin' responses: '201': description: Created KafkaUpstream plugin content: application/json: schema: $ref: '#/components/schemas/KafkaUpstreamPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#KeyAuth': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKeyAuth#create operationId: create-keyauth-plugin summary: Create a KeyAuth plugin description: Create a KeyAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KeyAuthPlugin' responses: '201': description: Created KeyAuth plugin content: application/json: schema: $ref: '#/components/schemas/KeyAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#KeyAuthEnc': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginKeyAuthEnc#create operationId: create-keyauthenc-plugin summary: Create a KeyAuthEnc plugin description: Create a KeyAuthEnc plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KeyAuthEncPlugin' responses: '201': description: Created KeyAuthEnc plugin content: application/json: schema: $ref: '#/components/schemas/KeyAuthEncPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#LdapAuth': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginLdapAuth#create operationId: create-ldapauth-plugin summary: Create a LdapAuth plugin description: Create a LdapAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LdapAuthPlugin' responses: '201': description: Created LdapAuth plugin content: application/json: schema: $ref: '#/components/schemas/LdapAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#LdapAuthAdvanced': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginLdapAuthAdvanced#create operationId: create-ldapauthadvanced-plugin summary: Create a LdapAuthAdvanced plugin description: Create a LdapAuthAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LdapAuthAdvancedPlugin' responses: '201': description: Created LdapAuthAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/LdapAuthAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Loggly': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginLoggly#create operationId: create-loggly-plugin summary: Create a Loggly plugin description: Create a Loggly plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LogglyPlugin' responses: '201': description: Created Loggly plugin content: application/json: schema: $ref: '#/components/schemas/LogglyPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Mocking': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginMocking#create operationId: create-mocking-plugin summary: Create a Mocking plugin description: Create a Mocking plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MockingPlugin' responses: '201': description: Created Mocking plugin content: application/json: schema: $ref: '#/components/schemas/MockingPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#MtlsAuth': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginMtlsAuth#create operationId: create-mtlsauth-plugin summary: Create a MtlsAuth plugin description: Create a MtlsAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MtlsAuthPlugin' responses: '201': description: Created MtlsAuth plugin content: application/json: schema: $ref: '#/components/schemas/MtlsAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#OasValidation': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOasValidation#create operationId: create-oasvalidation-plugin summary: Create a OasValidation plugin description: Create a OasValidation plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OasValidationPlugin' responses: '201': description: Created OasValidation plugin content: application/json: schema: $ref: '#/components/schemas/OasValidationPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Oauth2Introspection': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOauth2Introspection#create operationId: create-oauth2introspection-plugin summary: Create a Oauth2Introspection plugin description: Create a Oauth2Introspection plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Oauth2IntrospectionPlugin' responses: '201': description: Created Oauth2Introspection plugin content: application/json: schema: $ref: '#/components/schemas/Oauth2IntrospectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Opa': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOpa#create operationId: create-opa-plugin summary: Create a Opa plugin description: Create a Opa plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpaPlugin' responses: '201': description: Created Opa plugin content: application/json: schema: $ref: '#/components/schemas/OpaPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#OpenidConnect': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOpenidConnect#create operationId: create-openidconnect-plugin summary: Create a OpenidConnect plugin description: Create a OpenidConnect plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpenidConnectPlugin' responses: '201': description: Created OpenidConnect plugin content: application/json: schema: $ref: '#/components/schemas/OpenidConnectPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Opentelemetry': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginOpentelemetry#create operationId: create-opentelemetry-plugin summary: Create a Opentelemetry plugin description: Create a Opentelemetry plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpentelemetryPlugin' responses: '201': description: Created Opentelemetry plugin content: application/json: schema: $ref: '#/components/schemas/OpentelemetryPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#PostFunction': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginPostFunction#create operationId: create-postfunction-plugin summary: Create a PostFunction plugin description: Create a PostFunction plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostFunctionPlugin' responses: '201': description: Created PostFunction plugin content: application/json: schema: $ref: '#/components/schemas/PostFunctionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#PreFunction': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginPreFunction#create operationId: create-prefunction-plugin summary: Create a PreFunction plugin description: Create a PreFunction plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PreFunctionPlugin' responses: '201': description: Created PreFunction plugin content: application/json: schema: $ref: '#/components/schemas/PreFunctionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Prometheus': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginPrometheus#create operationId: create-prometheus-plugin summary: Create a Prometheus plugin description: Create a Prometheus plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PrometheusPlugin' responses: '201': description: Created Prometheus plugin content: application/json: schema: $ref: '#/components/schemas/PrometheusPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#ProxyCache': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginProxyCache#create operationId: create-proxycache-plugin summary: Create a ProxyCache plugin description: Create a ProxyCache plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProxyCachePlugin' responses: '201': description: Created ProxyCache plugin content: application/json: schema: $ref: '#/components/schemas/ProxyCachePlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#ProxyCacheAdvanced': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginProxyCacheAdvanced#create operationId: create-proxycacheadvanced-plugin summary: Create a ProxyCacheAdvanced plugin description: Create a ProxyCacheAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProxyCacheAdvancedPlugin' responses: '201': description: Created ProxyCacheAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/ProxyCacheAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#RateLimiting': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRateLimiting#create operationId: create-ratelimiting-plugin summary: Create a RateLimiting plugin description: Create a RateLimiting plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RateLimitingPlugin' responses: '201': description: Created RateLimiting plugin content: application/json: schema: $ref: '#/components/schemas/RateLimitingPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#RateLimitingAdvanced': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRateLimitingAdvanced#create operationId: create-ratelimitingadvanced-plugin summary: Create a RateLimitingAdvanced plugin description: Create a RateLimitingAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RateLimitingAdvancedPlugin' responses: '201': description: Created RateLimitingAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/RateLimitingAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Redirect': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRedirect#create operationId: create-redirect-plugin summary: Create a Redirect plugin description: Create a Redirect plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RedirectPlugin' responses: '201': description: Created Redirect plugin content: application/json: schema: $ref: '#/components/schemas/RedirectPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#RequestCallout': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestCallout#create operationId: create-requestcallout-plugin summary: Create a RequestCallout plugin description: Create a RequestCallout plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestCalloutPlugin' responses: '201': description: Created RequestCallout plugin content: application/json: schema: $ref: '#/components/schemas/RequestCalloutPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#RequestSizeLimiting': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestSizeLimiting#create operationId: create-requestsizelimiting-plugin summary: Create a RequestSizeLimiting plugin description: Create a RequestSizeLimiting plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestSizeLimitingPlugin' responses: '201': description: Created RequestSizeLimiting plugin content: application/json: schema: $ref: '#/components/schemas/RequestSizeLimitingPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#RequestTermination': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestTermination#create operationId: create-requesttermination-plugin summary: Create a RequestTermination plugin description: Create a RequestTermination plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestTerminationPlugin' responses: '201': description: Created RequestTermination plugin content: application/json: schema: $ref: '#/components/schemas/RequestTerminationPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#RequestTransformer': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestTransformer#create operationId: create-requesttransformer-plugin summary: Create a RequestTransformer plugin description: Create a RequestTransformer plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestTransformerPlugin' responses: '201': description: Created RequestTransformer plugin content: application/json: schema: $ref: '#/components/schemas/RequestTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#RequestTransformerAdvanced': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestTransformerAdvanced#create operationId: create-requesttransformeradvanced-plugin summary: Create a RequestTransformerAdvanced plugin description: Create a RequestTransformerAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestTransformerAdvancedPlugin' responses: '201': description: Created RequestTransformerAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/RequestTransformerAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#RequestValidator': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRequestValidator#create operationId: create-requestvalidator-plugin summary: Create a RequestValidator plugin description: Create a RequestValidator plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestValidatorPlugin' responses: '201': description: Created RequestValidator plugin content: application/json: schema: $ref: '#/components/schemas/RequestValidatorPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#ResponseRatelimiting': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginResponseRatelimiting#create operationId: create-responseratelimiting-plugin summary: Create a ResponseRatelimiting plugin description: Create a ResponseRatelimiting plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResponseRatelimitingPlugin' responses: '201': description: Created ResponseRatelimiting plugin content: application/json: schema: $ref: '#/components/schemas/ResponseRatelimitingPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#ResponseTransformer': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginResponseTransformer#create operationId: create-responsetransformer-plugin summary: Create a ResponseTransformer plugin description: Create a ResponseTransformer plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResponseTransformerPlugin' responses: '201': description: Created ResponseTransformer plugin content: application/json: schema: $ref: '#/components/schemas/ResponseTransformerPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#ResponseTransformerAdvanced': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginResponseTransformerAdvanced#create operationId: create-responsetransformeradvanced-plugin summary: Create a ResponseTransformerAdvanced plugin description: Create a ResponseTransformerAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResponseTransformerAdvancedPlugin' responses: '201': description: Created ResponseTransformerAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/ResponseTransformerAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#RouteByHeader': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRouteByHeader#create operationId: create-routebyheader-plugin summary: Create a RouteByHeader plugin description: Create a RouteByHeader plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RouteByHeaderPlugin' responses: '201': description: Created RouteByHeader plugin content: application/json: schema: $ref: '#/components/schemas/RouteByHeaderPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#RouteTransformerAdvanced': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginRouteTransformerAdvanced#create operationId: create-routetransformeradvanced-plugin summary: Create a RouteTransformerAdvanced plugin description: Create a RouteTransformerAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RouteTransformerAdvancedPlugin' responses: '201': description: Created RouteTransformerAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/RouteTransformerAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Saml': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSaml#create operationId: create-saml-plugin summary: Create a Saml plugin description: Create a Saml plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SamlPlugin' responses: '201': description: Created Saml plugin content: application/json: schema: $ref: '#/components/schemas/SamlPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#ServiceProtection': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginServiceProtection#create operationId: create-serviceprotection-plugin summary: Create a ServiceProtection plugin description: Create a ServiceProtection plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ServiceProtectionPlugin' responses: '201': description: Created ServiceProtection plugin content: application/json: schema: $ref: '#/components/schemas/ServiceProtectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Session': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSession#create operationId: create-session-plugin summary: Create a Session plugin description: Create a Session plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SessionPlugin' responses: '201': description: Created Session plugin content: application/json: schema: $ref: '#/components/schemas/SessionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#SolaceUpstream': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSolaceUpstream#create operationId: create-solaceupstream-plugin summary: Create a SolaceUpstream plugin description: Create a SolaceUpstream plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SolaceUpstreamPlugin' responses: '201': description: Created SolaceUpstream plugin content: application/json: schema: $ref: '#/components/schemas/SolaceUpstreamPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#StandardWebhooks': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginStandardWebhooks#create operationId: create-standardwebhooks-plugin summary: Create a StandardWebhooks plugin description: Create a StandardWebhooks plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StandardWebhooksPlugin' responses: '201': description: Created StandardWebhooks plugin content: application/json: schema: $ref: '#/components/schemas/StandardWebhooksPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Statsd': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginStatsd#create operationId: create-statsd-plugin summary: Create a Statsd plugin description: Create a Statsd plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StatsdPlugin' responses: '201': description: Created Statsd plugin content: application/json: schema: $ref: '#/components/schemas/StatsdPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#StatsdAdvanced': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginStatsdAdvanced#create operationId: create-statsdadvanced-plugin summary: Create a StatsdAdvanced plugin description: Create a StatsdAdvanced plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StatsdAdvancedPlugin' responses: '201': description: Created StatsdAdvanced plugin content: application/json: schema: $ref: '#/components/schemas/StatsdAdvancedPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Syslog': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginSyslog#create operationId: create-syslog-plugin summary: Create a Syslog plugin description: Create a Syslog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SyslogPlugin' responses: '201': description: Created Syslog plugin content: application/json: schema: $ref: '#/components/schemas/SyslogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#TcpLog': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginTcpLog#create operationId: create-tcplog-plugin summary: Create a TcpLog plugin description: Create a TcpLog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TcpLogPlugin' responses: '201': description: Created TcpLog plugin content: application/json: schema: $ref: '#/components/schemas/TcpLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#TlsHandshakeModifier': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginTlsHandshakeModifier#create operationId: create-tlshandshakemodifier-plugin summary: Create a TlsHandshakeModifier plugin description: Create a TlsHandshakeModifier plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TlsHandshakeModifierPlugin' responses: '201': description: Created TlsHandshakeModifier plugin content: application/json: schema: $ref: '#/components/schemas/TlsHandshakeModifierPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#TlsMetadataHeaders': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginTlsMetadataHeaders#create operationId: create-tlsmetadataheaders-plugin summary: Create a TlsMetadataHeaders plugin description: Create a TlsMetadataHeaders plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TlsMetadataHeadersPlugin' responses: '201': description: Created TlsMetadataHeaders plugin content: application/json: schema: $ref: '#/components/schemas/TlsMetadataHeadersPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#UdpLog': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginUdpLog#create operationId: create-udplog-plugin summary: Create a UdpLog plugin description: Create a UdpLog plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UdpLogPlugin' responses: '201': description: Created UdpLog plugin content: application/json: schema: $ref: '#/components/schemas/UdpLogPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#UpstreamOauth': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginUpstreamOauth#create operationId: create-upstreamoauth-plugin summary: Create a UpstreamOauth plugin description: Create a UpstreamOauth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpstreamOauthPlugin' responses: '201': description: Created UpstreamOauth plugin content: application/json: schema: $ref: '#/components/schemas/UpstreamOauthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#UpstreamTimeout': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginUpstreamTimeout#create operationId: create-upstreamtimeout-plugin summary: Create a UpstreamTimeout plugin description: Create a UpstreamTimeout plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpstreamTimeoutPlugin' responses: '201': description: Created UpstreamTimeout plugin content: application/json: schema: $ref: '#/components/schemas/UpstreamTimeoutPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#VaultAuth': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginVaultAuth#create operationId: create-vaultauth-plugin summary: Create a VaultAuth plugin description: Create a VaultAuth plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VaultAuthPlugin' responses: '201': description: Created VaultAuth plugin content: application/json: schema: $ref: '#/components/schemas/VaultAuthPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#WebsocketSizeLimit': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginWebsocketSizeLimit#create operationId: create-websocketsizelimit-plugin summary: Create a WebsocketSizeLimit plugin description: Create a WebsocketSizeLimit plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebsocketSizeLimitPlugin' responses: '201': description: Created WebsocketSizeLimit plugin content: application/json: schema: $ref: '#/components/schemas/WebsocketSizeLimitPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#WebsocketValidator': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginWebsocketValidator#create operationId: create-websocketvalidator-plugin summary: Create a WebsocketValidator plugin description: Create a WebsocketValidator plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebsocketValidatorPlugin' responses: '201': description: Created WebsocketValidator plugin content: application/json: schema: $ref: '#/components/schemas/WebsocketValidatorPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#XmlThreatProtection': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginXmlThreatProtection#create operationId: create-xmlthreatprotection-plugin summary: Create a XmlThreatProtection plugin description: Create a XmlThreatProtection plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/XmlThreatProtectionPlugin' responses: '201': description: Created XmlThreatProtection plugin content: application/json: schema: $ref: '#/components/schemas/XmlThreatProtectionPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/plugins#Zipkin': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayPluginZipkin#create operationId: create-zipkin-plugin summary: Create a Zipkin plugin description: Create a Zipkin plugin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ZipkinPlugin' responses: '201': description: Created Zipkin plugin content: application/json: schema: $ref: '#/components/schemas/ZipkinPlugin' '401': $ref: '#/components/responses/HTTP401Error' tags: - Plugins '/v2/control-planes/{controlPlaneId}/core-entities/routes': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayRoute#create operationId: create-route summary: Create a new Route description: Create a new Route requestBody: description: Description of the new Route for creation required: true content: application/json: schema: $ref: '#/components/schemas/RouteJson' responses: '201': description: Successfully created Route content: application/json: schema: $ref: '#/components/schemas/RouteJson' '401': $ref: '#/components/responses/HTTP401Error' tags: - Routes '/v2/control-planes/{controlPlaneId}/core-entities/routes/{RouteId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayRoute#delete operationId: delete-route summary: Delete a Route description: Delete a Route parameters: - $ref: '#/components/parameters/RouteId' responses: '204': description: Successfully deleted Route or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Routes get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayRoute#read operationId: get-route summary: Fetch a Route description: Get a Route using ID or name. responses: '200': description: Successfully fetched Route content: application/json: schema: $ref: '#/components/schemas/RouteJson' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Routes parameters: - $ref: '#/components/parameters/RouteId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayRoute#update operationId: upsert-route summary: Upsert a Route description: Create or Update Route using ID or name. requestBody: description: Description of the Route required: true content: application/json: schema: $ref: '#/components/schemas/RouteJson' responses: '200': description: Successfully upserted Route content: application/json: schema: $ref: '#/components/schemas/RouteJson' '401': $ref: '#/components/responses/HTTP401Error' tags: - Routes '/v2/control-planes/{controlPlaneId}/core-entities/routes/{RouteId}#RouteExpression': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayRouteExpression#delete operationId: delete-route-RouteExpression summary: Delete a Route description: Delete a Route parameters: - $ref: '#/components/parameters/RouteId' responses: '204': description: Successfully deleted Route or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Routes get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayRouteExpression#read operationId: get-route-RouteExpression summary: Fetch a Route description: Get a Route using ID or name. responses: '200': description: Successfully fetched Route content: application/json: schema: $ref: '#/components/schemas/RouteExpression' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Routes parameters: - $ref: '#/components/parameters/RouteId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayRouteExpression#update operationId: upsert-route-RouteExpression summary: Upsert a Route description: Create or Update Route using ID or name. requestBody: description: Description of the Route required: true content: application/json: schema: $ref: '#/components/schemas/RouteExpression' responses: '200': description: Successfully upserted Route content: application/json: schema: $ref: '#/components/schemas/RouteExpression' '401': $ref: '#/components/responses/HTTP401Error' tags: - Routes '/v2/control-planes/{controlPlaneId}/core-entities/routes#RouteExpression': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayRouteExpression#create operationId: create-route-RouteExpression summary: Create a new Route description: Create a new Route requestBody: description: Description of the new Route for creation required: true content: application/json: schema: $ref: '#/components/schemas/RouteExpression' responses: '201': description: Successfully created Route content: application/json: schema: $ref: '#/components/schemas/RouteExpression' '401': $ref: '#/components/responses/HTTP401Error' tags: - Routes '/v2/control-planes/{controlPlaneId}/core-entities/schemas/plugins/{pluginName}': get: operationId: fetch-plugin-schema summary: Fetch plugin schema description: Get the schema for a plugin responses: '200': $ref: '#/components/responses/GetPluginSchemaResponse' tags: - Plugins parameters: - name: pluginName in: path description: The name of the plugin required: true schema: type: string - $ref: '#/components/parameters/controlPlaneId' '/v2/control-planes/{controlPlaneId}/core-entities/services': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayService#create operationId: create-service summary: Create a new Service description: Create a new Service requestBody: description: Description of the new Service for creation required: true content: application/json: schema: $ref: '#/components/schemas/Service' responses: '201': description: Successfully created Service content: application/json: schema: $ref: '#/components/schemas/Service' '401': $ref: '#/components/responses/HTTP401Error' tags: - Services '/v2/control-planes/{controlPlaneId}/core-entities/services/{ServiceId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayService#delete operationId: delete-service summary: Delete a Service description: Delete a Service parameters: - $ref: '#/components/parameters/ServiceId' responses: '204': description: Successfully deleted Service or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Services get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayService#read operationId: get-service summary: Fetch a Service description: Get a Service using ID or name. responses: '200': description: Successfully fetched Service content: application/json: schema: $ref: '#/components/schemas/Service' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Services parameters: - $ref: '#/components/parameters/ServiceId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayService#update operationId: upsert-service summary: Upsert a Service description: Create or Update Service using ID or name. requestBody: description: Description of the Service required: true content: application/json: schema: $ref: '#/components/schemas/Service' responses: '200': description: Successfully upserted Service content: application/json: schema: $ref: '#/components/schemas/Service' '401': $ref: '#/components/responses/HTTP401Error' tags: - Services '/v2/control-planes/{controlPlaneId}/core-entities/snis': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewaySNI#create operationId: create-sni summary: Create a new SNI description: Create a new SNI requestBody: description: Description of the new SNI for creation required: true content: application/json: schema: $ref: '#/components/schemas/SNI' responses: '201': description: Successfully created SNI content: application/json: schema: $ref: '#/components/schemas/SNI' '401': $ref: '#/components/responses/HTTP401Error' tags: - SNIs '/v2/control-planes/{controlPlaneId}/core-entities/snis/{SNIId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewaySNI#delete operationId: delete-sni summary: Delete an SNI description: Delete an SNI parameters: - $ref: '#/components/parameters/SNIId' responses: '204': description: Successfully deleted SNI or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - SNIs get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewaySNI#read operationId: get-sni summary: Fetch an SNI description: Get an SNI using ID or name. responses: '200': description: Successfully fetched SNI content: application/json: schema: $ref: '#/components/schemas/SNI' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - SNIs parameters: - $ref: '#/components/parameters/SNIId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewaySNI#update operationId: upsert-sni summary: Upsert a SNI description: Create or Update SNI using ID or name. 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' '401': $ref: '#/components/responses/HTTP401Error' tags: - SNIs '/v2/control-planes/{controlPlaneId}/core-entities/upstreams': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayUpstream#create operationId: create-upstream summary: Create a new Upstream description: Create a new Upstream requestBody: description: Description of the new Upstream for creation required: true content: application/json: schema: $ref: '#/components/schemas/Upstream' responses: '201': description: Successfully created Upstream content: application/json: schema: $ref: '#/components/schemas/Upstream' '401': $ref: '#/components/responses/HTTP401Error' tags: - Upstreams '/v2/control-planes/{controlPlaneId}/core-entities/upstreams/{UpstreamId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayUpstream#delete operationId: delete-upstream summary: Delete an Upstream description: Delete an Upstream parameters: - $ref: '#/components/parameters/UpstreamId' responses: '204': description: Successfully deleted Upstream or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Upstreams get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayUpstream#read operationId: get-upstream summary: Fetch an Upstream description: Get an Upstream using ID or name. responses: '200': description: Successfully fetched Upstream content: application/json: schema: $ref: '#/components/schemas/Upstream' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Upstreams parameters: - $ref: '#/components/parameters/UpstreamId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayUpstream#update operationId: upsert-upstream summary: Upsert a Upstream description: Create or Update Upstream using ID or name. requestBody: description: Description of the Upstream required: true content: application/json: schema: $ref: '#/components/schemas/Upstream' responses: '200': description: Successfully upserted Upstream content: application/json: schema: $ref: '#/components/schemas/Upstream' '401': $ref: '#/components/responses/HTTP401Error' tags: - Upstreams '/v2/control-planes/{controlPlaneId}/core-entities/upstreams/{UpstreamIdForTarget}/targets': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayTarget#create operationId: create-target-with-upstream summary: Create a new Target associated with an Upstream description: Create a new Target associated with an Upstream parameters: - $ref: '#/components/parameters/UpstreamIdForTarget' requestBody: description: Description of new Target for creation required: true content: application/json: schema: $ref: '#/components/schemas/TargetWithoutParents' responses: '201': description: Successfully created Target content: application/json: schema: $ref: '#/components/schemas/Target' tags: - Targets '/v2/control-planes/{controlPlaneId}/core-entities/upstreams/{UpstreamIdForTarget}/targets/{TargetId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayTarget#delete operationId: delete-target-with-upstream summary: Delete a a Target associated with an Upstream description: Delete a a Target associated with an Upstream using ID or target. parameters: - $ref: '#/components/parameters/UpstreamIdForTarget' - $ref: '#/components/parameters/TargetId' responses: '204': description: Successfully deleted Target or the resource didn't exist tags: - Targets get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayTarget#read operationId: get-target-with-upstream summary: Fetch a Target associated with an Upstream description: Get a Target associated with an Upstream using ID or target. parameters: - $ref: '#/components/parameters/UpstreamIdForTarget' - $ref: '#/components/parameters/TargetId' responses: '200': description: Successfully fetched Target content: application/json: schema: $ref: '#/components/schemas/Target' '404': description: Resource does not exist tags: - Targets parameters: - $ref: '#/components/parameters/controlPlaneId' '/v2/control-planes/{controlPlaneId}/core-entities/vaults': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayVault#create operationId: create-vault summary: Create a new Vault description: Create a new Vault requestBody: description: Description of the new Vault for creation required: true content: application/json: schema: $ref: '#/components/schemas/Vault' responses: '201': description: Successfully created Vault content: application/json: schema: $ref: '#/components/schemas/Vault' '401': $ref: '#/components/responses/HTTP401Error' tags: - Vaults '/v2/control-planes/{controlPlaneId}/core-entities/vaults/{VaultId}': delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayVault#delete operationId: delete-vault summary: Delete a Vault description: Delete a Vault parameters: - $ref: '#/components/parameters/VaultId' responses: '204': description: Successfully deleted Vault or the resource didn't exist '401': $ref: '#/components/responses/HTTP401Error' tags: - Vaults get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayVault#read operationId: get-vault summary: Fetch a Vault description: Get a Vault using ID or prefix. responses: '200': description: Successfully fetched Vault content: application/json: schema: $ref: '#/components/schemas/Vault' '401': $ref: '#/components/responses/HTTP401Error' '404': description: Resource does not exist tags: - Vaults parameters: - $ref: '#/components/parameters/VaultId' - $ref: '#/components/parameters/controlPlaneId' put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GatewayVault#update operationId: upsert-vault summary: Upsert a Vault description: Create or Update Vault using ID or prefix. requestBody: description: Description of the Vault required: true content: application/json: schema: $ref: '#/components/schemas/Vault' responses: '200': description: Successfully upserted Vault content: application/json: schema: $ref: '#/components/schemas/Vault' '401': $ref: '#/components/responses/HTTP401Error' tags: - Vaults '/v2/control-planes/{controlPlaneId}/dp-client-certificates': parameters: - $ref: '#/components/parameters/controlPlaneId' post: x-speakeasy-entity-operation: terraform-resource: GatewayDataPlaneClientCertificate#create terraform-datasource: null operationId: create-dataplane-certificate summary: Pin New DP Client Certificate description: Pin a new DP Client Certificate to this control plane. A pinned dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this control plane. requestBody: $ref: '#/components/requestBodies/DataPlaneClientCertificateRequest' responses: '201': $ref: '#/components/responses/DataPlaneClientCertificateResponse' '400': $ref: '#/components/responses/KonnectCPLegacyBadRequest' '401': $ref: '#/components/responses/KonnectCPLegacyUnauthorized' '403': $ref: '#/components/responses/KonnectCPLegacyForbidden' '404': $ref: '#/components/responses/KonnectCPLegacyNotFound' tags: - DP Certificates '/v2/control-planes/{controlPlaneId}/dp-client-certificates/{certificateId}': parameters: - $ref: '#/components/parameters/controlPlaneId' - $ref: '#/components/parameters/DataPlaneCertificateId' get: x-speakeasy-entity-operation: terraform-resource: GatewayDataPlaneClientCertificate#read terraform-datasource: null operationId: get-dataplane-certificate summary: Fetch DP Client Certificate description: Retrieve a pinned dataplane client certificate associated to this control plane. A pinned dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this control plane. responses: '200': $ref: '#/components/responses/DataPlaneClientCertificateResponse' '401': $ref: '#/components/responses/KonnectCPLegacyUnauthorized' '403': $ref: '#/components/responses/KonnectCPLegacyForbidden' '404': $ref: '#/components/responses/KonnectCPLegacyNotFound' tags: - DP Certificates delete: x-speakeasy-entity-operation: terraform-resource: GatewayDataPlaneClientCertificate#delete terraform-datasource: null operationId: delete-dataplane-certificate summary: Delete DP Client Certificate description: Remove a pinned dataplane client certificate associated to this control plane. Removing a pinned dataplane certificate would invalidate any dataplanes currently connected to this control plane using this certificate. responses: '204': description: No Content '401': $ref: '#/components/responses/KonnectCPLegacyUnauthorized' '403': $ref: '#/components/responses/KonnectCPLegacyForbidden' '404': $ref: '#/components/responses/KonnectCPLegacyNotFound' tags: - DP Certificates '/v2/control-planes/{id}': parameters: - name: id in: path description: The control plane ID required: true schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a get: x-speakeasy-entity-operation: terraform-resource: GatewayControlPlane#read terraform-datasource: null operationId: get-control-plane summary: Fetch Control Plane description: Returns information about an individual control plane. responses: '200': $ref: '#/components/responses/RetrieveControlPlaneResponse' '400': $ref: '#/components/responses/ControlPlanesBadRequest' '401': $ref: '#/components/responses/ControlPlaneUnauthenticated' '403': $ref: '#/components/responses/ControlPlanePermissionDenied' '404': $ref: '#/components/responses/ControlPlaneNotFound' '500': $ref: '#/components/responses/Internal' '503': $ref: '#/components/responses/ServiceUnavailable' tags: - Control Planes patch: x-speakeasy-entity-operation: terraform-resource: GatewayControlPlane#update terraform-datasource: null operationId: update-control-plane summary: Update Control Plane description: Update an individual control plane. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateControlPlaneRequest' responses: '200': $ref: '#/components/responses/UpdateControlPlaneResponse' '400': $ref: '#/components/responses/ControlPlanesBadRequest' '401': $ref: '#/components/responses/ControlPlaneUnauthenticated' '403': $ref: '#/components/responses/ControlPlanePermissionDenied' '404': $ref: '#/components/responses/ControlPlaneNotFound' '500': $ref: '#/components/responses/InternalServerError' '503': $ref: '#/components/responses/ServiceUnavailable' tags: - Control Planes delete: x-speakeasy-entity-operation: terraform-resource: GatewayControlPlane#delete terraform-datasource: null operationId: delete-control-plane summary: Delete Control Plane description: Delete an individual control plane. responses: '204': description: No Content '400': $ref: '#/components/responses/ControlPlanesBadRequest' '401': $ref: '#/components/responses/ControlPlaneUnauthenticated' '403': $ref: '#/components/responses/ControlPlanePermissionDenied' '404': $ref: '#/components/responses/ControlPlaneNotFound' '500': $ref: '#/components/responses/InternalServerError' '503': $ref: '#/components/responses/ServiceUnavailable' tags: - Control Planes '/v2/control-planes/{id}/group-memberships/add': parameters: - name: id in: path description: ID of a control plane group required: true schema: type: string post: x-speakeasy-entity-operation: terraform-resource: GatewayControlPlaneMembership#create terraform-datasource: null operationId: post-control-planes-id-group-memberships-add summary: Add Control Plane Group Members description: Adds one or more control planes as a member of a control plane group. requestBody: $ref: '#/components/requestBodies/GroupMembershipAdd' responses: '204': description: No Content '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/Internal' '503': $ref: '#/components/responses/ServiceUnavailable' tags: - Control Plane Groups '/v2/control-planes/{id}/group-memberships/remove': parameters: - name: id in: path description: ID of a control plane group required: true schema: type: string post: x-speakeasy-entity-operation: terraform-resource: GatewayControlPlaneMembership#delete terraform-datasource: null operationId: post-control-planes-id-group-memberships-remove summary: Remove Control Plane Group Members description: Removes one or more control planes from the members of a control plane group. requestBody: $ref: '#/components/requestBodies/GroupMembershipRemove' responses: '204': description: No Content '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/Internal' '503': $ref: '#/components/responses/ServiceUnavailable' tags: - Control Plane Groups /v2/portals: get: x-speakeasy-entity-operation: PortalList#read operationId: list-portals summary: List Portals description: 'Lists developer portals defined in this region for this organization. Each developer portal is available at a unique address and has isolated appearance, configuration, developers, and applications.' parameters: - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/SortPortals' responses: '200': $ref: '#/components/responses/ListPortals' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - Portals post: x-speakeasy-entity-operation: terraform-resource: Portal#create terraform-datasource: null operationId: create-portal summary: Create Portal description: Creates a new developer portal scoped in this region for this organization. requestBody: $ref: '#/components/requestBodies/CreatePortal' responses: '201': $ref: '#/components/responses/CreatePortal' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - Portals '/v2/portals/{portalId}': parameters: - name: portalId in: path description: ID of the portal. required: true schema: type: string format: uuid x-speakeasy-match: id get: x-speakeasy-entity-operation: terraform-resource: Portal#read terraform-datasource: null operationId: get-portal summary: Get Portal description: 'Returns the configuration for a single developer portal. This allows you to understand the current visibility, access, and domain settings.' responses: '200': $ref: '#/components/responses/GetPortal' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Portals patch: x-speakeasy-entity-operation: terraform-resource: Portal#update terraform-datasource: null operationId: update-portal summary: Update Portal description: 'Updates the configuration for a single portal including the visibility, access, and custom domain settings.' requestBody: $ref: '#/components/requestBodies/UpdatePortal' responses: '200': $ref: '#/components/responses/UpdatePortal' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' tags: - Portals delete: x-speakeasy-entity-operation: terraform-resource: Portal#delete terraform-datasource: null operationId: delete-portal summary: Delete Portal description: 'Deletes a single portal, along with all related entities. Will not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled, unless force=true query param is included in the request.' parameters: - name: force in: query description: 'If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled.' schema: type: string default: 'false' enum: - 'true' - 'false' responses: '204': description: No Content '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Portals '/v2/portals/{portalId}/appearance': get: x-speakeasy-entity-operation: terraform-resource: PortalAppearance#read terraform-datasource: null operationId: get-portal-appearance summary: Get Appearance Configuration description: 'Returns the current portal appearance configuration including any custom theme, colors, fonts, and image settings. Portals using the fully-customizable portal client may override or ignore these settings by disregarding them in the code.' parameters: - $ref: '#/components/parameters/PortalId' responses: '200': $ref: '#/components/responses/GetPortalAppearance' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Portal Appearance patch: x-speakeasy-entity-operation: terraform-resource: 'PortalAppearance#create,update' terraform-datasource: null operationId: update-portal-appearance summary: Update Appearance Configuration description: 'Updates the current appearance configuration for this portal including setting pre-defined or custom themes, fonts, colors, and images. Note that portals using the fully-customizable portal client may override or ignore these settings by disregarding them in the code.' parameters: - $ref: '#/components/parameters/PortalId' requestBody: $ref: '#/components/requestBodies/UpdatePortalAppearance' responses: '200': $ref: '#/components/responses/UpdatePortalAppearance' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Portal Appearance '/v2/portals/{portalId}/authentication-settings': parameters: - $ref: '#/components/parameters/PortalId' get: x-speakeasy-entity-operation: terraform-resource: PortalAuth#read terraform-datasource: null operationId: get-portal-authentication-settings summary: Get Auth Settings description: 'Returns the developer authentication configuration for a portal, which determines how developers can log in and how they are assigned to teams.' responses: '200': $ref: '#/components/responses/PortalAuthenticationSettings' '401': $ref: '#/components/responses/Unauthorized' tags: - Portal Auth Settings patch: x-speakeasy-entity-operation: terraform-resource: 'PortalAuth#create,update' terraform-datasource: null operationId: update-portal-authentication-settings summary: Update Auth Settings description: Updates the developer authentication configuration for a portal. Developers can be allowed to login using basic auth (email & password) or use Single-Sign-On (SSO) through an OIDC Identity Provider (IdP). Developers can be automatically assigned to teams by mapping claims from thier IdP account. requestBody: $ref: '#/components/requestBodies/UpdatePortalAuthenticationSettings' responses: '200': $ref: '#/components/responses/PortalAuthenticationSettings' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - Portal Auth Settings '/v2/portals/{portalId}/product-versions/{productVersionId}': parameters: - $ref: '#/components/parameters/ProductVersionId' - $ref: '#/components/parameters/PortalId' get: x-speakeasy-entity-operation: terraform-resource: PortalProductVersion#read terraform-datasource: null operationId: get-portal-product-version summary: Get a portal product version description: Get a portal product version responses: '200': $ref: '#/components/responses/PortalProductVersion' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Portal Product Versions put: x-speakeasy-entity-operation: terraform-resource: 'PortalProductVersion#create,update' terraform-datasource: null operationId: replace-portal-product-version summary: Replace a portal product version description: Replace a portal product version requestBody: $ref: '#/components/requestBodies/ReplacePortalProductVersion' responses: '200': $ref: '#/components/responses/PortalProductVersion' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Portal Product Versions delete: x-speakeasy-entity-operation: terraform-resource: PortalProductVersion#delete terraform-datasource: null operationId: delete-portal-product-version summary: Delete a portal product version description: Delete a portal product version responses: '204': description: No Content. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Portal Product Versions '/v2/portals/{portalId}/teams': parameters: - $ref: '#/components/parameters/PortalId' post: x-speakeasy-entity-operation: terraform-resource: PortalTeam#create terraform-datasource: null operationId: create-portal-team summary: Create Team description: Creates a developer team in a portal. Developers can be added to teams to provide RBAC access to API products. Teams can be assigned roles that grant permissions to perform an action on a resource. requestBody: $ref: '#/components/requestBodies/PortalCreateTeam' responses: '201': $ref: '#/components/responses/PortalTeam' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Portal Teams '/v2/portals/{portalId}/teams/{teamId}': parameters: - $ref: '#/components/parameters/TeamId' - $ref: '#/components/parameters/PortalId' get: x-speakeasy-entity-operation: terraform-resource: PortalTeam#read terraform-datasource: null operationId: get-portal-team summary: Get Team description: Get an individual team. responses: '200': $ref: '#/components/responses/PortalTeam' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Portal Teams patch: x-speakeasy-entity-operation: terraform-resource: PortalTeam#update terraform-datasource: null operationId: update-portal-team summary: Update Team description: Updates an individual developer team for a portal. requestBody: $ref: '#/components/requestBodies/PortalUpdateTeam' responses: '200': $ref: '#/components/responses/PortalTeam' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Portal Teams delete: x-speakeasy-entity-operation: terraform-resource: PortalTeam#delete terraform-datasource: null operationId: delete-portal-team summary: Delete Team description: 'Deletes a developer team from a portal. Deleting a team also deletes its assigned roles. Members of the team are not deleted, but they will lose any access provided through the team.' responses: '204': description: No Content '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' tags: - Portal Teams /v3/system-accounts: post: x-speakeasy-entity-operation: terraform-resource: SystemAccount#create terraform-datasource: null operationId: post-system-accounts summary: Create System Account description: Creates a system account. Returns a 409 if a system account with the same name already exists. requestBody: $ref: '#/components/requestBodies/CreateSystemAccount' responses: '201': $ref: '#/components/responses/SystemAccountSingle' '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' '409': $ref: '#/components/responses/IdentityConflict' servers: - url: 'https://global.api.konghq.com/' tags: - System Accounts '/v3/system-accounts/{accountId}': get: x-speakeasy-entity-operation: terraform-resource: SystemAccount#read terraform-datasource: null operationId: get-system-accounts-id summary: Fetch System Account description: Returns the system account (SA) for the SA ID specified as a path parameter. responses: '200': $ref: '#/components/responses/SystemAccountSingle' '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/IdentityNotFound' servers: - url: 'https://global.api.konghq.com/' tags: - System Accounts parameters: - name: accountId in: path description: ID of the system account. required: true schema: type: string x-speakeasy-match: id patch: x-speakeasy-entity-operation: terraform-resource: SystemAccount#update terraform-datasource: null operationId: patch-system-accounts-id summary: Update System Account description: Updates the specified system account. Returns a 409 if the updated name is the same as another system account in the organization. requestBody: $ref: '#/components/requestBodies/UpdateSystemAccount' responses: '200': $ref: '#/components/responses/SystemAccountSingle' '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/IdentityNotFound' '409': $ref: '#/components/responses/IdentityConflict' servers: - url: 'https://global.api.konghq.com/' tags: - System Accounts delete: x-speakeasy-entity-operation: terraform-resource: SystemAccount#delete terraform-datasource: null operationId: delete-system-accounts-id summary: Delete System Account description: Deletes the specified system account. Returns 404 if the requested account was not found. responses: '204': description: No Content '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/IdentityNotFound' servers: - url: 'https://global.api.konghq.com/' tags: - System Accounts '/v3/system-accounts/{accountId}/access-tokens': parameters: - name: accountId in: path description: ID of the system account. required: true schema: type: string post: x-speakeasy-entity-operation: terraform-resource: SystemAccountAccessToken#create terraform-datasource: null operationId: post-system-accounts-id-access-tokens summary: Create System Account Access Token description: Creates an access token for the specified system account (SA). The access token can be used for authenticating API and CLI requests. The token will only be displayed once on creation. Returns a 409 if the system account already has a token with the same name. requestBody: $ref: '#/components/requestBodies/CreateSystemAccountAccessToken' responses: '201': $ref: '#/components/responses/SystemAccountAccessTokenCreated' '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/IdentityNotFound' '409': $ref: '#/components/responses/IdentityConflict' servers: - url: 'https://global.api.konghq.com/' tags: - System Accounts - Access Tokens '/v3/system-accounts/{accountId}/access-tokens/{tokenId}': get: x-speakeasy-entity-operation: terraform-resource: SystemAccountAccessToken#read terraform-datasource: null operationId: get-system-accounts-id-access-tokens-id summary: Fetch System Account Access Token description: Returns the system account (SA) access token for the SA Access Token ID specified as a path parameter. parameters: [] responses: '200': $ref: '#/components/responses/SystemAccountAccessTokenSingle' '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/IdentityNotFound' servers: - url: 'https://global.api.konghq.com/' tags: - System Accounts - Access Tokens parameters: - name: accountId in: path description: ID of the system account. required: true schema: type: string - name: tokenId in: path description: ID of the system account access token. required: true schema: type: string x-speakeasy-match: id patch: x-speakeasy-entity-operation: terraform-resource: SystemAccountAccessToken#update terraform-datasource: null operationId: patch-system-accounts-id-access-tokens-id summary: Update System Account Access Token description: Updates the specified access token. Returns a 409 if the updated name is the same as another token belonging to the specified system user. requestBody: $ref: '#/components/requestBodies/UpdateSystemAccountAccessToken' responses: '200': $ref: '#/components/responses/SystemAccountAccessTokenSingle' '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/IdentityNotFound' '409': $ref: '#/components/responses/IdentityConflict' servers: - url: 'https://global.api.konghq.com/' tags: - System Accounts - Access Tokens delete: x-speakeasy-entity-operation: terraform-resource: SystemAccountAccessToken#delete terraform-datasource: null operationId: delete-system-accounts-id-access-tokens-id summary: Delete System Account Access Token description: Deletes the specified token. Returns 404 if the token was not found. responses: '204': description: No Content '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/IdentityNotFound' servers: - url: 'https://global.api.konghq.com/' tags: - System Accounts - Access Tokens '/v3/system-accounts/{accountId}/assigned-roles': parameters: - name: accountId in: path description: ID of the system account. required: true schema: type: string post: x-speakeasy-entity-operation: terraform-resource: SystemAccountRole#create terraform-datasource: null operationId: post-system-accounts-accountId-assigned-roles summary: Create Assigned Role for System Account description: Assigns a role to a system account. Returns 409 if role is already assigned. requestBody: $ref: '#/components/requestBodies/AssignRole' responses: '201': $ref: '#/components/responses/AssignedRoleSingle' '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/IdentityNotFound' '409': $ref: '#/components/responses/IdentityConflict' servers: - url: 'https://global.api.konghq.com/' tags: - System Accounts - Roles '/v3/system-accounts/{accountId}/assigned-roles/{roleId}': parameters: - name: accountId in: path description: ID of the system account. required: true schema: type: string - name: roleId in: path description: ID of the role. required: true schema: type: string x-speakeasy-match: id delete: x-speakeasy-entity-operation: terraform-resource: SystemAccountRole#delete terraform-datasource: null operationId: delete-system-accounts-accountId-assigned-roles-roleId summary: Delete Assigned Role from System Account description: Removes an assigned role from a system account. Returns 404 if the system account or assigned role were not found. responses: '204': description: No Content '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/IdentityNotFound' servers: - url: 'https://global.api.konghq.com/' tags: - System Accounts - Roles /v3/teams: parameters: [] post: x-speakeasy-entity-operation: terraform-resource: Team#create terraform-datasource: null operationId: create-team summary: Create Team description: 'Creates a team in the Konnect Organization. ' requestBody: $ref: '#/components/requestBodies/CreateTeam' responses: '201': $ref: '#/components/responses/TeamSingle' '400': $ref: '#/components/responses/IdentityBadRequest' '403': $ref: '#/components/responses/IdentityPermissionDenied' servers: - url: 'https://global.api.konghq.com/' tags: - Teams '/v3/teams/{teamId}': parameters: - name: teamId in: path description: The team ID required: true schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a x-speakeasy-match: id get: x-speakeasy-entity-operation: terraform-resource: Team#read terraform-datasource: null operationId: get-team summary: Fetch Team description: Returns information about a team from a given team ID. responses: '200': $ref: '#/components/responses/TeamSingle' '400': $ref: '#/components/responses/IdentityBadRequest' '404': $ref: '#/components/responses/IdentityNotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Teams patch: x-speakeasy-entity-operation: terraform-resource: Team#update terraform-datasource: null operationId: update-team summary: Update Team description: Updates an individual team. requestBody: $ref: '#/components/requestBodies/UpdateTeam' responses: '200': $ref: '#/components/responses/TeamSingle' '400': $ref: '#/components/responses/IdentityBadRequest' '404': $ref: '#/components/responses/IdentityNotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Teams delete: x-speakeasy-entity-operation: terraform-resource: Team#delete terraform-datasource: null operationId: delete-team summary: Delete Team description: Deletes an individual team. Returns 404 if the team is not found. responses: '204': description: No Content '400': $ref: '#/components/responses/IdentityBadRequest' '404': $ref: '#/components/responses/IdentityNotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Teams '/v3/teams/{teamId}/assigned-roles': parameters: - name: teamId in: path description: The team ID required: true schema: type: string format: uuid example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe post: x-speakeasy-entity-operation: terraform-resource: TeamRole#create terraform-datasource: null operationId: teams-assign-role summary: Assign Team Role description: Assigns a role to a team. Returns 409 if role is already assigned. requestBody: $ref: '#/components/requestBodies/AssignRole' responses: '201': $ref: '#/components/responses/AssignedRoleSingle' '400': $ref: '#/components/responses/IdentityBadRequest' '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/IdentityPermissionDenied' '404': $ref: '#/components/responses/IdentityNotFound' '409': $ref: '#/components/responses/IdentityConflict' servers: - url: 'https://global.api.konghq.com/' tags: - Roles '/v3/teams/{teamId}/assigned-roles/{roleId}': parameters: - name: teamId in: path description: The team ID. required: true schema: type: string format: uuid example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe - name: roleId in: path description: The role ID. required: true schema: type: string format: uuid example: 8350205f-a305-4e39-abe9-bc082a80091a x-speakeasy-match: id delete: x-speakeasy-entity-operation: terraform-resource: TeamRole#delete terraform-datasource: null operationId: teams-remove-role summary: Remove Team Role description: Removes an assigned role from a team. Returns 404 if the requested team or assigned role were not found. responses: '204': description: No Content '400': $ref: '#/components/responses/IdentityBadRequest' '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/IdentityPermissionDenied' '404': $ref: '#/components/responses/IdentityNotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Roles '/v3/teams/{teamId}/system-accounts': parameters: - name: teamId in: path description: ID of the team. required: true schema: type: string post: x-speakeasy-entity-operation: terraform-resource: SystemAccountTeam#create terraform-datasource: null operationId: post-teams-teamId-system-accounts summary: Add System Account to a Team description: Adds a system account to a team. Returns a 409 if the system account is already a member of the team. requestBody: $ref: '#/components/requestBodies/AddSystemAccountToTeam' responses: '201': description: Created '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/IdentityNotFound' '409': $ref: '#/components/responses/IdentityConflict' servers: - url: 'https://global.api.konghq.com/' tags: - System Accounts - Team Membership '/v3/teams/{teamId}/system-accounts/{accountId}': parameters: - name: teamId in: path description: ID of the team. required: true schema: type: string - name: accountId in: path description: ID of the system account. required: true schema: type: string delete: x-speakeasy-entity-operation: terraform-resource: SystemAccountTeam#delete terraform-datasource: null operationId: delete-teams-teamId-system-accounts-accountId summary: Remove System Account From Team description: Removes a system account from a team. Returns 404 if the team or system account were not found. responses: '204': description: No Content '401': $ref: '#/components/responses/IdentityUnauthenticated' '403': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/IdentityNotFound' servers: - url: 'https://global.api.konghq.com/' tags: - System Accounts - Team Membership '/v3/teams/{teamId}/users': parameters: - name: teamId in: path description: ID of the team. required: true schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a post: x-speakeasy-entity-operation: terraform-resource: TeamUser#create terraform-datasource: null operationId: add-user-to-team summary: Add User description: Adds a user to a team. requestBody: $ref: '#/components/requestBodies/AddUserToTeam' responses: '201': description: Created '400': $ref: '#/components/responses/IdentityBadRequest' '404': $ref: '#/components/responses/IdentityNotFound' '409': $ref: '#/components/responses/IdentityConflict' servers: - url: 'https://global.api.konghq.com/' tags: - Team Membership '/v3/teams/{teamId}/users/{userId}': parameters: - name: userId in: path description: User ID required: true schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a - name: teamId in: path description: Team ID. required: true schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a delete: x-speakeasy-entity-operation: terraform-resource: TeamUser#delete terraform-datasource: null operationId: remove-user-from-team summary: Remove User description: |- Removes a user from a team. If the user was removed, returns a 204 empty response. Returns 404 if the user or team were not found. responses: '204': description: No Content '400': $ref: '#/components/responses/IdentityBadRequest' '404': $ref: '#/components/responses/IdentityNotFound' servers: - url: 'https://global.api.konghq.com/' tags: - Team Membership /v2/audit-log-webhook#delete: patch: x-speakeasy-entity-operation: terraform-resource: AuditLog#delete terraform-datasource: null operationId: delete-audit-log-webhook summary: Delete the audit log webhook description: Disables the audit log webhook. requestBody: description: The request schema to disable an audit log webhook. content: application/json: schema: type: object properties: enabled: description: Indicates that the data should not be sent to the webhook. type: boolean const: false required: true responses: '200': $ref: '#/components/responses/AuditLogWebhook' '400': $ref: '#/components/responses/WebhookBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' tags: - Audit Logs components: parameters: ACLId: description: ID of the ACL to lookup example: f28acbfa-c866-4587-b688-0208ac24df21 in: path name: ACLId required: true schema: type: string x-speakeasy-match: id AuditLogDestinationId: schema: type: string format: uuid name: auditLogDestinationId in: path required: true description: ID of the Audit Log Destination. x-speakeasy-match: id AuthStrategyId: name: authStrategyId description: Application auth strategy identifier in: path required: true schema: $ref: '#/components/schemas/UUID' x-speakeasy-match: id BasicAuthId: description: ID of the Basic-auth credential to lookup example: 80db1b58-ca7c-4d21-b92a-64eb07725872 in: path name: BasicAuthId required: true schema: type: string x-speakeasy-match: id CACertificateId: description: ID of the CA Certificate to lookup example: 3c31f18a-f27a-4f9b-8cd4-bf841554612f in: path name: CACertificateId required: true schema: type: string x-speakeasy-match: id CertificateId: description: ID of the Certificate to lookup example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7 in: path name: CertificateId required: true schema: type: string x-speakeasy-match: id ConfigurationId: name: configurationId in: path description: The ID of the configuration to operate on. required: true schema: $ref: '#/components/schemas/ConfigurationId' x-speakeasy-match: id ConsumerGroupId: description: ID of the Consumer Group to lookup example: '' in: path name: ConsumerGroupId required: true schema: type: string x-speakeasy-match: id ConsumerGroupIdManageConsumers: description: The UUID or name of the consumer group in: path name: ConsumerGroupId required: true schema: type: string example: cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b x-speakeasy-name-override: consumer_group_id ConsumerId: description: ID of the Consumer to lookup example: c1059869-6fa7-4329-a5f5-5946d14ca2c5 in: path name: ConsumerId required: true schema: type: string x-speakeasy-match: id ConsumerIdForNestedEntities: description: Consumer ID for nested entities example: f28acbfa-c866-4587-b688-0208ac24df21 in: path name: ConsumerIdForNestedEntities required: true schema: type: string x-speakeasy-name-override: consumer_id ControlPlaneFilter: name: filter description: Filters a collection of control-planes. required: false in: query schema: $ref: '#/components/schemas/ControlPlaneFilterParameters' style: deepObject ControlPlaneSort: name: sort description: | Sorts a collection of control-planes. Supported sort attributes are: - created_at required: false in: query schema: $ref: '#/components/schemas/SortQuery' CustomDomainId: name: customDomainId description: ID of the custom domain to operate on. required: true in: path schema: $ref: '#/components/schemas/CustomDomainId' x-speakeasy-match: id CustomPluginId: description: ID of the CustomPlugin to lookup example: '' in: path name: CustomPluginId required: true schema: type: string x-speakeasy-match: id DataPlaneCertificateId: name: certificateId in: path schema: type: string required: true x-speakeasy-match: id FilterByLabels: name: labels description: Filter control planes in the response by associated labels. in: query required: false schema: type: string example: 'key:value,existCheck' HMACAuthId: description: ID of the HMAC-auth credential to lookup example: 70e7b00b-72f2-471b-a5ce-9c4171775360 in: path name: HMACAuthId required: true schema: type: string x-speakeasy-match: id JWTId: description: ID of the JWT to lookup example: 4a7f5faa-8c96-46d6-8214-c87573ef2ac4 in: path name: JWTId required: true schema: type: string x-speakeasy-match: id KeyAuthId: description: ID of the API-key to lookup example: '' in: path name: KeyAuthId required: true schema: type: string x-speakeasy-match: id KeyId: description: ID of the Key to lookup example: bba22c06-a632-42be-a018-1b9ff357b5b9 in: path name: KeyId required: true schema: type: string x-speakeasy-match: id KeySetId: description: ID of the KeySet to lookup example: 6cc34248-50b4-4a81-9201-3bdf7a83f712 in: path name: KeySetId required: true schema: type: string x-speakeasy-match: id MTLSAuthId: description: ID of the MTLS-auth credential to lookup example: '' in: path name: MTLSAuthId required: true schema: type: string x-speakeasy-match: id NetworkId: name: networkId in: path description: The network to operate on. required: true schema: $ref: '#/components/schemas/NetworkId' x-speakeasy-match: id PageNumber: name: 'page[number]' description: Determines which page of the entities to retrieve. required: false in: query allowEmptyValue: true schema: type: integer example: 1 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 PartialId: description: ID of the Partial to lookup example: '' in: path name: PartialId required: true schema: type: string x-speakeasy-match: id PluginId: description: ID of the Plugin to lookup example: 3473c251-5b6c-4f45-b1ff-7ede735a366d in: path name: PluginId required: true schema: type: string x-speakeasy-match: id PortalId: schema: type: string format: uuid name: portalId in: path required: true description: ID of the portal. PrivateDnsId: name: privateDnsId in: path description: The ID of the Private DNS to operate on. required: true schema: $ref: '#/components/schemas/PrivateDnsId' x-speakeasy-match: id ProductVersionId: name: productVersionId description: API product version identifier in: path required: true schema: $ref: '#/components/schemas/UUID' RouteId: description: ID of the Route to lookup example: a4326a41-aa12-44e3-93e4-6b6e58bfb9d7 in: path name: RouteId required: true schema: type: string x-speakeasy-match: id SNIId: description: ID of the SNI to lookup example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f in: path name: SNIId required: true schema: type: string x-speakeasy-match: id ServiceId: description: ID of the Service to lookup example: 7fca84d6-7d37-4a74-a7b0-93e576089a41 in: path name: ServiceId required: true schema: type: string x-speakeasy-match: id SortPortals: name: sort description: | Sorts a collection of portals. Supported sort attributes are: - name - description - is_public - rbac_enabled - auto_approve_applications - auto_approve_developers - default_domain - custom_domain - custom_client_domain - created_at - updated_at in: query required: false schema: type: string TargetId: description: ID of the Target to lookup example: 5a078780-5d4c-4aae-984a-bdc6f52113d8 in: path name: TargetId required: true schema: type: string x-speakeasy-match: id TeamId: x-speakeasy-match: id schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a name: teamId in: path required: true description: ID of the team. TransitGatewayId: name: transitGatewayId in: path description: The ID of the transit gateway to operate on. required: true schema: $ref: '#/components/schemas/TransitGatewayId' x-speakeasy-match: id UpstreamId: description: ID of the Upstream to lookup example: 426d620c-7058-4ae6-aacc-f85a3204a2c5 in: path name: UpstreamId required: true schema: type: string x-speakeasy-match: id UpstreamIdForTarget: description: ID or target of the Target to lookup example: 5a078780-5d4c-4aae-984a-bdc6f52113d8 in: path name: UpstreamIdForTarget required: true schema: type: string x-speakeasy-name-override: upstream_id VaultId: description: ID of the Vault to lookup example: 9d4d6d19-77c6-428e-a965-9bc9647633e9 in: path name: VaultId required: true schema: type: string x-speakeasy-match: id centralizedConsumerIdForChildren: name: consumerId in: path required: true description: ID of the of the consumer schema: type: string cmekId: name: cmekId in: path required: true description: 'Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints.' schema: type: string example: default default: default enum: - default x-speakeasy-name-override: id configStoreId: schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a name: configStoreId in: path required: true description: Config Store identifier x-speakeasy-match: id consumerId: x-speakeasy-match: id name: consumerId in: path required: true description: ID of the of the consumer schema: type: string controlPlaneId: x-speakeasy-param-force-new: true name: controlPlaneId in: path required: true schema: type: string format: uuid example: 9524ec7d-36d9-465d-a8c5-83a3c9390458 description: The UUID of your control plane. This variable is available in the Konnect manager. keyId: x-speakeasy-match: id name: keyId in: path required: true description: ID of the key schema: type: string realmId: x-speakeasy-match: id name: realmId in: path required: true description: ID of the realm schema: type: string format: uuid realmIdForChildren: name: realmId in: path required: true description: ID of the realm schema: type: string format: uuid schemas: GroupMembership: x-speakeasy-entity: GatewayControlPlaneMembership type: object properties: members: type: array items: type: object required: - id properties: id: type: string required: - members CreateControlPlaneRequest: x-speakeasy-entity: GatewayControlPlane description: The request schema for the create control plane request. type: object properties: name: description: The name of the control plane. type: string example: Test Control Plane description: description: The description of the control plane in Konnect. type: string example: A test control plane for exploration. cluster_type: description: The ClusterType value of the cluster associated with the Control Plane. type: string example: CLUSTER_TYPE_CONTROL_PLANE enum: - CLUSTER_TYPE_CONTROL_PLANE - CLUSTER_TYPE_K8S_INGRESS_CONTROLLER - CLUSTER_TYPE_CONTROL_PLANE_GROUP - CLUSTER_TYPE_SERVERLESS - CLUSTER_TYPE_HYBRID auth_type: description: The auth type value of the cluster associated with the Runtime Group. type: string example: pinned_client_certs enum: - pinned_client_certs - pki_client_certs cloud_gateway: description: Whether this control-plane can be used for cloud-gateways. type: boolean example: false proxy_urls: $ref: '#/components/schemas/ProxyURLs' labels: $ref: '#/components/schemas/Labels' additionalProperties: false required: - name title: CreateControlPlaneRequest UpdateControlPlaneRequest: description: The request schema for the update control plane request. type: object properties: name: description: The name of the control plane. type: string example: Test Control Plane description: description: The description of the control plane in Konnect. type: string example: A test control plane for exploration. auth_type: description: The auth type value of the cluster associated with the Runtime Group. type: string example: pinned_client_certs enum: - pinned_client_certs - pki_client_certs proxy_urls: $ref: '#/components/schemas/ProxyURLs' labels: $ref: '#/components/schemas/Labels' additionalProperties: false title: UpdateControlPlaneRequest ControlPlane: x-speakeasy-entity: GatewayControlPlane description: The control plane object contains information about a Kong control plane. type: object properties: id: description: The control plane ID. type: string format: uuid example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 readOnly: true x-speakeasy-param-suppress-computed-diff: true name: description: The name of the control plane. type: string example: Test Control Plane description: description: The description of the control plane in Konnect. type: string example: A test control plane for exploration. labels: $ref: '#/components/schemas/Labels' config: description: CP configuration object for related access endpoints. type: object additionalProperties: false properties: control_plane_endpoint: description: Control Plane Endpoint. type: string format: url example: 'https://acfe5f253f.cp0.konghq.com' readOnly: true telemetry_endpoint: description: Telemetry Endpoint. type: string format: url example: 'https://acfe5f253f.tp0.konghq.com' readOnly: true cluster_type: description: The ClusterType value of the cluster associated with the Control Plane. type: string example: CLUSTER_TYPE_CONTROL_PLANE enum: - CLUSTER_TYPE_CONTROL_PLANE - CLUSTER_TYPE_K8S_INGRESS_CONTROLLER - CLUSTER_TYPE_CONTROL_PLANE_GROUP - CLUSTER_TYPE_SERVERLESS - CLUSTER_TYPE_HYBRID readOnly: true auth_type: description: The auth type value of the cluster associated with the Runtime Group. type: string example: pinned_client_certs enum: - pinned_client_certs - pki_client_certs readOnly: true cloud_gateway: description: Whether the Control Plane can be used for cloud-gateways. type: boolean readOnly: true proxy_urls: $ref: '#/components/schemas/ProxyURLs' required: - control_plane_endpoint - telemetry_endpoint - cluster_type - auth_type - cloud_gateway created_at: description: An ISO-8604 timestamp representation of control plane creation date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true x-speakeasy-terraform-ignore: true updated_at: description: An ISO-8604 timestamp representation of control plane update date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true x-speakeasy-terraform-ignore: true additionalProperties: false required: - id - name - config - created_at - updated_at Labels: description: | Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". type: object example: env: test additionalProperties: type: string pattern: '^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$' minLength: 1 maxLength: 63 nullable: true maxProperties: 50 title: Labels ProxyURL: description: Proxy URL associated with reaching the data-planes connected to a control-plane. type: object properties: host: description: Hostname of the proxy URL. type: string port: description: Port of the proxy URL. type: integer protocol: description: Protocol of the proxy URL. type: string example: host: example.com port: 443 protocol: https additionalProperties: false required: - host - port - protocol title: ProxyURL ProxyURLs: description: Array of proxy URLs associated with reaching the data-planes connected to a control-plane. type: array items: $ref: '#/components/schemas/ProxyURL' format: set example: - host: example.com port: 443 protocol: https title: ProxyURLs ControlPlaneFilterParameters: type: object properties: id: description: Returns entities that exact match any of the comma-delimited phrases in the filter string. type: object additionalProperties: false properties: eq: type: string oeq: type: string name: description: Filters on the given string field value by exact match inequality. type: object additionalProperties: false properties: eq: type: string contains: type: string neq: type: string cluster_type: description: Filters on the given string field value by exact match inequality. type: object additionalProperties: false properties: eq: type: string neq: type: string cloud_gateway: $ref: '#/components/schemas/BooleanFieldFilter' additionalProperties: false title: ControlPlaneFilterParameters BooleanFieldFilter: description: Filter by a boolean value (true/false). type: boolean example: true title: BooleanFieldFilter SortQuery: description: | The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc'). type: string example: created_at desc title: SortQuery PageMeta: description: Contains pagination query parameters and the total number of objects returned. type: object properties: number: type: number example: 1 size: type: number example: 10 total: type: number example: 100 required: - number - size - total PaginatedMeta: description: returns the pagination information type: object properties: page: $ref: '#/components/schemas/PageMeta' required: - page title: PaginatedMeta BaseError: description: standard error type: object properties: status: description: | The HTTP status code of the error. Useful when passing the response body to child properties in a frontend UI. Must be returned as an integer. type: integer readOnly: true title: description: | A short, human-readable summary of the problem. It should not change between occurences of a problem, except for localization. Should be provided as "Sentence case" for direct use in the UI. 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 kong:trace:. This helps us find the relevant logs when a customer reports an issue. type: string readOnly: true detail: description: | A human readable explanation specific to this occurence of the problem. This field may contain request/entity data to help the user understand what went wrong. Enclose variable values in square brackets. Should be provided as "Sentence case" for direct use in the UI. 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 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 CreatedAt: description: An ISO-8601 timestamp representation of entity creation date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true x-speakeasy-param-suppress-computed-diff: true UpdatedAt: description: An ISO-8601 timestamp representation of entity update date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true x-speakeasy-param-suppress-computed-diff: true ControlPlaneId: type: string format: uuid example: 0949471e-b759-45ba-87ab-ee63fb781388 ConfigurationId: type: string format: uuid example: edaf40f9-9fb0-4ffe-bb74-4e763a6bd471 readOnly: true DataPlaneGroupId: description: ID of the data-plane group that represents a deployment target for a set of data-planes. type: string format: uuid example: cbb8872a-1f83-4806-bf69-fdf0b4783c7e readOnly: true CustomDomainId: type: string format: uuid example: 39ed3790-085d-4605-9627-f96d86aaf425 readOnly: true NetworkId: type: string format: uuid example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695 x-speakeasy-param-suppress-computed-diff: true TransitGatewayId: type: string format: uuid example: 0850820b-d153-4a2a-b9be-7d2204779139 readOnly: true PrivateDnsId: type: string format: uuid example: 1850820b-c69f-4a2a-b9be-bbcdbc5cd618 readOnly: true ProviderAccountId: type: string format: uuid example: 929b2449-c69f-44c4-b6ad-9ecec6f811ae ControlPlaneGeo: description: Set of control-plane geos supported for deploying cloud-gateways configurations. type: string enum: - us - eu - au - me - in title: Control-Plane Geo GatewayVersion: description: Supported gateway version. type: string example: '3.2' title: Gateway Version InstanceTypeName: description: Instance type name to indicate capacity. type: string enum: - small - medium - large ApiAccess: description: Type of API access data-plane groups will support for a configuration. type: string default: private+public enum: - private - public - private+public ProviderRegionId: description: Region ID for cloud provider region. type: string example: us-east-2 title: Provider Region ID ProviderName: description: Name of cloud provider. type: string example: aws enum: - aws - azure title: Provider Name ConfigurationDataPlaneGroupAutoscale: oneOf: - $ref: '#/components/schemas/ConfigurationDataPlaneGroupAutoscaleStatic' - $ref: '#/components/schemas/ConfigurationDataPlaneGroupAutoscaleAutopilot' ConfigurationDataPlaneGroupAutoscaleStatic: description: Object that describes the static autoscaling strategy. Deprecated in favor of the autopilot autoscaling strategy. Static autoscaling will be removed in a future version. type: object properties: kind: type: string enum: - static instance_type: $ref: '#/components/schemas/InstanceTypeName' requested_instances: description: Number of data-planes the deployment target will contain. type: integer example: 3 additionalProperties: false deprecated: true required: - kind - instance_type - requested_instances title: Configuration Autoscale Static ConfigurationDataPlaneGroupAutoscaleAutopilot: description: Object that describes the autopilot autoscaling strategy. type: object properties: kind: type: string enum: - autopilot base_rps: description: Base number of requests per second that the deployment target should support. type: integer example: 1 max_rps: description: 'Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps. This field is deprecated and shouldn''t be used in new configurations as it will be removed in a future version. max_rps is now calculated as 10x base_rps.' type: integer example: 1000 deprecated: true additionalProperties: false required: - kind - base_rps title: Configuration Autoscale Autopilot ConfigurationDataPlaneGroupEnvironment: description: Array of environment variables to set for a data-plane group. type: array items: $ref: '#/components/schemas/ConfigurationDataPlaneGroupEnvironmentField' title: Configuration Data-Plane Group Environment ConfigurationDataPlaneGroupEnvironmentField: description: Environment variable name and value to set for a data-plane group. type: object properties: name: description: | Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_. type: string format: '^KONG_[a-zA-Z_]+[a-zA-Z0-9_]*' example: KONG_LOG_LEVEL maxLength: 120 minLength: 6 value: description: Value assigned to the environment variable field for the data-plane group. type: string example: info maxLength: 120 minLength: 1 required: - name - value title: Configuration Data-Plane Group Environment Field ConfigurationDataPlaneGroupConfig: description: 'Object that describes where a data-plane group will be deployed to, along with how many instances.' type: object properties: provider: $ref: '#/components/schemas/ProviderName' region: $ref: '#/components/schemas/ProviderRegionId' cloud_gateway_network_id: $ref: '#/components/schemas/NetworkId' autoscale: $ref: '#/components/schemas/ConfigurationDataPlaneGroupAutoscale' environment: $ref: '#/components/schemas/ConfigurationDataPlaneGroupEnvironment' additionalProperties: false required: - autoscale - provider - region - cloud_gateway_network_id title: Configuration Data-Plane Group Config Item ConfigurationDataPlaneGroup: description: Object that describes the set of data-plane groups currently pointed to this configuration. type: object properties: id: $ref: '#/components/schemas/DataPlaneGroupId' provider: $ref: '#/components/schemas/ProviderName' region: $ref: '#/components/schemas/ProviderRegionId' autoscale: $ref: '#/components/schemas/ConfigurationDataPlaneGroupAutoscale' environment: $ref: '#/components/schemas/ConfigurationDataPlaneGroupEnvironment' cloud_gateway_network_id: $ref: '#/components/schemas/NetworkId' state: description: State of the data-plane group. type: string enum: - created - initializing - ready - terminating - terminated state_metadata: description: | Metadata describing the backing state of the dataplane group and why it may be in an erroneous state. type: object additionalProperties: false properties: reported_status: description: Reported status of the dataplane group from backing infrastructure. type: string example: ERROR reason: description: | Reason why the dataplane group may be in an erroneous state, reported from backing infrastructure. type: string example: | Dataplane group could not be deployed due to insufficient cloud provider compute instances. x-speakeasy-terraform-ignore: true private_ip_addresses: description: | List of private IP addresses of the internal load balancer that proxies traffic to this data-plane group. type: array items: type: string example: - 192.168.248.132 - 192.168.66.81 - 192.168.137.135 egress_ip_addresses: description: | List of egress IP addresses for the network that this data-plane group runs on. type: array items: type: string example: - 71.78.149.75 - 91.149.112.244 - 51.235.15.121 created_at: description: An RFC-3339 timestamp representation of data-plane group creation date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true updated_at: description: An RFC-3339 timestamp representation of data-plane group update date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true required: - id - provider - region - autoscale - cloud_gateway_network_id - state - created_at - updated_at title: Cloud Gateway Configuration Data-Plane Group ConfigurationManifest: x-speakeasy-entity: CloudGatewayConfiguration description: Object containing information about a control-plane's cloud-gateways configuration. type: object properties: id: $ref: '#/components/schemas/ConfigurationId' version: $ref: '#/components/schemas/GatewayVersion' api_access: $ref: '#/components/schemas/ApiAccess' dataplane_group_config: description: 'Object that describes where data-planes will be deployed to, along with how many instances.' type: array items: $ref: '#/components/schemas/ConfigurationDataPlaneGroupConfig' title: Configuration Data-Plane Group Configs x-speakeasy-terraform-ignore: true dataplane_groups: description: | List of data-plane groups that describe where data-planes will be deployed to, along with how many instances. type: array items: $ref: '#/components/schemas/ConfigurationDataPlaneGroup' format: set entity_version: description: | Positive, monotonically increasing version integer, to serialize configuration changes. type: number example: 1 readOnly: true created_at: description: An RFC-3339 timestamp representation of configuration creation date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true updated_at: description: An RFC-3339 timestamp representation of configuration update date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true control_plane_id: $ref: '#/components/schemas/ControlPlaneId' control_plane_geo: $ref: '#/components/schemas/ControlPlaneGeo' required: - id - control_plane_id - control_plane_geo - version - dataplane_group_config - dataplane_groups - entity_version - created_at - updated_at title: Configuration CreateConfigurationDataPlaneGroup: description: 'Object that describes where to deploy a data-plane group, along with how many instances.' type: object properties: provider: $ref: '#/components/schemas/ProviderName' region: $ref: '#/components/schemas/ProviderRegionId' cloud_gateway_network_id: $ref: '#/components/schemas/NetworkId' autoscale: $ref: '#/components/schemas/ConfigurationDataPlaneGroupAutoscale' environment: $ref: '#/components/schemas/ConfigurationDataPlaneGroupEnvironment' additionalProperties: false required: - autoscale - provider - region - cloud_gateway_network_id title: CreateConfigurationDataPlaneGroup ProviderAccount: description: Object containing mapping for organization and cloud provider to account ID. type: object properties: id: $ref: '#/components/schemas/ProviderAccountId' provider: $ref: '#/components/schemas/ProviderName' provider_account_id: description: ID of the cloud provider account. type: string readOnly: true created_at: description: An RFC-3339 timestamp representation of provider account creation date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true updated_at: description: An RFC-3339 timestamp representation of provider account update date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true required: - id - provider - provider_account_id - created_at - updated_at title: Cloud Gateway Provider Account NetworkCreateState: description: Initial state for creating a network. type: string default: initializing enum: - initializing - offline title: Network Create State NetworkState: description: State of the network. enum: - created - initializing - offline - ready - terminating - terminated readOnly: true title: Network State x-speakeasy-terraform-ignore: true NetworkStateMetadata: description: | Metadata describing the backing state of the network and why it may be in an erroneous state. type: object properties: reported_status: description: Reported status of the network from backing infrastructure. type: string example: INVALID reason: description: | Reason why the network may be in an erroneous state, reported from backing infrastructure. type: string example: | Network could not be deployed due to insufficient cloud provider compute instances. additionalProperties: false readOnly: true title: Network State Metadata x-speakeasy-terraform-ignore: true NetworkProviderMetadata: description: Metadata describing attributes returned by cloud-provider for the network. type: object properties: vpc_id: type: string title: VPC ID subnet_ids: type: array items: type: string title: Subnet IDs additionalProperties: false readOnly: true title: Network Provider Metadata x-speakeasy-param-suppress-computed-diff: true NetworkName: description: Human-readable name of the network. type: string example: us-east-2 network title: Network Name NetworkCIDRBlock: description: CIDR block configuration for the network. type: string example: 10.0.0.0/8 title: Network CIDR Block NetworkAvailabilityZones: description: List of availability zones that the network is attached to. type: array items: type: string example: - use2-az1 - use2-az2 - use2-az3 Network: x-speakeasy-entity: CloudGatewayNetwork description: Object containing information about a network to be used in configurations. type: object properties: id: $ref: '#/components/schemas/NetworkId' name: $ref: '#/components/schemas/NetworkName' default: description: | Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account. type: boolean example: false x-speakeasy-param-suppress-computed-diff: true cloud_gateway_provider_account_id: $ref: '#/components/schemas/ProviderAccountId' region: $ref: '#/components/schemas/ProviderRegionId' availability_zones: $ref: '#/components/schemas/NetworkAvailabilityZones' cidr_block: $ref: '#/components/schemas/NetworkCIDRBlock' state: $ref: '#/components/schemas/NetworkState' state_metadata: $ref: '#/components/schemas/NetworkStateMetadata' provider_metadata: $ref: '#/components/schemas/NetworkProviderMetadata' transit_gateway_count: description: The number of transit gateways attached to this network. type: integer example: 0 readOnly: true x-speakeasy-param-suppress-computed-diff: true configuration_reference_count: description: The number of configurations that reference this network. type: integer example: 0 readOnly: true x-speakeasy-param-suppress-computed-diff: true entity_version: description: | Monotonically-increasing version count of the network, to indicate the order of updates to the network. type: integer example: 1 readOnly: true x-speakeasy-param-suppress-computed-diff: true created_at: description: An RFC-3339 timestamp representation of network creation date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true x-speakeasy-param-suppress-computed-diff: true updated_at: description: An RFC-3339 timestamp representation of network update date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true x-speakeasy-param-suppress-computed-diff: true required: - id - name - default - cloud_gateway_provider_account_id - region - availability_zones - cidr_block - provider_metadata - state - transit_gateway_count - configuration_reference_count - entity_version - created_at - updated_at title: Network CreateNetworkRequest: x-speakeasy-entity: CloudGatewayNetwork description: Request schema for creating a network. type: object properties: name: $ref: '#/components/schemas/NetworkName' cloud_gateway_provider_account_id: $ref: '#/components/schemas/ProviderAccountId' region: $ref: '#/components/schemas/ProviderRegionId' availability_zones: $ref: '#/components/schemas/NetworkAvailabilityZones' cidr_block: $ref: '#/components/schemas/NetworkCIDRBlock' state: $ref: '#/components/schemas/NetworkCreateState' additionalProperties: false required: - name - cloud_gateway_provider_account_id - region - availability_zones - cidr_block title: CreateNetworkRequest PatchNetworkRequest: x-speakeasy-entity: CloudGatewayNetwork description: Request schema for updating a network. type: object properties: name: $ref: '#/components/schemas/NetworkName' additionalProperties: false title: PatchNetworkRequest TransitGatewayState: description: | The current state of the Transit Gateway. Possible values: - `created` - The attachment has been created but is not attached to transit gateway. - `initializing` - The attachment is in the process of being initialized and is setting up necessary resources. - `pending-acceptance` The attachment request is awaiting acceptance in customer VPC. - `ready` - The transit gateway attachment is fully operational and can route traffic as configured. - `terminating` - The attachment is in the process of being deleted and is no longer accepting new traffic. - `terminated` - The attachment has been fully deleted and is no longer available. type: string enum: - created - initializing - pending-acceptance - ready - terminating - terminated readOnly: true title: Transit Gateway State AwsTransitGatewayAttachmentConfig: type: object properties: kind: enum: - aws-transit-gateway-attachment title: AWS Transit Gateway Attachment Type transit_gateway_id: description: AWS Transit Gateway ID to create attachment to. type: string title: Transit Gateway ID ram_share_arn: description: Resource Share ARN to verify request to create transit gateway attachment. type: string title: RAM Share ARN additionalProperties: false required: - kind - transit_gateway_id - ram_share_arn title: AWS Transit Gateway Attachment Config AwsVpcPeeringGatewayAttachmentConfig: type: object properties: kind: enum: - aws-vpc-peering-attachment title: AWS VPC Peering Attachment Config peer_account_id: type: string peer_vpc_id: type: string peer_vpc_region: type: string additionalProperties: false required: - kind - peer_account_id - peer_vpc_id - peer_vpc_region title: AWS VPC Peering Attachment Config AzureVNETPeeringAttachmentConfig: type: object properties: kind: enum: - azure-vnet-peering-attachment title: Azure VNET Peering Attachment Type tenant_id: description: Tenant ID for the Azure VNET Peering attachment. type: string title: Tenant ID subscription_id: description: Subscription ID for the Azure VNET Peering attachment. type: string title: Subscription ID resource_group_name: description: Resource Group Name for the Azure VNET Peering attachment. type: string title: Resource Group Name vnet_name: description: VNET Name for the Azure VNET Peering attachment. type: string title: VNET Name additionalProperties: false required: - kind - tenant_id - subscription_id - resource_group_name - vnet_name title: Azure VNET Peering Attachment Config TransitGatewayDnsConfig: description: | List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway attachment. type: array items: type: object additionalProperties: false properties: remote_dns_server_ip_addresses: description: Remote DNS Server IP Addresses to connect to for resolving internal DNS via a transit gateway. type: array items: type: string example: - 10.0.0.2 title: Remote DNS Server IP Addresses domain_proxy_list: description: | Internal domain names to proxy for DNS resolution from the listed remote DNS server IP addresses, for a transit gateway. type: array items: type: string example: - foobar.com title: Domain Proxy List required: - remote_dns_server_ip_addresses - domain_proxy_list title: Transit Gateway DNS Config TransitGatewayName: description: Human-readable name of the transit gateway. type: string example: us-east-2 transit gateway title: Transit Gateway Name TransitGatewayCIDRBlocks: description: | CIDR blocks for constructing a route table for the transit gateway, when attaching to the owning network. type: array items: type: string example: - 10.0.0.0/8 - 100.64.0.0/10 - 172.16.0.0/12 title: Transit Gateway CIDR Blocks PrivateDnsResponse: oneOf: - $ref: '#/components/schemas/AwsPrivateHostedZoneResponse' - $ref: '#/components/schemas/AwsPrivateDnsResolverResponse' AwsPrivateHostedZoneResponse: type: object properties: id: $ref: '#/components/schemas/PrivateDnsId' state: $ref: '#/components/schemas/PrivateDnsState' state_metadata: description: | Metadata describing the backing state of the Private Dns and why it may be in an erroneous state. type: object additionalProperties: false properties: reported_status: description: Reported status of the Private Dns from backing infrastructure. type: string example: ERROR reason: description: | Reason why the Private Dns may be in an erroneous state, reported from backing infrastructure. type: string example: | Failed to create Private Dns due to invalid Cloud Provider configuration. title: PrivateDnsStateMetadata entity_version: description: | Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the Private DNS. type: integer example: 1 readOnly: true created_at: description: An RFC-3339 timestamp representation of Private DNS creation date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true updated_at: description: An RFC-3339 timestamp representation of Private DNS update date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true name: $ref: '#/components/schemas/PrivateDnsName' private_dns_attachment_config: $ref: '#/components/schemas/AwsPrivateHostedZoneAttachmentConfig' required: - id - state - state_metadata - entity_version - created_at - updated_at - name - private_dns_attachment_config AwsPrivateHostedZoneAttachmentConfig: type: object properties: kind: enum: - aws-private-hosted-zone-attachment title: AWS Private Hosted Zone Type hosted_zone_id: description: AWS Hosted Zone to create attachment to. type: string title: Hosted Zone Id additionalProperties: false required: - kind - hosted_zone_id title: AWS Private Hosted Zone Attachment Config AwsPrivateDnsResolverResponse: type: object properties: id: $ref: '#/components/schemas/PrivateDnsId' state: $ref: '#/components/schemas/PrivateDnsState' state_metadata: description: | Metadata describing the backing state of the Private Dns and why it may be in an erroneous state. type: object additionalProperties: false properties: reported_status: description: Reported status of the Private Dns from backing infrastructure. type: string example: ERROR reason: description: | Reason why the Private Dns may be in an erroneous state, reported from backing infrastructure. type: string example: | Failed to create Private Dns due to invalid Cloud Provider configuration. title: PrivateDnsStateMetadata entity_version: description: | Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the Private DNS. type: integer example: 1 readOnly: true created_at: description: An RFC-3339 timestamp representation of Private DNS creation date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true updated_at: description: An RFC-3339 timestamp representation of Private DNS update date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true name: $ref: '#/components/schemas/PrivateDnsName' private_dns_attachment_config: $ref: '#/components/schemas/AwsPrivateDnsResolverAttachmentConfig' required: - id - state - state_metadata - entity_version - created_at - updated_at - name - private_dns_attachment_config AwsPrivateDnsResolverAttachmentConfig: type: object properties: kind: enum: - aws-outbound-resolver title: AWS Private DNS Resolver Type dns_config: $ref: '#/components/schemas/PrivateDnsResolverConfig' additionalProperties: false required: - kind - dns_config title: AWS Private DNS Resolver Attachment Config PrivateDnsResolverConfig: description: | Object that contains mappings from proxied internal domains to remote DNS server IP address for a Private DNS Resolver. type: object example: global.api.konghq.com: remote_dns_server_ip_addresses: - 10.0.0.2 us.api.konghq.dev: remote_dns_server_ip_addresses: - 10.0.0.8 additionalProperties: type: object properties: remote_dns_server_ip_addresses: description: IP addresses of remote DNS servers used by the Private DNS Resolver for DNS resolution. type: array items: type: string example: - 10.0.0.2 required: - remote_dns_server_ip_addresses title: Private DNS Resolver Config Item PrivateDnsName: description: Human-readable name of the Private DNS. type: string example: us-east-2 private dns title: Private DNS Name PrivateDnsState: description: | The current state of the Private DNS attachment. Possible values: - `created` - The attachment has been created but is not attached to Private DNS. - `initializing` - The attachment is in the process of being initialized and is setting up necessary resources. - `pending-association` The attachment request is awaiting association to the cloud provider infrastructure in order for provisioning to proceed. - `ready` - The attachment is fully operational and can route traffic as configured. - `error` - The attachment is in an error state, and is not operational. - `terminating` - The attachment is in the process of being deleted. - `terminated` - The attachment has been fully deleted and is no longer available. type: string enum: - created - initializing - pending-association - ready - error - terminating - terminated title: Private DNS State PatchAwsPrivateDnsResolver: description: Request schema for updating a Private DNS AWS Resolver. properties: name: $ref: '#/components/schemas/PrivateDnsName' private_dns_attachment_config: $ref: '#/components/schemas/AwsPrivateDnsResolverAttachmentConfig' CreatePrivateDnsRequest: description: Request schema for creating a Private DNS. type: object properties: name: $ref: '#/components/schemas/PrivateDnsName' private_dns_attachment_config: oneOf: - $ref: '#/components/schemas/AwsPrivateHostedZoneAttachmentConfig' - $ref: '#/components/schemas/AwsPrivateDnsResolverAttachmentConfig' title: CreatePrivateDnsRequest PatchPrivateDnsRequest: description: Request schema for updating a Private DNS. type: object oneOf: - $ref: '#/components/schemas/PatchAwsPrivateDnsResolver' title: PatchPrivateDnsRequest AwsTransitGatewayResponse: type: object properties: name: $ref: '#/components/schemas/TransitGatewayName' dns_config: $ref: '#/components/schemas/TransitGatewayDnsConfig' cidr_blocks: $ref: '#/components/schemas/TransitGatewayCIDRBlocks' transit_gateway_attachment_config: $ref: '#/components/schemas/AwsTransitGatewayAttachmentConfig' id: $ref: '#/components/schemas/TransitGatewayId' state: $ref: '#/components/schemas/TransitGatewayState' state_metadata: description: | Metadata describing the backing state of the transit gateway and why it may be in an erroneous state. type: object additionalProperties: false properties: reported_status: description: Reported status of the transit gateway from backing infrastructure. type: string example: ERROR reason: description: | Reason why the transit gateway may be in an erroneous state, reported from backing infrastructure. type: string example: | Transit Gateway Attachment configuration could not find a resource with the provided ram share arn. readOnly: true title: TransitGatewayStateMetadata entity_version: description: | Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the transit gateway. type: integer example: 1 readOnly: true created_at: description: An RFC-3339 timestamp representation of transit gateway creation date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true updated_at: description: An RFC-3339 timestamp representation of transit gateway update date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true required: - name - cidr_blocks - transit_gateway_attachment_config - dns_config - id - state - entity_version - created_at - updated_at title: AWS Transit Gateway AwsVpcPeeringGatewayResponse: type: object properties: name: $ref: '#/components/schemas/TransitGatewayName' dns_config: $ref: '#/components/schemas/TransitGatewayDnsConfig' cidr_blocks: $ref: '#/components/schemas/TransitGatewayCIDRBlocks' transit_gateway_attachment_config: $ref: '#/components/schemas/AwsVpcPeeringGatewayAttachmentConfig' id: $ref: '#/components/schemas/TransitGatewayId' state: $ref: '#/components/schemas/TransitGatewayState' state_metadata: description: | Metadata describing the backing state of the transit gateway and why it may be in an erroneous state. type: object additionalProperties: false properties: reported_status: description: Reported status of the transit gateway from backing infrastructure. type: string example: ERROR reason: description: | Reason why the transit gateway may be in an erroneous state, reported from backing infrastructure. type: string example: | Transit Gateway Attachment configuration could not find a resource with the provided ram share arn. readOnly: true title: TransitGatewayStateMetadata entity_version: description: | Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the transit gateway. type: integer example: 1 readOnly: true created_at: description: An RFC-3339 timestamp representation of transit gateway creation date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true updated_at: description: An RFC-3339 timestamp representation of transit gateway update date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true required: - name - cidr_blocks - transit_gateway_attachment_config - dns_config - id - state - entity_version - created_at - updated_at title: AWS Vpc Peering Gateway AzureTransitGatewayResponse: type: object properties: name: $ref: '#/components/schemas/TransitGatewayName' dns_config: $ref: '#/components/schemas/TransitGatewayDnsConfig' transit_gateway_attachment_config: $ref: '#/components/schemas/AzureVNETPeeringAttachmentConfig' id: $ref: '#/components/schemas/TransitGatewayId' state: $ref: '#/components/schemas/TransitGatewayState' state_metadata: description: | Metadata describing the backing state of the transit gateway and why it may be in an erroneous state. type: object additionalProperties: false properties: reported_status: description: Reported status of the transit gateway from backing infrastructure. type: string example: ERROR reason: description: | Reason why the transit gateway may be in an erroneous state, reported from backing infrastructure. type: string example: | Transit Gateway Attachment configuration could not find a resource with the provided ram share arn. readOnly: true title: TransitGatewayStateMetadata entity_version: description: | Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the transit gateway. type: integer example: 1 readOnly: true created_at: description: An RFC-3339 timestamp representation of transit gateway creation date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true updated_at: description: An RFC-3339 timestamp representation of transit gateway update date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true required: - name - transit_gateway_attachment_config - id - dns_config - state - entity_version - created_at - updated_at title: Azure Transit Gateway TransitGatewayResponse: oneOf: - $ref: '#/components/schemas/AwsTransitGatewayResponse' - $ref: '#/components/schemas/AwsVpcPeeringGatewayResponse' - $ref: '#/components/schemas/AzureTransitGatewayResponse' CreateAwsTransitGateway: type: object properties: name: $ref: '#/components/schemas/TransitGatewayName' dns_config: $ref: '#/components/schemas/TransitGatewayDnsConfig' cidr_blocks: $ref: '#/components/schemas/TransitGatewayCIDRBlocks' transit_gateway_attachment_config: $ref: '#/components/schemas/AwsTransitGatewayAttachmentConfig' required: - name - cidr_blocks - transit_gateway_attachment_config title: AWS Transit Gateway x-speakeasy-name-override: AWSTransitGateway CreateAwsVpcPeeringGateway: type: object properties: name: $ref: '#/components/schemas/TransitGatewayName' dns_config: $ref: '#/components/schemas/TransitGatewayDnsConfig' cidr_blocks: $ref: '#/components/schemas/TransitGatewayCIDRBlocks' transit_gateway_attachment_config: $ref: '#/components/schemas/AwsVpcPeeringGatewayAttachmentConfig' required: - name - cidr_blocks - transit_gateway_attachment_config title: AWS Vpc Peering Gateway x-speakeasy-name-override: AWSVpcPeeringGateway CreateAzureTransitGateway: type: object properties: name: $ref: '#/components/schemas/TransitGatewayName' dns_config: $ref: '#/components/schemas/TransitGatewayDnsConfig' transit_gateway_attachment_config: $ref: '#/components/schemas/AzureVNETPeeringAttachmentConfig' required: - name - transit_gateway_attachment_config title: Azure Transit Gateway x-speakeasy-name-override: AzureTransitGateway CreateTransitGatewayRequest: description: Request schema for creating a transit gateway. type: object oneOf: - $ref: '#/components/schemas/CreateAwsTransitGateway' - $ref: '#/components/schemas/CreateAwsVpcPeeringGateway' - $ref: '#/components/schemas/CreateAzureTransitGateway' title: CreateTransitGatewayRequest CustomDomainState: description: State of the custom domain. type: string enum: - created - initializing - ready - terminating - terminated - error readOnly: true title: Custom Domain State CustomDomainName: description: Domain name of the custom domain. type: string example: example.com title: Custom Domain Name CustomDomain: x-speakeasy-entity: CloudGatewayCustomDomain description: Object containing information about a custom domain for a control-plane. type: object properties: id: $ref: '#/components/schemas/CustomDomainId' control_plane_id: $ref: '#/components/schemas/ControlPlaneId' control_plane_geo: $ref: '#/components/schemas/ControlPlaneGeo' domain: $ref: '#/components/schemas/CustomDomainName' certificate_id: description: | Certificate ID for the certificate representing this domain and stored on data-planes for this control-plane. Can be retrieved via the control-planes API for this custom domain's control-plane. type: string format: uuid example: 3b7cbeee-fbec-440e-a5ef-89e7dec3b9d0 nullable: true readOnly: true sni_id: description: | Server Name Indication ID for this domain and stored on data-planes for this control-plane. Can be retrieved via the control-planes API for this custom domain's control-plane. type: string format: uuid example: a8f11ea8-af09-4422-9735-5d4f8910aba1 nullable: true readOnly: true state: $ref: '#/components/schemas/CustomDomainState' state_metadata: description: | Metadata describing the backing state of the custom domain and why it may be in an erroneous state. type: object additionalProperties: false properties: reported_status: description: Reported status of the custom domain from backing infrastructure. type: string example: INVALID reason: description: | Reason why the custom domain may be in an erroneous state, reported from backing infrastructure. type: string example: | CNAME points to '_acme-challenge..gateways.konghq.tech.' instead of '_acme-challenge..acme.gateways.konghq.tech.' readOnly: true title: CustomDomainStateMetadata entity_version: description: | Monotonically-increasing version count of the custom domain, to indicate the order of updates to the custom domain. type: integer example: 1 readOnly: true created_at: description: An RFC-3339 timestamp representation of custom domain creation date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true updated_at: description: An RFC-3339 timestamp representation of custom domain update date. type: string format: date-time example: '2022-11-04T20:10:06.927Z' readOnly: true required: - id - control_plane_id - control_plane_geo - domain - state - state_metadata - entity_version - created_at - updated_at title: Custom Domain CreateConfigurationRequest: description: | Request schema for creating a configuration. type: object properties: control_plane_id: $ref: '#/components/schemas/ControlPlaneId' control_plane_geo: $ref: '#/components/schemas/ControlPlaneGeo' version: $ref: '#/components/schemas/GatewayVersion' dataplane_groups: description: 'List of data-plane groups that describe where to deploy instances, along with how many instances.' type: array items: $ref: '#/components/schemas/CreateConfigurationDataPlaneGroup' format: set api_access: $ref: '#/components/schemas/ApiAccess' additionalProperties: false required: - control_plane_id - control_plane_geo - version - dataplane_groups title: CreateConfigurationRequest CreateCustomDomainRequest: description: Request schema for creating a custom domain in the global API. type: object properties: control_plane_id: $ref: '#/components/schemas/ControlPlaneId' control_plane_geo: $ref: '#/components/schemas/ControlPlaneGeo' domain: $ref: '#/components/schemas/CustomDomainName' additionalProperties: false required: - control_plane_id - control_plane_geo - domain title: CreateCustomDomainRequest MeshControlPlaneFeatures: type: array items: $ref: '#/components/schemas/MeshControlPlaneFeature' MeshControlPlaneFeatureHostnameGenerationCreation: properties: enabled: type: boolean required: - enabled MeshControlPlaneFeatureMeshCreation: properties: enabled: type: boolean required: - enabled MeshControlPlaneFeature: description: | Features to be enabled in the control plane. Currently only defaults are supported. type: object properties: type: type: string enum: - MeshCreation - HostnameGeneratorCreation hostnameGeneratorCreation: $ref: '#/components/schemas/MeshControlPlaneFeatureHostnameGenerationCreation' meshCreation: $ref: '#/components/schemas/MeshControlPlaneFeatureMeshCreation' required: - type MeshControlPlaneLabels: description: Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters. type: object example: test: 'true' additionalProperties: type: string pattern: '^[a-z0-9A-Z]{1}([a-z0-9A-Z\-\.\_]*[a-z0-9A-Z]+)?$' minLength: 1 maxLength: 63 nullable: true maxProperties: 10 nullable: true title: Labels MeshControlPlaneNonNullableLabels: description: Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters. type: object example: test: 'true' additionalProperties: type: string pattern: '^[a-z0-9A-Z]{1}([a-z0-9A-Z\-\.\_]*[a-z0-9A-Z]+)?$' minLength: 1 maxLength: 63 maxProperties: 10 nullable: true title: Labels MeshControlPlane: description: a control plane type: object properties: id: description: ID of the control plane. type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a readOnly: true x-speakeasy-param-suppress-computed-diff: true name: $ref: '#/components/schemas/MeshControlPlaneName' description: $ref: '#/components/schemas/MeshControlPlaneDescription' labels: $ref: '#/components/schemas/MeshControlPlaneLabels' features: $ref: '#/components/schemas/MeshControlPlaneFeatures' created_at: type: string format: date-time example: '2023-01-11T02:30:42.227Z' readOnly: true x-speakeasy-param-suppress-computed-diff: true updated_at: type: string format: date-time example: '2023-01-11T02:30:42.227Z' readOnly: true x-speakeasy-param-suppress-computed-diff: true required: - id - name - updated_at - created_at title: ControlPlane CreateMeshControlPlaneRequest: description: a payload to create a control plane type: object properties: name: $ref: '#/components/schemas/MeshControlPlaneName' description: $ref: '#/components/schemas/MeshControlPlaneDescription' features: $ref: '#/components/schemas/MeshControlPlaneFeatures' labels: $ref: '#/components/schemas/MeshControlPlaneLabels' additionalProperties: false required: - name title: CreateMeshControlPlaneRequest PutMeshControlPlaneRequest: description: a payload to update the whole control plane type: object properties: name: $ref: '#/components/schemas/MeshControlPlaneName' description: $ref: '#/components/schemas/MeshControlPlaneDescription' labels: $ref: '#/components/schemas/MeshControlPlaneNonNullableLabels' required: - name title: PutMeshControlPlaneRequest MeshControlPlaneName: description: The name of the control plane. type: string example: Test control plane maxLength: 100 minLength: 1 pattern: '^[a-z0-9A-Z]{1}.*$' MeshControlPlaneDescription: type: string example: A control plane to handle traffic on development environment. maxLength: 250 APIProductPortals: description: The list of portals which this API product is published to type: array items: $ref: '#/components/schemas/APIProductPortal' minItems: 0 title: APIProductPortals APIProductPortal: type: object properties: portal_id: type: string format: uuid example: 35a2624c-49fc-4764-99e1-224ed819f200 portal_name: type: string example: Developer Portal additionalProperties: false required: - portal_id - portal_name title: APIProductPortal APIProductVersionPublishStatus: type: string example: published enum: - published - unpublished title: APIProductVersionPublishStatus APIProductVersionPortals: description: The list of portals which this API product version is configured for type: array items: $ref: '#/components/schemas/APIProductVersionPortal' minItems: 0 title: APIProductVersionPortals APIProductVersionPortal: type: object properties: portal_id: type: string format: uuid example: 35a2624c-49fc-4764-99e1-224ed819f200 portal_name: type: string example: Developer Portal portal_product_version_id: type: string format: uuid example: 35a2624c-49fc-4764-99e1-224ed819f200 publish_status: $ref: '#/components/schemas/APIProductVersionPublishStatus' deprecated: type: boolean example: false application_registration_enabled: type: boolean example: true auto_approve_registration: type: boolean example: false auth_strategies: type: array items: $ref: '#/components/schemas/APIProductVersionAuthStrategy' additionalProperties: false required: - portal_id - portal_name - portal_product_version_id - publish_status - deprecated - application_registration_enabled - auto_approve_registration - auth_strategies title: APIProductVersionPortal APIProductVersionAuthStrategy: type: object properties: id: type: string format: uuid example: 9f5061ce-78f6-4452-9108-ad7c02821fd5 name: type: string example: Key Auth example: id: 9f5061ce-78f6-4452-9108-ad7c02821fd5 name: Key Auth additionalProperties: false required: - id - name title: APIProductVersionAuthStrategy APIProduct: x-speakeasy-entity: ApiProduct type: object properties: id: description: The API product ID. type: string format: uuid example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8 readOnly: true name: description: The name of the API product type: string example: My Name description: description: The description of the API product type: string example: MyDescription nullable: true portal_ids: description: | The list of portal identifiers which this API product is published to. This property is deprecated and will be removed in a future version. Use the `portals` property instead. type: array items: type: string format: uuid example: 25a2624c-49fc-4764-99e1-224ed819f200 deprecated: true minItems: 0 nullable: false uniqueItems: true portals: $ref: '#/components/schemas/APIProductPortals' version_count: description: The number of product versions attached to this API product type: number example: 10 created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' labels: $ref: '#/components/schemas/Labels' public_labels: $ref: '#/components/schemas/PublicLabels' additionalProperties: false required: - id - name - description - portal_ids - portals - created_at - updated_at - labels - public_labels - version_count title: API Product APIProductDocument: description: an api product document type: object properties: id: type: string format: uuid parent_document_id: type: string format: uuid nullable: true title: type: string slug: type: string status: type: string enum: - unpublished - published metadata: type: object content: description: The unencoded markdown string of the api product document. type: string created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - id - parent_document_id - title - slug - status - metadata - content - ast - updated_at - created_at title: ApiProductDocument AuthStrategySyncError: type: object properties: plugin_name: type: string value: type: string enum: - plugin_sync_error_comm - plugin_sync_error_unknown - plugin_sync_error_fatal - plugin_sync_error_updating_plugin_refs message: type: string info: type: object additionalProperties: true properties: details: type: array items: type: object additionalProperties: true properties: type: type: string message: type: array items: type: string example: plugin_name: konnect-application-auth value: plugin_sync_error_comm message: Unable to connect to the control plane to update plugin additionalProperties: false required: - message AuthStrategySyncErrors: description: The set of errors encountered when trying to sync the auth strategies on the version type: array items: $ref: '#/components/schemas/AuthStrategySyncError' example: - plugin_name: konnect-application-auth value: plugin_sync_error_comm message: Unable to connect to the control plane to update plugin nullable: true readOnly: true x-speakeasy-terraform-ignore: true APIProductVersion: x-speakeasy-entity: ApiProductVersion type: object properties: id: description: The API product version identifier. type: string format: uuid example: 9f5061ce-78f6-4452-9108-ad7c02821fd5 readOnly: true name: description: The version of the API product type: string example: FirstVersion gateway_service: type: object additionalProperties: false nullable: true properties: id: description: The identifier of a gateway service associated with the version of the API product. type: string format: uuid example: 09b4786a-3e48-4631-8f6b-62d1d8e1a7f3 nullable: true runtime_group_id: description: 'This field is deprecated, please use `control_plane_id` instead. The identifier of the control plane that the gateway service resides in' type: string format: uuid example: e4d9ebb1-26b4-426a-b00e-cb67044f3baf deprecated: true control_plane_id: description: The identifier of the control plane that the gateway service resides in type: string format: uuid example: e4d9ebb1-26b4-426a-b00e-cb67044f3baf required: - id - control_plane_id publish_status: description: 'This field is published if the API product version is published to at least one portal. This field is deprecated: Use [PortalProductVersion.publish_status](https://docs.konghq.com/konnect/api/portal-management/v2/#/operations/create-portal-product-version) instead.' type: string example: unpublished enum: - unpublished - published deprecated: true x-speakeasy-terraform-ignore: true deprecated: description: 'Whether this API product version is deprecated in at least one portal. This field is deprecated: Use [PortalProductVersion.deprecated](https://docs.konghq.com/konnect/api/portal-management/v2/#/operations/create-portal-product-version) instead' type: boolean example: false deprecated: true labels: $ref: '#/components/schemas/Labels' auth_strategy_sync_errors: $ref: '#/components/schemas/AuthStrategySyncErrors' portals: $ref: '#/components/schemas/APIProductVersionPortals' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' additionalProperties: false required: - id - name - gateway_service - publish_status - deprecated - labels - portals - created_at - updated_at title: API Product Version APIProductVersionSpec: x-speakeasy-entity: APIProductSpecification type: object properties: id: description: The API product version specification identifier. type: string format: uuid example: 7710d5c4-d902-410b-992f-18b814155b53 readOnly: true name: description: The name of the API product version specification type: string example: oas.yaml pattern: '^.+(?:\.yaml|\.yml|\.json)$' content: description: The contents of the API product version specification example: My YAML or JSON formatted OAS content type: string created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' additionalProperties: false required: - id - name - content - created_at - updated_at title: API Product Version Spec CreateAPIProductDTO: x-speakeasy-entity: ApiProduct description: The request schema to create an API product. type: object properties: name: description: The name of the API product. type: string example: API Product maxLength: 100 minLength: 1 description: description: The description of the API product. type: string example: Text describing the API product nullable: true labels: $ref: '#/components/schemas/Labels' public_labels: $ref: '#/components/schemas/PublicLabels' portal_ids: description: The list of portal identifiers which this API product should be published to type: array items: type: string format: uuid example: 25a2624c-49fc-4764-99e1-224ed819f200 minItems: 0 nullable: false uniqueItems: true additionalProperties: false required: - name - portal_ids title: Create API Product Request UpdateAPIProductDTO: x-speakeasy-entity: ApiProduct description: The request schema for updating an API product. type: object properties: name: description: The name for the API product. type: string example: API Product maxLength: 100 minLength: 1 description: description: The description of the API product. type: string example: Text describing the API product nullable: true labels: $ref: '#/components/schemas/LabelsUpdate' public_labels: $ref: '#/components/schemas/PublicLabelsUpdate' portal_ids: description: The list of portal identifiers which this API product should be published to type: array items: type: string format: uuid example: 25a2624c-49fc-4764-99e1-224ed819f200 minItems: 0 nullable: false uniqueItems: true additionalProperties: false required: - portal_ids title: Update API Product Request CreateAPIProductVersionDTO: description: | The request schema to create a version of an API product. Note that the `publish_status` and `deprecated` fields are deprecated: Use [PortalProductVersion.publish_status](https://docs.konghq.com/konnect/api/portal-management/v2/#/operations/create-portal-product-version) instead. type: object properties: name: description: The version name of the API product version. type: string example: v1 minLength: 1 nullable: false publish_status: description: 'The publish status of the API product version. Applies publish status to all related portal product versions. This field is deprecated: Use [PortalProductVersion.publish_status](https://docs.konghq.com/konnect/api/portal-management/v2/#/operations/create-portal-product-version) instead.' type: string example: unpublished enum: - unpublished - published deprecated: true nullable: false deprecated: description: 'Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use [PortalProductVersion.deprecated](https://docs.konghq.com/konnect/api/portal-management/v2/#/operations/create-portal-product-version) instead.' type: boolean example: false deprecated: true nullable: false labels: $ref: '#/components/schemas/Labels' gateway_service: $ref: '#/components/schemas/GatewayServicePayload' oneOf: - $ref: '#/components/schemas/GatewayServicePayload' - $ref: '#/components/schemas/LegacyGatewayServicePayload' additionalProperties: false required: - name title: Create API Product Version Request CreateAPIProductVersionSpecDTO: x-speakeasy-entity: APIProductSpecification description: The request schema to create a specification for a version of an API product. type: object properties: name: description: The name of the API product version specification type: string example: oas.yaml maxLength: 255 minLength: 1 nullable: false pattern: '^.+(?:\.yaml|\.yml|\.json)$' content: description: The base64 encoded contents of the API product version specification example: TXkgWUFNTCBvciBKU09OIGZvcm1hdHRlZCBPQVMgY29udGVudA== format: byte minLength: 1 type: string x-speakeasy-terraform-custom-type: imports: - github.com/Kong/shared-speakeasy/customtypes/encodedstring schemaType: 'encodedstring.Base64InputType{}' valueType: encodedstring.Base64Input additionalProperties: false required: - name - content title: Create API Product Version Specification Request CreateAPIProductDocumentDTO: description: a document payload type: object properties: parent_document_id: description: parent document id type: string format: uuid example: dd4e1b98-3629-4dd3-acc0-759a726ffee2 nullable: true slug: description: document slug. must be unique accross documents belonging to an api product type: string example: path-for-seo maxLength: 80 pattern: '^[\w-]+$' status: $ref: '#/components/schemas/PublishStatus' title: description: document title type: string example: How to create a document in Konnect DocumentHub minLength: 1 content: description: Can be markdown string content or base64 encoded string example: '## My Markdown' type: string x-speakeasy-terraform-custom-type: imports: - github.com/Kong/shared-speakeasy/customtypes/encodedstring schemaType: 'encodedstring.Base64OrPlainInputType{}' valueType: encodedstring.Base64OrPlainInput metadata: description: metadata of the document type: object example: author: John Doe nullable: false required: - slug - status - title title: CreateDocumentPayload UpdateAPIProductDocumentDTO: description: a document payload type: object properties: parent_document_id: description: | Parent document Id. If this value is explicitly set to null, the document will be put as a top level document at the bottom of the tree. type: string format: uuid example: dd4e1b98-3629-4dd3-acc0-759a726ffee2 nullable: true slug: description: document slug. must be unique accross documents belonging to an api product type: string example: path-for-seo maxLength: 80 pattern: '^[\w-]+$' status: $ref: '#/components/schemas/PublishStatus' title: description: document title type: string example: How to update a document in Konnect DocumentHub minLength: 1 content: description: Can be markdown string content or base64 encoded string example: YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc= type: string x-speakeasy-terraform-custom-type: imports: - github.com/Kong/shared-speakeasy/customtypes/encodedstring schemaType: 'encodedstring.Base64OrPlainInputType{}' valueType: encodedstring.Base64OrPlainInput metadata: type: object nullable: false title: UpdateDocumentAttributesAndContentPayload UpdateAPIProductVersionDTO: description: | The request schema for updating a version of an API product. Note that the `publish_status` and `deprecated` fields are deprecated: Use [PortalProductVersion.publish_status](https://docs.konghq.com/konnect/api/portal-management/v2/#/operations/create-portal-product-version) instead. type: object properties: name: description: The version name of the API product version. type: string example: v1 minLength: 1 publish_status: description: 'The publish status of the API product version. Applies publish status to all related portal product versions. This field is deprecated: Use [PortalProductVersion.publish_status](https://docs.konghq.com/konnect/api/portal-management/v2/#/operations/create-portal-product-version) instead.' type: string example: unpublished enum: - unpublished - published deprecated: true deprecated: description: 'Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use [PortalProductVersion.deprecated](https://docs.konghq.com/konnect/api/portal-management/v2/#/operations/create-portal-product-version) instead.' type: boolean example: false deprecated: true notify: description: | When set to `true`, and all the following conditions are true: - version of the API product deprecation has changed from `false` -> `true` - version of the API product is published then consumers of the now deprecated verion of the API product will be notified. type: boolean example: true gateway_service: $ref: '#/components/schemas/GatewayServicePayload' anyOf: - $ref: '#/components/schemas/GatewayServicePayload' - $ref: '#/components/schemas/LegacyGatewayServicePayload' labels: $ref: '#/components/schemas/LabelsUpdate' additionalProperties: false title: Update API Product Version Request UpdateAPIProductVersionSpecDTO: x-speakeasy-entity: APIProductSpecification description: The request schema for updating a specification for a version of an API product. type: object properties: name: description: The name of the API product version specification type: string example: oas.yaml maxLength: 255 minLength: 1 nullable: false pattern: '^.+(?:\.yaml|\.yml|\.json)$' content: description: The base64 encoded contents of the API product version specification example: TXkgWUFNTCBvciBKU09OIGZvcm1hdHRlZCBPQVMgY29udGVudA== format: byte minLength: 1 type: string x-speakeasy-terraform-custom-type: imports: - github.com/Kong/shared-speakeasy/customtypes/encodedstring schemaType: 'encodedstring.Base64InputType{}' valueType: encodedstring.Base64Input additionalProperties: false title: Update API Product Version Specification Request LegacyGatewayServicePayload: type: object properties: id: description: The identifier of a gateway service associated with the version of the API product. type: string format: uuid example: 09b4786a-3e48-4631-8f6b-62d1d8e1a7f3 runtime_group_id: description: The identifier of the control plane that the gateway service resides in type: string format: uuid example: e4d9ebb1-26b4-426a-b00e-cb67044f3baf deprecated: true additionalProperties: false nullable: true required: - id - runtime_group_id GatewayServicePayload: type: object properties: id: description: The identifier of a gateway service associated with the version of the API product. type: string format: uuid example: 09b4786a-3e48-4631-8f6b-62d1d8e1a7f3 control_plane_id: description: The identifier of the control plane that the gateway service resides in type: string format: uuid example: e4d9ebb1-26b4-426a-b00e-cb67044f3baf additionalProperties: false nullable: true required: - id - control_plane_id PublicLabels: description: | Public labels store information about an entity that can be used for filtering a list of objects. Public labels are intended to store **PUBLIC** metadata. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". type: object example: category: finance additionalProperties: type: string pattern: '^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$' minLength: 1 maxLength: 63 maxProperties: 50 title: PublicLabels UnsupportedMediaTypeError: allOf: - $ref: '#/components/schemas/BaseError' - type: object properties: status: example: 415 title: example: UnsupportedMediaType type: example: 'https://httpstatuses.com/415' instance: example: 'kong:trace:1234567890' detail: example: UnsupportedMediaType LabelsUpdate: description: | Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Labels are intended to store **INTERNAL** metadata. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". type: object example: env: test additionalProperties: type: string pattern: '^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$' minLength: 1 maxLength: 63 nullable: true maxProperties: 50 nullable: true writeOnly: true PublicLabelsUpdate: description: | Public labels store information about an entity that can be used for filtering a list of objects. Public labels are intended to store **PUBLIC** metadata. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". type: object example: category: finance additionalProperties: type: string pattern: '^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$' minLength: 1 maxLength: 63 nullable: true maxProperties: 50 title: PublicLabelsUpdate writeOnly: true PublishStatus: type: string enum: - published - unpublished AuthStrategy: type: object discriminator: propertyName: credential_type mapping: key_auth: '#/components/schemas/AuthStrategyKeyAuth' client_credentials: '#/components/schemas/AuthStrategyClientCredentials' self_managed_client_credentials: '#/components/schemas/AuthStrategyClientCredentials' oneOf: - $ref: '#/components/schemas/AuthStrategyKeyAuth' - $ref: '#/components/schemas/AuthStrategyClientCredentials' PortalClaimMappings: description: Mappings from a portal developer atribute to an Identity Provider claim. type: object properties: name: type: string example: name email: type: string example: email groups: type: string example: custom-group-claim example: name: name email: email groups: custom-group-claim maxProperties: 3 minProperties: 0 title: PortalClaimMappings PortalOIDCConfig: description: Configuration properties for an OpenID Connect Identity Provider. type: object properties: issuer: type: string example: 'https://identity.example.com/v2' client_id: type: string example: x7id0o42lklas0blidl2 scopes: type: array items: type: string example: - email - openid - profile claim_mappings: $ref: '#/components/schemas/PortalClaimMappings' example: issuer: 'https://identity.example.com/v2' client_id: x7id0o42lklas0blidl2 scopes: - email - openid - profile claim_mappings: name: name email: email groups: custom-group-claim required: - issuer - client_id title: PortalOIDCConfig PortalAuthenticationSettingsResponse: x-speakeasy-entity: PortalAuth description: The developer authentication settings for a portal. type: object properties: basic_auth_enabled: description: The portal has basic auth enabled or disabled. type: boolean example: true oidc_auth_enabled: description: The portal has OIDC enabled or disabled. type: boolean example: false saml_auth_enabled: description: The portal has SAML enabled or disabled. type: boolean example: false oidc_team_mapping_enabled: description: IdP groups determine the Portal Teams a developer has. type: boolean example: true idp_mapping_enabled: description: IdP groups determine the Portal Teams a developer has. This will soon replace oidc_team_mapping_enabled. type: boolean example: true konnect_mapping_enabled: description: A Konnect Identity Admin assigns teams to a developer. type: boolean example: false oidc_config: $ref: '#/components/schemas/PortalOIDCConfig' example: basic_auth_enabled: true oidc_auth_enabled: true oidc_team_mapping_enabled: true konnect_mapping_enabled: false oidc_config: issuer: 'https://identity.example.com/v2' client_id: x7id0o42lklas0blidl2 scopes: - email - openid - profile claim_mappings: name: name email: email groups: custom-group-claim required: - basic_auth_enabled - konnect_mapping_enabled - oidc_auth_enabled - oidc_team_mapping_enabled title: PortalAuthenticationSettingsResponse PortalAuthenticationSettingsUpdateRequest: x-speakeasy-entity: PortalAuth description: Properties to update a portal's developer auth settings. type: object properties: basic_auth_enabled: description: The organization has basic auth enabled. type: boolean example: true oidc_auth_enabled: description: The organization has OIDC disabled. type: boolean example: false saml_auth_enabled: description: The portal has SAML enabled or disabled. type: boolean example: false oidc_team_mapping_enabled: description: Whether IdP groups determine the Konnect Portal teams a developer has. type: boolean example: true konnect_mapping_enabled: description: Whether a Konnect Identity Admin assigns teams to a developer. type: boolean example: false idp_mapping_enabled: description: Whether IdP groups determine the Konnect Portal teams a developer has. This will soon replace oidc_team_mapping_enabled. type: boolean example: true oidc_issuer: type: string oidc_client_id: type: string oidc_client_secret: type: string oidc_scopes: type: array items: type: string oidc_claim_mappings: $ref: '#/components/schemas/PortalClaimMappings' example: basic_auth_enabled: true oidc_auth_enabled: true oidc_team_mapping_enabled: true konnect_mapping_enabled: false oidc_issuer: 'https://identity.example.com/v2' oidc_client_id: x7id0o42lklas0blidl2 oidc_scopes: - email - openid - profile oidc_claim_mappings: name: name email: email groups: custom-group-claim title: PortalAuthenticationSettingsUpdateRequest PortalUpdateTeamRequest: description: Properties to update on a team. type: object properties: name: type: string example: IDM - Developers pattern: '^[\w \W]+$' writeOnly: true description: type: string example: The Identity Management (IDM) API team. maxLength: 250 writeOnly: true example: name: IDM - Developers description: The Identity Management (IDM) API team. title: PortalUpdateTeamRequest PortalCreateTeamRequest: x-speakeasy-entity: PortalTeam description: Details about a team to create. type: object properties: name: type: string example: IDM - Developers pattern: '^[\w \W]+$' writeOnly: true description: type: string example: The Identity Management (IDM) team. maxLength: 250 writeOnly: true example: name: IDM - Developers description: The Identity Management (IDM) team. required: - name title: PortalCreateTeamRequest PortalTeamResponse: description: Details about a developer team. type: object properties: id: type: string format: uuid example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 readOnly: true name: type: string example: IDM - Developers maxLength: 250 pattern: '^[\w \W]+$' description: type: string example: The developers for the IDM API. maxLength: 250 created_at: type: string format: date-time example: '1992-02-07T17:46:57.52Z' readOnly: true updated_at: type: string format: date-time example: '2022-02-07T17:00:00.52Z' readOnly: true example: id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 name: IDM - Developers description: The developers for the IDM API. created_at: '1992-02-07T17:46:57.52Z' updated_at: '2022-08-31T17:00:00.52Z' title: PortalTeamResponse ListPortalsResponse: x-speakeasy-entity: PortalList description: A paginated list of portals in the current region in the organization. type: object properties: meta: $ref: '#/components/schemas/PaginatedMeta' data: type: array items: $ref: '#/components/schemas/Portal' example: meta: page: number: 1 size: 10 total: 1 data: - id: 8f9fd312-a987-4628-b4c5-bb4f4fddd5f7 created_at: '2022-02-07T17:46:57.52Z' updated_at: '2022-10-08T17:00:00.52Z' name: Portal A display_name: Developer Portal A description: The Portal A default_domain: 123455678abcd.us.portal.konghq.com is_public: false rbac_enabled: true auto_approve_applications: false auto_approve_developers: true custom_domain: api.example.com custom_client_domain: portal.example.com application_count: 0 developer_count: 0 published_product_count: 0 additionalProperties: false required: - data - meta PortalProductVersionPublishStatus: description: Publication status of the API product version on the portal type: string enum: - published - unpublished PortalProductVersionDeprecated: description: Whether the api product version on the portal is deprecated type: boolean NotifyDevelopers: description: Whether to notify developers who are affected by this change type: boolean title: NotifyDevelopers ApplicationRegistrationEnabled: description: Whether the application registration on this portal for the api product version is enabled type: boolean AutoApproveRegistration: description: Whether the application registration auto approval on this portal for the api product version is enabled type: boolean AuthStrategies: description: A list of authentication strategies type: array items: $ref: '#/components/schemas/AuthStrategy' maxItems: 1 minItems: 0 AuthStrategyIDs: description: A list of authentication strategy IDs type: array items: $ref: '#/components/schemas/UUID_RW' maxItems: 1 minItems: 0 ReplacePortalProductVersionPayload: description: Payload to update a Portal Product Version type: object properties: publish_status: $ref: '#/components/schemas/PortalProductVersionPublishStatus' auth_strategy_ids: $ref: '#/components/schemas/AuthStrategyIDs' application_registration_enabled: $ref: '#/components/schemas/ApplicationRegistrationEnabled' auto_approve_registration: $ref: '#/components/schemas/AutoApproveRegistration' deprecated: $ref: '#/components/schemas/PortalProductVersionDeprecated' notify_developers: $ref: '#/components/schemas/NotifyDevelopers' additionalProperties: false required: - publish_status - application_registration_enabled - auto_approve_registration - deprecated - auth_strategy_ids title: ReplacePortalProductVersionPayload PortalProductVersion: x-speakeasy-entity: PortalProductVersion description: | A Portal Product Version holds metadata that describes how a Product Version is configured for a specific portal. It contains: - Lifecyle and deprecation statuses - Application registration settings like auto approve or whether application registration is enabled - The Authentication Strategy (if present) that is enabled for Application Registration type: object properties: id: $ref: '#/components/schemas/UUID' publish_status: $ref: '#/components/schemas/PortalProductVersionPublishStatus' product_version_id: $ref: '#/components/schemas/UUID_RW' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' auth_strategies: $ref: '#/components/schemas/AuthStrategies' application_registration_enabled: $ref: '#/components/schemas/ApplicationRegistrationEnabled' auto_approve_registration: $ref: '#/components/schemas/AutoApproveRegistration' deprecated: $ref: '#/components/schemas/PortalProductVersionDeprecated' additionalProperties: false required: - id - publish_status - application_registration_enabled - auto_approve_registration - product_version_id - deprecated - auth_strategies - created_at - updated_at title: PortalProductVersion GetPortalResponse: $ref: '#/components/schemas/Portal' UpdatePortalResponse: $ref: '#/components/schemas/Portal' CreatePortalResponse: $ref: '#/components/schemas/Portal' GetPortalAppearanceResponse: example: theme_name: custom use_custom_fonts: true custom_theme: colors: section: header: value: '#F8F8F8' description: Background for header body: value: '#FFFFFF' description: Background for main content hero: value: '#F8F8F8' description: Background for hero section accent: value: '#F8F8F8' description: Subtle background tertiary: value: '#FFFFFF' description: Tertiary background stroke: value: 'rgba(0,0,0,0.1)' description: Border color footer: value: '#07A88D' description: Background for footer text: header: value: 'rgba(0,0,0,0.8)' description: Header text hero: value: '#FFFFFF' description: Hero text headings: value: 'rgba(0,0,0,0.8)' description: Headings text primary: value: 'rgba(0,0,0,0.8)' description: Main content text secondary: value: 'rgba(0,0,0,0.8)' description: Supporting text accent: value: '#07A88D' description: Subtle text link: value: '#07A88D' description: Link text footer: value: '#FFFFFF' description: Footer text button: primary_fill: value: '#1155CB' description: Background for Primary Button primary_text: value: '#FFFFFF' description: Text for Primary Button custom_fonts: base: Roboto code: Roboto headings: Roboto text: catalog: welcome_message: Welcome primary_header: Come on in! images: favicon: data: 'data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' filename: favicon.ico logo: data: 'data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' filename: logo.png catalog_cover: data: 'data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' allOf: - $ref: '#/components/schemas/PortalAppearance' - type: object required: - theme_name - use_custom_fonts - custom_theme - custom_fonts - text - images UpdatePortalAppearanceResponse: example: theme_name: custom use_custom_fonts: true custom_theme: colors: section: header: value: '#F8F8F8' description: Background for header body: value: '#FFFFFF' description: Background for main content hero: value: '#F8F8F8' description: Background for hero section accent: value: '#F8F8F8' description: Subtle background tertiary: value: '#FFFFFF' description: Tertiary background stroke: value: 'rgba(0,0,0,0.1)' description: Border color footer: value: '#07A88D' description: Background for footer text: header: value: 'rgba(0,0,0,0.8)' description: Header text hero: value: '#FFFFFF' description: Hero text headings: value: 'rgba(0,0,0,0.8)' description: Headings text primary: value: 'rgba(0,0,0,0.8)' description: Main content text secondary: value: 'rgba(0,0,0,0.8)' description: Supporting text accent: value: '#07A88D' description: Subtle text link: value: '#07A88D' description: Link text footer: value: '#FFFFFF' description: Footer text button: primary_fill: value: '#1155CB' description: Background for Primary Button primary_text: value: '#FFFFFF' description: Text for Primary Button custom_fonts: base: Roboto code: Roboto headings: Roboto text: catalog: welcome_message: Welcome primary_header: Come on in! images: favicon: data: 'data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' filename: favicon.ico logo: data: 'data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' filename: logo.png catalog_cover: data: 'data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' allOf: - $ref: '#/components/schemas/PortalAppearance' - type: object required: - theme_name - use_custom_fonts - custom_theme - custom_fonts - text - images Portal: x-speakeasy-entity: Portal type: object properties: id: $ref: '#/components/schemas/UUID' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' name: $ref: '#/components/schemas/PortalName' display_name: $ref: '#/components/schemas/PortalDisplayName' description: $ref: '#/components/schemas/PortalDescription' default_domain: description: The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``. type: string format: hostname readOnly: true is_public: description: Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public. type: boolean rbac_enabled: description: 'Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.' type: boolean auto_approve_applications: description: 'Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.' type: boolean auto_approve_developers: description: 'Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.' type: boolean custom_domain: description: 'The custom domain to access the developer portal. A CNAME for the portal''s default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal''s web client and API.' type: string format: hostname nullable: true custom_client_domain: description: 'The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal client will no longer be available. `custom_domain` must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.' type: string format: hostname nullable: true default_application_auth_strategy_id: $ref: '#/components/schemas/DefaultApplicationAuthStratID' labels: $ref: '#/components/schemas/Labels' application_count: description: Number of applications created in the portal. type: number developer_count: description: Number of developers using the portal. type: number published_product_count: description: Number of api products published to the portal type: number example: id: 9f9fd312-a987-4628-b4c5-bb4f4fddd5f7 created_at: '2022-02-07T17:46:57.52Z' updated_at: '2022-10-08T17:00:00.52Z' name: Portal A display_name: Developer Portal A description: The Portal A default_domain: 123455678abcd.us.portal.konghq.com is_public: false rbac_enabled: true auto_approve_applications: false auto_approve_developers: true custom_domain: api.example.com custom_client_domain: portal.example.com application_count: 0 developer_count: 0 published_product_count: 0 additionalProperties: false required: - id - created_at - updated_at - name - display_name - default_domain - is_public - rbac_enabled - auto_approve_applications - auto_approve_developers - custom_domain - custom_client_domain - description - application_count - developer_count - published_product_count PortalDescription: description: The description of the portal. type: string maxLength: 512 nullable: true DefaultApplicationAuthStratID: description: Default strategy ID applied on applications for the portal type: string format: uuid example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7 nullable: true CreatePortalRequest: x-speakeasy-entity: Portal type: object properties: name: $ref: '#/components/schemas/PortalName' display_name: $ref: '#/components/schemas/PortalDisplayName' description: $ref: '#/components/schemas/PortalDescription' is_public: description: Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public. type: boolean rbac_enabled: description: 'Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.' type: boolean auto_approve_applications: description: 'Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.' type: boolean auto_approve_developers: description: 'Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.' type: boolean custom_domain: description: 'The custom domain to access the developer portal. A CNAME for the portal''s default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal''s web client and API.' type: string format: hostname maxLength: 1024 nullable: true custom_client_domain: description: 'The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal will no longer be available. `custom_domain` must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.' type: string format: hostname maxLength: 1024 nullable: true default_application_auth_strategy_id: $ref: '#/components/schemas/DefaultApplicationAuthStratID' labels: $ref: '#/components/schemas/Labels' example: name: DevPortal is_public: false rbac_enabled: true auto_approve_applications: false auto_approve_developers: false custom_domain: api.example.com custom_client_domain: portal.example.com default_application_auth_strategy_id: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7 additionalProperties: false required: - name PortalName: description: 'The name of the portal, used to distinguish it from other portals. Name must be unique.' type: string maxLength: 255 minLength: 1 PortalDisplayName: description: The display name of the portal. This value will be the portal's `name` in Portal API. type: string maxLength: 255 minLength: 1 UpdatePortalRequest: x-speakeasy-entity: Portal type: object properties: name: $ref: '#/components/schemas/PortalName' display_name: $ref: '#/components/schemas/PortalDisplayName' description: $ref: '#/components/schemas/PortalDescription' is_public: description: Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public. type: boolean rbac_enabled: description: 'Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.' type: boolean auto_approve_applications: description: 'Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.' type: boolean auto_approve_developers: description: 'Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.' type: boolean custom_domain: description: 'The custom domain to access the developer portal. A CNAME for the portal''s default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal''s web client and API.' type: string format: hostname maxLength: 1024 nullable: true custom_client_domain: description: 'The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal will no longer be available. `custom_domain` must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.' type: string format: hostname maxLength: 1024 nullable: true default_application_auth_strategy_id: $ref: '#/components/schemas/DefaultApplicationAuthStratID' labels: $ref: '#/components/schemas/LabelsUpdate' example: name: Aperture is_public: false rbac_enabled: true auto_approve_applications: false auto_approve_developers: false custom_domain: api.example.com custom_client_domain: portal.example.com default_application_auth_strategy_id: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7 additionalProperties: false UpdatePortalAppearanceRequest: $ref: '#/components/schemas/PortalAppearance' AppearanceColorVariable: type: object properties: value: type: string maxLength: 255 description: type: string maxLength: 512 example: value: '#000000' description: The color for a type of thing additionalProperties: false required: - value AppearanceThemeColorVariables: type: object properties: section: type: object additionalProperties: false properties: header: $ref: '#/components/schemas/AppearanceColorVariable' body: $ref: '#/components/schemas/AppearanceColorVariable' hero: $ref: '#/components/schemas/AppearanceColorVariable' accent: $ref: '#/components/schemas/AppearanceColorVariable' tertiary: $ref: '#/components/schemas/AppearanceColorVariable' stroke: $ref: '#/components/schemas/AppearanceColorVariable' footer: $ref: '#/components/schemas/AppearanceColorVariable' required: - header - body - hero - accent - tertiary - stroke - footer text: type: object additionalProperties: false properties: header: $ref: '#/components/schemas/AppearanceColorVariable' hero: $ref: '#/components/schemas/AppearanceColorVariable' headings: $ref: '#/components/schemas/AppearanceColorVariable' primary: $ref: '#/components/schemas/AppearanceColorVariable' secondary: $ref: '#/components/schemas/AppearanceColorVariable' accent: $ref: '#/components/schemas/AppearanceColorVariable' link: $ref: '#/components/schemas/AppearanceColorVariable' footer: $ref: '#/components/schemas/AppearanceColorVariable' required: - header - hero - headings - primary - secondary - accent - link - footer button: type: object additionalProperties: false properties: primary_fill: $ref: '#/components/schemas/AppearanceColorVariable' primary_text: $ref: '#/components/schemas/AppearanceColorVariable' required: - primary_fill - primary_text example: section: header: value: '#0A161E' description: Background for header body: value: '#0C0C0C' description: Background for main content hero: value: '#1A1D21' description: Background for hero section accent: value: '#1F1F1F' description: Subtle background tertiary: value: '#222529' description: Tertiary background stroke: value: '#34393F' description: Border color footer: value: '#212429' description: Background for footer text: header: value: '#FFFFFF' description: Header text hero: value: 'rgba(255,255,255,0.8)' description: Hero text headings: value: '#FFFFFF' description: Headings text primary: value: '#C8C8C9' description: Main content text secondary: value: '#919294' description: Supporting text accent: value: '#FFFFFF' description: Subtle text link: value: '#2977FF' description: Link text footer: value: '#FFFFFF' description: Footer text button: primary_fill: value: '#1155CB' description: Background for Primary Button primary_text: value: '#FFFFFF' description: Text for Primary Button additionalProperties: false required: - section - text - button NullableAppearanceThemeVariables: description: Groups of variables for configuring visual details of the portal user interface. Set theme_name to 'custom' to use custom values for theme variables. type: object properties: colors: $ref: '#/components/schemas/AppearanceThemeColorVariables' example: colors: section: header: value: '#F8F8F8' description: Background for header body: value: '#FFFFFF' description: Background for main content hero: value: '#F8F8F8' description: Background for hero section accent: value: '#F8F8F8' description: Subtle background tertiary: value: '#FFFFFF' description: Tertiary background stroke: value: 'rgba(0,0,0,0.1)' description: Border color footer: value: '#07A88D' description: Background for footer text: header: value: 'rgba(0,0,0,0.8)' description: Header text hero: value: '#FFFFFF' description: Hero text headings: value: 'rgba(0,0,0,0.8)' description: Headings text primary: value: 'rgba(0,0,0,0.8)' description: Main content text secondary: value: 'rgba(0,0,0,0.8)' description: Supporting text accent: value: '#07A88D' description: Subtle text link: value: '#07A88D' description: Link text footer: value: '#FFFFFF' description: Footer text button: primary_fill: value: '#1155CB' description: Background for Primary Button primary_text: value: '#FFFFFF' description: Text for Primary Button additionalProperties: false nullable: true required: - colors title: AppearanceThemeVariables NullableAppearanceFonts: description: Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values. type: object properties: base: $ref: '#/components/schemas/AppearanceFontName' code: $ref: '#/components/schemas/AppearanceFontName' headings: $ref: '#/components/schemas/AppearanceFontName' additionalProperties: false nullable: true required: - base - code - headings AppearanceFontName: description: The name of the font to render in the browser. type: string example: Roboto enum: - Roboto - Inter - Open Sans - Lato - Slabo 27px - Slabo 13px - Oswald - Source Sans Pro - Montserrat - Raleway - PT Sans - Lora - Roboto Mono - Inconsolata - Source Code Pro - PT Mono - Ubuntu Mono - IBM Plex Mono AppearanceImage: description: 'The image data to upload, along with an optional filename. Images must be a data URL with binary image data in base 64 format. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs.' type: object properties: data: $ref: '#/components/schemas/ImageDataUri' filename: type: string maxLength: 512 example: data: 'data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' additionalProperties: false nullable: true required: - data AppearanceImages: description: A collection of binary image data to customize images in the portal type: object properties: logo: $ref: '#/components/schemas/AppearanceImage' favicon: $ref: '#/components/schemas/AppearanceImage' catalog_cover: $ref: '#/components/schemas/AppearanceImage' example: logo: data: 'data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' favicon: data: 'data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' catalog_cover: data: 'data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' additionalProperties: false nullable: true NullableAppearanceTextVariables: description: Values to display for customizable text in the portal user interface type: object properties: catalog: type: object additionalProperties: false properties: welcome_message: type: string maxLength: 512 primary_header: type: string maxLength: 512 required: - welcome_message - primary_header example: catalog: welcome_message: Welcome to our service catalog primary_header: Find All of Our Services in a Single Place additionalProperties: false nullable: true required: - catalog PortalAppearance: type: object properties: theme_name: $ref: '#/components/schemas/PortalTheme' custom_theme: $ref: '#/components/schemas/NullableAppearanceThemeVariables' custom_fonts: $ref: '#/components/schemas/NullableAppearanceFonts' use_custom_fonts: description: 'If true, fonts in custom_fonts will be used over the theme''s default fonts' type: boolean text: $ref: '#/components/schemas/NullableAppearanceTextVariables' images: $ref: '#/components/schemas/AppearanceImages' example: theme_name: custom use_custom_fonts: true custom_theme: colors: section: header: value: '#F8F8F8' description: Background for header body: value: '#FFFFFF' description: Background for main content hero: value: '#F8F8F8' description: Background for hero section accent: value: '#F8F8F8' description: Subtle background tertiary: value: '#FFFFFF' description: Tertiary background stroke: value: 'rgba(0,0,0,0.1)' description: Border color footer: value: '#07A88D' description: Background for footer text: header: value: 'rgba(0,0,0,0.8)' description: Header text hero: value: '#FFFFFF' description: Hero text headings: value: 'rgba(0,0,0,0.8)' description: Headings text primary: value: 'rgba(0,0,0,0.8)' description: Main content text secondary: value: 'rgba(0,0,0,0.8)' description: Supporting text accent: value: '#07A88D' description: Subtle text link: value: '#07A88D' description: Link text footer: value: '#FFFFFF' description: Footer text button: primary_fill: value: '#1155CB' description: Background for Primary Button primary_text: value: '#FFFFFF' description: Text for Primary Button custom_fonts: base: Roboto code: Roboto headings: Roboto text: catalog: welcome_message: Welcome primary_header: Come one in! images: favicon: data: 'data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' filename: favicon.ico logo: data: 'data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' filename: logo.png catalog_cover: data: 'data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU=' additionalProperties: false PortalTheme: description: Select a pre-existing default theme or specify 'custom' to use custom_theme variables. type: string example: mint_rocket enum: - mint_rocket - dark_mode - custom UUID: description: Contains a unique identifier used for this resource. type: string format: uuid example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7 readOnly: true UUID_RW: description: Contains a unique identifier used for this resource. type: string format: uuid example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7 AuthStrategyKeyAuth: description: KeyAuth Auth strategy that the application uses. type: object properties: id: description: The Application Auth Strategy ID. type: string format: uuid example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8 readOnly: true name: type: string example: name credential_type: type: string enum: - key_auth key_names: type: array items: type: string additionalProperties: false required: - id - name - credential_type - key_names AuthMethods: type: array items: description: Auth Methods enabled for this strategy type: string example: - bearer AvailableScopes: description: Possible developer selectable scopes for an application. Only present when using DCR Provider that supports it. type: array items: type: string example: - scope1 - scope2 AuthStrategyClientCredentials: description: Client Credential Auth strategy that the application uses. type: object properties: id: description: The Application Auth Strategy ID. type: string format: uuid example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8 readOnly: true name: type: string example: name credential_type: type: string enum: - client_credentials - self_managed_client_credentials auth_methods: $ref: '#/components/schemas/AuthMethods' available_scopes: $ref: '#/components/schemas/AvailableScopes' additionalProperties: false required: - id - name - credential_type - auth_methods ImageDataUri: description: 'must be a data URL with base64 image data, e.g., data:image/jpeg;base64,' type: string format: uri example: 'data:image/png,YW5faW1hZ2VfZmlsZQ==' pattern: '^data:image/(png|jpeg|x-icon|ico|icon|vnd.microsoft.icon|gif)(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$' title: ImageDataUri x-validation-message: 'must be a data URL with base64 image data, e.g., data:image/jpeg;base64,' DcrProviderType: description: 'The type of DCR provider. Can be one of the following - auth0, azureAd, curity, okta, http' type: string enum: - auth0 - azureAd - curity - okta - http title: DcrProviderType AppAuthStrategyConfigKeyAuth: description: | The most basic mode to configure an Application Auth Strategy for an API Product Version. Using this mode will allow developers to generate API keys that will authenticate their application requests. Once authenticated, an application will be granted access to any Product Version it is registered for that is configured for Key Auth. type: object properties: key_names: description: The names of the headers containing the API key. You can specify multiple header names. type: array items: type: string maxLength: 256 maxItems: 10 minItems: 1 additionalProperties: false title: AppAuthStrategyConfigKeyAuth PartialAppAuthStrategyConfigOpenIDConnect: description: | A more advanced mode to configure an API Product Version’s Application Auth Strategy. Using this mode will allow developers to use API credentials issued from an external IdP that will authenticate their application requests. Once authenticated, an application will be granted access to any Product Version it is registered for that is configured for the same Auth Strategy. An OIDC strategy may be used in conjunction with a DCR provider to automatically create the IdP application. type: object properties: issuer: type: string format: url maxLength: 256 credential_claim: type: array items: type: string maxLength: 128 maxItems: 10 scopes: type: array items: type: string maxLength: 128 maxItems: 50 auth_methods: type: array items: type: string maxLength: 64 maxItems: 10 additionalProperties: true title: PartialAppAuthStrategyConfigOpenIDConnect AppAuthStrategyConfigOpenIDConnect: description: | A more advanced mode to configure an API Product Version’s Application Auth Strategy. Using this mode will allow developers to use API credentials issued from an external IdP that will authenticate their application requests. Once authenticated, an application will be granted access to any Product Version it is registered for that is configured for the same Auth Strategy. An OIDC strategy may be used in conjunction with a DCR provider to automatically create the IdP application. type: object properties: issuer: type: string format: url maxLength: 256 credential_claim: type: array items: type: string maxLength: 128 maxItems: 10 scopes: type: array items: type: string maxLength: 128 maxItems: 50 auth_methods: type: array items: type: string maxLength: 64 maxItems: 10 additionalProperties: true required: - issuer - credential_claim - scopes - auth_methods title: AppAuthStrategyConfigOpenIDConnect AppAuthStrategyKeyAuthRequest: description: Request for creating a Key Auth Application Auth Strategy type: object properties: name: $ref: '#/components/schemas/AuthStrategyName' display_name: $ref: '#/components/schemas/AuthStrategyDisplayName' strategy_type: type: string enum: - key_auth configs: description: JSON-B object containing the configuration for the Key Auth strategy type: object additionalProperties: false properties: key-auth: $ref: '#/components/schemas/AppAuthStrategyConfigKeyAuth' required: - key-auth labels: $ref: '#/components/schemas/Labels' additionalProperties: false required: - name - display_name - strategy_type - configs title: AppAuthStrategyKeyAuthRequest AppAuthStrategyKeyAuthResponse: description: Response payload from creating or updating a Key Auth Application Auth Strategy type: object properties: id: $ref: '#/components/schemas/UUID' name: $ref: '#/components/schemas/AuthStrategyName' display_name: $ref: '#/components/schemas/AuthStrategyDisplayName' strategy_type: type: string enum: - key_auth configs: description: JSON-B object containing the configuration for the Key Auth strategy type: object additionalProperties: false properties: key-auth: $ref: '#/components/schemas/AppAuthStrategyConfigKeyAuth' required: - key-auth active: description: At least one published entity is using this auth strategy. type: boolean dcr_provider: type: object additionalProperties: false nullable: true properties: id: $ref: '#/components/schemas/UUID' name: type: string display_name: $ref: '#/components/schemas/DcrProviderDisplayName' provider_type: $ref: '#/components/schemas/DcrProviderType' required: - id - name - provider_type labels: $ref: '#/components/schemas/Labels' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' additionalProperties: false required: - id - name - display_name - strategy_type - configs - active - dcr_provider - labels - created_at - updated_at title: AppAuthStrategyKeyAuthResponse AppAuthStrategyOpenIDConnectRequest: description: Payload for creating an OIDC Application Auth Strategy type: object properties: name: $ref: '#/components/schemas/AuthStrategyName' display_name: $ref: '#/components/schemas/AuthStrategyDisplayName' strategy_type: type: string enum: - openid_connect configs: description: JSON-B object containing the configuration for the OIDC strategy type: object additionalProperties: false properties: openid-connect: $ref: '#/components/schemas/AppAuthStrategyConfigOpenIDConnect' required: - openid-connect dcr_provider_id: type: string format: uuid nullable: true labels: $ref: '#/components/schemas/Labels' additionalProperties: false required: - name - display_name - strategy_type - configs title: AppAuthStrategyOpenIDConnectRequest AppAuthStrategyOpenIDConnectResponse: description: Response payload from creating an OIDC Application Auth Strategy type: object properties: id: $ref: '#/components/schemas/UUID' name: $ref: '#/components/schemas/AuthStrategyName' display_name: $ref: '#/components/schemas/AuthStrategyDisplayName' strategy_type: type: string enum: - openid_connect configs: description: JSON-B object containing the configuration for the OIDC strategy type: object additionalProperties: false properties: openid-connect: $ref: '#/components/schemas/AppAuthStrategyConfigOpenIDConnect' required: - openid-connect active: description: At least one published entity is using this auth strategy. type: boolean dcr_provider: type: object additionalProperties: false nullable: true properties: id: $ref: '#/components/schemas/UUID' name: type: string display_name: $ref: '#/components/schemas/DcrProviderDisplayName' provider_type: $ref: '#/components/schemas/DcrProviderType' required: - id - name - provider_type labels: $ref: '#/components/schemas/Labels' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' additionalProperties: false required: - id - name - display_name - strategy_type - configs - active - dcr_provider - labels - created_at - updated_at title: AppAuthStrategyOpenIDConnectResponse CreateAppAuthStrategyRequest: x-speakeasy-entity: ApplicationAuthStrategy description: Request body for creating an Application Auth Strategy type: object discriminator: propertyName: strategy_type mapping: key_auth: '#/components/schemas/AppAuthStrategyKeyAuthRequest' openid_connect: '#/components/schemas/AppAuthStrategyOpenIDConnectRequest' oneOf: - $ref: '#/components/schemas/AppAuthStrategyKeyAuthRequest' - $ref: '#/components/schemas/AppAuthStrategyOpenIDConnectRequest' required: - strategy_type title: CreateAppAuthStrategyRequest AppAuthStrategy: x-speakeasy-entity: ApplicationAuthStrategy description: A set of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version. Called “Auth Strategy” for short in the context of portals/applications. The plugins are synced to any Gateway Service that is currently linked or becomes linked to the Product Version. type: object discriminator: propertyName: strategy_type mapping: key_auth: '#/components/schemas/AppAuthStrategyKeyAuthResponse' openid_connect: '#/components/schemas/AppAuthStrategyOpenIDConnectResponse' oneOf: - $ref: '#/components/schemas/AppAuthStrategyKeyAuthResponse' - $ref: '#/components/schemas/AppAuthStrategyOpenIDConnectResponse' required: - strategy_type title: AppAuthStrategy UpdateAppAuthStrategyRequest: x-speakeasy-entity: ApplicationAuthStrategy description: Request body for updating an Application Auth Strategy type: object properties: name: $ref: '#/components/schemas/AuthStrategyName' display_name: $ref: '#/components/schemas/AuthStrategyDisplayName' labels: $ref: '#/components/schemas/LabelsUpdate' dcr_provider_id: type: string format: uuid nullable: true configs: description: JSON-B object containing the configuration for the OIDC strategy under the key 'openid-connect' or the configuration for the Key Auth strategy under the key 'key-auth' type: object oneOf: - type: object additionalProperties: false required: - openid-connect properties: openid-connect: $ref: '#/components/schemas/PartialAppAuthStrategyConfigOpenIDConnect' - type: object additionalProperties: false required: - key-auth properties: key-auth: $ref: '#/components/schemas/AppAuthStrategyConfigKeyAuth' additionalProperties: false title: UpdateAppAuthStrategyRequest CreateAppAuthStrategyResponse: $ref: '#/components/schemas/AppAuthStrategy' UpdateAppAuthStrategyResponse: $ref: '#/components/schemas/AppAuthStrategy' GetAppAuthStrategyResponse: $ref: '#/components/schemas/AppAuthStrategy' DcrProviderDisplayName: description: | The display name of the DCR provider. This is used to identify the DCR provider in the Portal UI. type: string maxLength: 256 minLength: 1 AuthStrategyName: description: | The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI. type: string maxLength: 256 minLength: 1 AuthStrategyDisplayName: description: | The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI. type: string maxLength: 256 Team: x-speakeasy-entity: Team description: The team object contains information about a group of users. type: object properties: id: description: The team ID. type: string format: uuid example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 readOnly: true name: description: The name of the team. type: string example: IDM - Developers maxLength: 250 pattern: '^[\w \W]+$' description: description: The team description in Konnect. type: string example: The developers for the IDM API. maxLength: 250 system_team: description: 'Returns True if a user belongs to a `system_team`. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"' type: boolean readOnly: true labels: $ref: '#/components/schemas/Labels' created_at: description: A Unix timestamp representation of team creation. type: string format: date-time example: '1992-02-07T17:46:57.52Z' readOnly: true updated_at: description: | A Unix timestamp representation of the most recent change to the team object in Konnect. type: string format: date-time example: '2022-02-07T17:00:00.52Z' readOnly: true example: id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 name: IDM - Developers description: The developers for the IDM API. system_team: false labels: env: test created_at: '1992-02-07T17:46:57.52Z' updated_at: '2022-08-31T17:00:00.52Z' title: Team AssignedRole: description: An assigned role is a role that has been assigned to a user or team. type: object properties: id: description: The ID of the role assignment. type: string format: uuid example: eaf7adf1-32c8-4bbf-b960-d1f8456afe67 role_name: description: Name of the role being assigned. type: string example: Viewer entity_id: description: A RBAC entity ID. type: string format: uuid example: 817d0422-45c9-4d88-8d64-45aef05c1ae7 entity_type_name: description: Name of the entity type the role is being assigned to. type: string example: Control Planes entity_region: description: Region of the entity. type: string example: eu enum: - us - eu - au - me - in - '*' example: id: 54cc6168-ebb1-4300-8168-d62a0dd08fc8 role_name: Viewer entity_id: 18ee2573-dec0-4b83-be99-fa7700bcdc61 entity_type_name: Control Planes entity_region: us title: AssignedRole SystemAccount: x-speakeasy-entity: SystemAccount description: Schema of the system account. type: object properties: id: description: ID of the system account. type: string format: uuid readOnly: true name: description: Name of the system account. type: string description: description: Description of the system account. type: string created_at: description: Timestamp of when the system account was created. type: string format: date-time readOnly: true updated_at: description: Timestamp of when the system account was last updated. type: string format: date-time readOnly: true konnect_managed: description: The system account is managed by Konnect (true/false). type: boolean example: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08 name: Example System Account description: This is a sample system account description. created_at: '2022-08-24T14:15:22Z' updated_at: '2022-10-05T10:33:49Z' konnect_managed: false title: System Account SystemAccountAccessToken: x-speakeasy-entity: SystemAccountAccessToken description: Schema of the system account access token. type: object properties: id: description: ID of the system account access token. type: string format: uuid readOnly: true name: description: Name of the system account access token. type: string created_at: description: Timestamp of when the system account access token was created. type: string format: date-time readOnly: true updated_at: description: Timestamp of when the system account access token was last updated. type: string format: date-time readOnly: true expires_at: description: Timestamp of when the system account access token will expire. type: string format: date-time last_used_at: description: Timestamp of when the system account access token was last used. type: string format: date-time readOnly: true example: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08 name: Sample Access Token created_at: '2022-08-01T14:16:09Z' updated_at: '2022-08-02T08:35:49Z' expires_at: '2022-12-31T12:52:23Z' last_used_at: '2022-10-24T13:05:42Z' title: System Account Access Token ServerlessCloudGateway: x-speakeasy-entity: ServerlessCloudGateway description: A serverless cloud gateway type: object properties: control_plane: $ref: '#/components/schemas/ServerlessControlPlane' gateway_endpoint: description: Endpoint for the serverless cloud gateway. type: string format: hostname example: us-kong-4594857kpl.kongcloud.dev readOnly: true created_at: type: string format: date-time example: '2023-01-11T02:30:42.227Z' readOnly: true updated_at: type: string format: date-time example: '2023-01-11T02:30:42.227Z' readOnly: true labels: $ref: '#/components/schemas/SCGWLabels' required: - control_plane - gateway_endpoint - updated_at - created_at title: ServerlessCloudGateway CreateServerlessCloudGatewayRequest: x-speakeasy-entity: ServerlessCloudGateway description: Schema to create a serverless cloud gateway. type: object properties: control_plane: $ref: '#/components/schemas/ServerlessControlPlane' cluster_cert: description: The cluster certificate (public key). type: string example: | -----BEGIN CERTIFICATE----- MIICRDCCAa2gAwIBAgIBADANBgkqhkiG9w0BAQ0FADA/MQswCQYDVQQGEwJ1czEL MAkGA1UECAwCVFgxDTALBgNVBAoMBFRlc3QxFDASBgNVBAMMC2V4YW1wbGUuY29t MB4XDTI0MDQyNjA5NTA1OVoXDTI1MDQyNjA5NTA1OVowPzELMAkGA1UEBhMCdXMx CzAJBgNVBAgMAlRYMQ0wCwYDVQQKDARUZXN0MRQwEgYDVQQDDAtleGFtcGxlLmNv bTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA8FaJZmPsthBT1XkTyqUJiuQV 4p4KaLpNMioNQtIdeGKFXelmZlVfW0bfLGBgFmkwo19KIzFtOlITUjb0Qqlub2Dn TIPoDs7rXA8aw6umJu73Z6647U3+alxNCpwTuYOY2CJQ+HWEIuOuwAdtQkndEp9r 7ZWA2xLatQKBYEvEmykCAwEAAaNQME4wHQYDVR0OBBYEFGUznNeZK74vlA4bqKHb 706tyMwcMB8GA1UdIwQYMBaAFGUznNeZK74vlA4bqKHb706tyMwcMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQENBQADgYEARmnu/2vUcmJYLlg86MN0prXGC3CGXsem fDtPF4SBPxfchdG7HJKywTloIiCBKGEQALkCHiJcQJNcSHmzH3/Qk+SrOJNH01gt HsKA4SNFJZR5fCRpT6USCukyE2Wlr+PWPscrFCWbLXhK4Ql/t0oog1255B10HqKk 1qDkNrzCd/o= -----END CERTIFICATE----- cluster_cert_key: description: The cluster certificate key (private key). type: string example: | -----BEGIN PRIVATE KEY----- MIICeAIBADANBgkqhkiG9w0BAQEFAASCAmIwggJeAgEAAoGBAPBWiWZj7LYQU9V5 E8qlCYrkFeKeCmi6TTIqDULSHXhihV3pZmZVX1tG3yxgYBZpMKNfSiMxbTpSE1I2 9EKpbm9g50yD6A7O61wPGsOrpibu92euuO1N/mpcTQqcE7mDmNgiUPh1hCLjrsAH bUJJ3RKfa+2VgNsS2rUCgWBLxJspAgMBAAECgYEAvA7qqozL/1ZdUu/P1cQ36E86 9L03ZeVJXFRdVgj2eGqW8vob3z00RUb6gE3VQhQDNALvDwSw9G6eoblQfgz31Hju sb+j6bGOm2BqzYrx6rpcgme7k9ScV0tEbtiBNX0E/ToHvNywHtdOBvDocN2wh42Z 6bS9um51H+SXR036mgUCQQD4T7WrJHL97Hj8TtHnTw895xWKaGn94H7ZQa2lo1nk 7CQ4Oi8rFX5tDdyV7UU6fekBWuhpmIhSGJhyHD7UThBjAkEA98ef9ey2Qx+j+R8S tgpgJAF3LVNJJicEHCS/Vltgc84X/vidVAMa2+TYPxPrrUjxBr0STCeB5wZhvvsB D8cOAwJBAJ5JqaQPUx1dDe7Ai/vooO20Dj4xu0c0QYha3sfU7qwIgDo7lO/g/ruj 93a3TscvlkXf3oHZ0ySKOzual86ciMMCQQDGOLgaWHVy+4QFTzt70I8bHuUFqKRT VlEuZqN/ZXijDFQcES5jwFwjYE8zHy+ioEDaIDXcIJsGhA98Zndx9M+bAkA4IFdx 4YIDhuk1MJAYPqVQs5szEF/0BGymLNVYlIox48bZg+TH3uXwTVRVySxvpRa8dd3O 0gHs3EIV6GFUl7ev -----END PRIVATE KEY----- x-speakeasy-param-sensitive: true labels: $ref: '#/components/schemas/SCGWLabels' additionalProperties: false required: - control_plane - cluster_cert - cluster_cert_key title: CreateServerlessCloudGatewayRequest SCGWLabels: description: 'Labels to facilitate tagged search on serverless cloud gateways. Keys must be of length 1-63 characters, and cannot start with ''kong'', ''konnect'', ''mesh'', ''kic'', or ''_''.' type: object example: env: test additionalProperties: type: string pattern: '^[a-z0-9A-Z]{1}([a-z0-9A-Z\-\.\_]*[a-z0-9A-Z]+)?$' minLength: 1 maxLength: 63 title: Labels CpRegion: description: The control plane region. type: string example: us enum: - us - eu - au title: Control plane region x-enum-varnames: - US - Europe - Aus ServerlessControlPlane: type: object properties: id: description: ID of the serverless cloud gateway CP. type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a prefix: description: The prefix of the serverless cloud gateway CP. type: string example: 518da50bf7 region: $ref: '#/components/schemas/CpRegion' required: - id - prefix - region title: Control plane x-go-name: ControlPlane LogFormat: description: The output format of each log messages. type: string default: cef enum: - cef - json - cps AuditLogDestination: description: Audit Log Destination Schema type: object properties: id: description: The unique ID of the audit log destination. type: string format: uuid name: description: The name of the audit log destination. type: string endpoint: description: The endpoint that will receive audit log messages. type: string example: 'https://example.com/audit-logs' log_format: $ref: '#/components/schemas/LogFormat' skip_ssl_verification: description: Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads. type: boolean example: false created_at: description: Timestamp when this webhook was created. type: string format: date-time readOnly: true updated_at: description: 'Timestamp when this webhook was last updated. Initial value is 0001-01-01T00:00:0Z.' type: string format: date-time readOnly: true title: AuditLogDestination CreateApiKeyResult: type: object properties: id: type: string type: $ref: '#/components/schemas/KeyTypeEnum' secret: type: string x-speakeasy-param-sensitive: true created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' tags: $ref: '#/components/schemas/Tags' required: - id - type - secret - created_at - updated_at - tags KeyTypeEnum: type: string enum: - legacy - new ApiKey: type: object properties: id: type: string created_at: $ref: '#/components/schemas/CreatedAt' tags: $ref: '#/components/schemas/Tags' type: $ref: '#/components/schemas/KeyTypeEnum' required: - id - created_at - type - tags ConsumerRealm: type: object properties: id: type: string x-speakeasy-param-suppress-computed-diff: true name: type: string ttl: $ref: '#/components/schemas/RealmTTL' negative_ttl: $ref: '#/components/schemas/NegativeTTL' consumer_groups: $ref: '#/components/schemas/RealmConsumerGroups' allowed_control_planes: $ref: '#/components/schemas/AllowedControlPlanes' allow_all_control_planes: $ref: '#/components/schemas/AllowAllControlPlanes' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - id - name - allowed_control_planes - allow_all_control_planes - ttl - negative_ttl - consumer_groups - created_at - updated_at ConsumerRealmCreateRequest: type: object properties: name: type: string allowed_control_planes: $ref: '#/components/schemas/AllowedControlPlanes' allow_all_control_planes: $ref: '#/components/schemas/AllowAllControlPlanes' ttl: $ref: '#/components/schemas/RealmTTL' negative_ttl: $ref: '#/components/schemas/NegativeTTL' consumer_groups: $ref: '#/components/schemas/RealmConsumerGroups' additionalProperties: false required: - name UpdateConsumerPayload: type: object properties: username: $ref: '#/components/schemas/ConsumerUsername' 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 minLength: 1 nullable: true consumer_groups: description: | A list of consumer groups that the Consumer is in. If `consumer_groups` are provided on the Consumer object _and_ on the Realm, the Consumer will be placed in all defined consumer groups. type: array items: type: string uniqueItems: true nullable: true title: ConsumerGroups x-speakeasy-param-suppress-computed-diff: true type: $ref: '#/components/schemas/ConsumerType' tags: $ref: '#/components/schemas/Tags' additionalProperties: false AllowAllControlPlanes: description: | Allow all control planes to use the realm. When this value is set it takes precedence on `allowed_control_planes`. type: boolean nullable: false x-speakeasy-param-suppress-computed-diff: true ConsumerRealmUpdateRequest: type: object properties: name: type: string allowed_control_planes: $ref: '#/components/schemas/AllowedControlPlanes' allow_all_control_planes: $ref: '#/components/schemas/AllowAllControlPlanes' consumer_groups: $ref: '#/components/schemas/RealmConsumerGroups' ttl: $ref: '#/components/schemas/RealmTTL' negative_ttl: $ref: '#/components/schemas/NegativeTTL' additionalProperties: false ConsumerUsername: description: The unique username of the Consumer. type: string minLength: 1 ConsumerCustomID: description: Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. type: string minLength: 1 RealmTTL: description: | The time in minutes that the Consumer will be cached in memory on a running Gateway if it is successfully loaded from Konnect. type: integer default: 10 minimum: 5 NegativeTTL: description: | If a running Gateway triggers a lookup for a Consumer that cannot be authenticated this realm, a `negative_ttl` is set. The Gateway will not try to lookup the Consumer in Konnect for `negative_ttl` minutes. A Consumer will be cached for `negative_ttl` if they do not exist in the Realm, or if the provided credentials are invalid. type: integer default: 10 minimum: 5 ConsumerCreateRequest: type: object properties: username: $ref: '#/components/schemas/ConsumerUsername' custom_id: $ref: '#/components/schemas/ConsumerCustomID' consumer_groups: $ref: '#/components/schemas/ConsumerGroups' type: $ref: '#/components/schemas/ConsumerType' tags: $ref: '#/components/schemas/Tags' additionalProperties: false required: - username AllowedControlPlanes: description: | List of control plane ids that are allowed to use the realm. This is used when `allow_all_control_planes` value is set to false. type: array items: type: string uniqueItems: true x-speakeasy-param-suppress-computed-diff: true format: set ConsumerType: description: | Type of the consumer. type: string default: proxy enum: - proxy - developer - admin - application Tags: type: array items: type: string uniqueItems: true x-speakeasy-param-suppress-computed-diff: true ConsumerGroups: description: | A list of consumer groups that the Consumer is in. If `consumer_groups` are provided on the Consumer object _and_ on the Realm, the Consumer will be placed in all defined consumer groups. type: array items: type: string uniqueItems: true title: ConsumerGroups x-speakeasy-param-suppress-computed-diff: true CentralizedConsumer: description: 'The Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong and your existing primary datastore.' type: object properties: id: description: The Consumer ID. type: string format: uuid example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8 readOnly: true x-speakeasy-param-suppress-computed-diff: true username: description: The unique username of the Consumer. You must send either this field or `custom_id` with the request. type: string nullable: true 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. type: string nullable: true type: $ref: '#/components/schemas/ConsumerType' tags: $ref: '#/components/schemas/Tags' consumer_groups: $ref: '#/components/schemas/ConsumerGroups' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' example: custom_id: '4200' id: 8a388226-80e8-4027-a486-25e4f7db5d21 type: proxy consumer_groups: - gold tags: - partner username: bob-the-builder created_at: '2025-06-17T16:55:58.569399532Z' updated_at: '2025-06-17T16:55:58.569399532Z' additionalProperties: false required: - id - username - custom_id - type - tags - consumer_groups - created_at - updated_at RealmConsumerGroups: description: | A list of consumer groups to automatically add to any consumers created within this Realm. If `consumer_groups` are provided on the Consumer object _and_ on the Realm, the Consumer will be placed in all defined consumer groups. type: array items: type: string uniqueItems: true format: set title: RealmConsumerGroups x-speakeasy-param-suppress-computed-diff: true KMSARN: description: 'The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.' type: string example: 'arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012' CMEKName: description: The name of the CMEK. We recommend you match the key's name used in KMS. type: string example: My KMS Key minLength: 1 CMEKDescription: description: An optional description of the CMEK. type: string example: My Key Description CMEK: type: object properties: id: type: string x-speakeasy-ignore: true key_arn: $ref: '#/components/schemas/KMSARN' name: $ref: '#/components/schemas/CMEKName' description: $ref: '#/components/schemas/CMEKDescription' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - id - key_arn - name - created_at - updated_at CreateCatalogService: type: object properties: name: description: | The machine name of the Service that uniquely identifies it within the catalog. type: string example: user-svc maxLength: 120 minLength: 1 pattern: '^[0-9a-z.-]+$' display_name: description: The display name of the Service. type: string example: User Service maxLength: 120 minLength: 1 description: description: Optionally provide a description of the Service. type: string maxLength: 2048 nullable: true labels: $ref: '#/components/schemas/Labels' custom_fields: $ref: '#/components/schemas/CustomFields' additionalProperties: false required: - name - display_name UpdateCatalogService: type: object properties: name: description: | The machine name of the Service that uniquely identifies it within the catalog. type: string example: user-svc maxLength: 120 minLength: 1 pattern: '^[0-9a-z.-]+$' display_name: description: The display name of the Service. type: string example: User Service maxLength: 120 minLength: 1 description: description: Optionally provide a description of the Service. type: string maxLength: 2048 nullable: true labels: $ref: '#/components/schemas/LabelsUpdate' custom_fields: $ref: '#/components/schemas/CustomFields' additionalProperties: false CatalogService: description: The service object contains information about a Service Catalog service. type: object properties: id: description: The service ID. type: string format: uuid example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 readOnly: true name: description: | The machine name of the Service that uniquely identifies it within the catalog. type: string example: user-svc maxLength: 120 minLength: 1 pattern: '^[0-9a-z.-]+$' display_name: description: The display name of the Service. type: string example: User Service maxLength: 120 minLength: 1 description: description: Optionally provide a description of the Service. type: string maxLength: 2048 nullable: true custom_fields: $ref: '#/components/schemas/CustomFields' labels: $ref: '#/components/schemas/Labels' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - id - name - display_name - description - custom_fields - labels - created_at - updated_at title: CatalogService CreateIntegrationInstance: type: object properties: integration_name: description: The type of integration instance to create. type: string example: aws-lambda maxLength: 120 minLength: 1 pattern: '^[0-9a-z.-]+$' name: description: | The machine name of the integration instance that uniquely identifies it within the catalog. type: string example: aws-lambda-prod maxLength: 120 minLength: 1 pattern: '^[0-9a-z.-]+$' display_name: description: The display name of the integration instance. type: string example: AWS (prod) maxLength: 120 minLength: 1 description: description: Optionally provide a description of the integration instance. type: string maxLength: 2048 nullable: true config: $ref: '#/components/schemas/IntegrationInstanceConfig' additionalProperties: false required: - integration_name - name - display_name - config UpdateIntegrationInstance: type: object properties: name: description: | The machine name of the integration instance that uniquely identifies it within the catalog. type: string example: aws-lambda-prod maxLength: 120 minLength: 1 pattern: '^[0-9a-z.-]+$' display_name: description: The display name of the integration instance. type: string example: AWS (prod) maxLength: 120 minLength: 1 description: description: Optionally provide a description of the integration instance. type: string maxLength: 2048 nullable: true config: $ref: '#/components/schemas/IntegrationInstanceConfig' additionalProperties: false IntegrationInstance: description: Information about an integration instance. type: object properties: id: description: The integration instance ID. type: string format: uuid example: 3f51fa25-310a-421d-bd1a-007f859021a3 readOnly: true name: description: | The machine name of the integration instance that uniquely identifies it within the catalog. type: string example: aws-lambda-prod maxLength: 120 minLength: 1 pattern: '^[0-9a-z.-]+$' display_name: description: The display name of the integration instance. type: string example: AWS (prod) maxLength: 120 minLength: 1 description: description: The description of the integration instance. type: string maxLength: 2048 nullable: true integration: $ref: '#/components/schemas/IntegrationRefWithoutInstance' authorized: description: Denotes whether the integration instance has been authorized within the catalog. type: boolean example: true readOnly: true config: $ref: '#/components/schemas/IntegrationInstanceConfig' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - id - name - display_name - description - integration - authorized - config - created_at - updated_at IntegrationInstanceConfig: description: | JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. type: object example: account_region: eu default: {} additionalProperties: true x-speakeasy-type-override: any CreateIntegrationInstanceAuthCredential: oneOf: - $ref: '#/components/schemas/CreateMultiKeyAuthCredential' title: CreateIntegrationInstanceAuthCredential IntegrationInstanceAuthCredential: description: Object containing metadata for an integration instance auth credential. oneOf: - $ref: '#/components/schemas/MultiKeyAuthCredential' title: IntegrationInstanceAuthCredential CreateMultiKeyAuthCredential: description: Payload used to create an `Multi Key` credential for an integration instance. type: object properties: type: type: string const: multi_key_auth config: type: object additionalProperties: false properties: headers: description: | A list of header key/value pairs used to transmit API credentials to the integration's external API. Header names are defined by the integration within its `Multi Key` authorization strategy definition. type: array items: type: object required: - name - key properties: name: description: Name of the request header type: string key: description: The key used to populate the request header type: string example: - name: x-api-key key: 9f2a3b4c8d6e7f00112233445566778899aabbccddeeff001122334455667788 required: - headers title: CreateMultiKeyAuthCredentialConfig x-speakeasy-param-force-new: true x-speakeasy-param-suppress-computed-diff: true additionalProperties: false required: - type - config writeOnly: true x-speakeasy-name-override: multi_key_auth MultiKeyAuthCredential: description: Represents a credential scoped to an integration instance that supports the `Multi Key` authorization strategy. type: object properties: id: type: string format: uuid example: 4f535923-ec24-456c-b4e5-e67f65c8c208 integration_instance: $ref: '#/components/schemas/IntegrationInstanceRef' missing_permissions: description: List of detected missing permissions required to enable the full functionality of the given integration instance. type: array items: $ref: '#/components/schemas/MissingPermission' tainted: description: Indicates that the credential is no longer valid and must be replaced with a new valid credential. type: boolean example: false expires_at: description: | Timestamp denoting when the when the credential will expire in RFC-3339 format with a "T" character separating date from time within the field value. When expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance. A `null` value indicates no known expiration time. type: string format: date-time example: '2025-04-01T07:20:50Z' nullable: true created_at: $ref: '#/components/schemas/CreatedAt' type: type: string const: multi_key_auth required: - id - integration_instance - missing_permissions - tainted - expires_at - created_at - type title: MultiKeyAuthCredential x-speakeasy-param-suppress-computed-diff: true MissingPermission: type: object properties: scopes: type: array items: type: string nullable: true example: - 'incident:read' message: description: | Describes the degraded experience of the integration instance due to the missing permission. May also include a message on how to resolve the missing permission. type: string required: - scopes - message UpsertIntegrationInstanceAuthConfig: oneOf: - $ref: '#/components/schemas/UpsertOAuthAuthConfig' title: UpsertIntegrationInstanceAuthConfig IntegrationInstanceAuthConfig: oneOf: - $ref: '#/components/schemas/OAuthAuthConfig' title: IntegrationInstanceAuthConfig UpsertOAuthAuthConfig: type: object properties: type: type: string const: oauth client_id: description: The OAuth client identifier. type: string example: d745213a-b7e8-4998-abe3-41f164001970 client_secret: description: The OAuth client secret. type: string example: s3cr3t4p1cl13ntt0k3n1234567890abcdef writeOnly: true authorization_endpoint: description: The URL where users are redirected to authorize access. type: string format: uri example: 'https://identity.service.com/oauth/authorize' token_endpoint: description: The URL used to retrieve access tokens. type: string format: uri example: 'https://identity.service.com/oauth/token' additionalProperties: false required: - type - client_id - client_secret - authorization_endpoint - token_endpoint title: OAuth Config x-speakeasy-name-override: oauth_config OAuthAuthConfig: type: object properties: type: type: string const: oauth client_id: description: The OAuth client identifier. type: string example: d745213a-b7e8-4998-abe3-41f164001970 authorization_endpoint: description: The URL where users are redirected to authorize access. type: string format: uri example: 'https://identity.service.com/oauth/authorize' token_endpoint: description: The URL used to retrieve access tokens. type: string format: uri example: 'https://identity.service.com/oauth/token' required: - type - client_id - authorization_endpoint - token_endpoint x-speakeasy-name-override: OauthAuthConfig CustomFields: description: | Map of customizable, catalog-defined fields providing information about a service. type: object example: owner: John Appleseed dashboard: name: On-Call Dashboard link: 'https://my-dashboard-svc.io/dashboards/1' additionalProperties: oneOf: - $ref: '#/components/schemas/TextCustomField' - $ref: '#/components/schemas/NumericCustomField' - $ref: '#/components/schemas/BooleanCustomField' - $ref: '#/components/schemas/UrlCustomField' x-speakeasy-type-override: any TextCustomField: type: string nullable: true NumericCustomField: type: number nullable: true BooleanCustomField: type: boolean nullable: true UrlCustomField: type: object properties: name: description: The human-readable name of the URL link. type: string example: On-Call Dashboard link: description: The href value of the URL link. type: string format: uri-reference example: 'https://my-dashboard-svc.io/dashboards/1' nullable: true required: - name - link IntegrationRefWithoutInstance: description: Short-hand descriptor of an integration that omits instance metadata. type: object properties: name: type: string example: gateway-manager display_name: type: string example: gateway-manager required: - name - display_name IntegrationInstanceRef: description: Short-hand descriptor of an integration instance. type: object properties: id: description: The integration instance ID. type: string format: uuid example: 772b9caf-ddbc-4f4f-8aa4-8dfbbe420351 name: description: | The machine name of the integration instance that uniquely identifies it within the catalog. type: string example: aws-lambda-prod pattern: '^[0-9a-z.-]+$' display_name: description: The display name of the integration instance. type: string example: AWS (prod) required: - id - name - display_name DataPlaneClientCertificate: x-speakeasy-entity: GatewayDataPlaneClientCertificate 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 ConfigStore: type: object properties: id: description: The Config Store ID. type: string format: uuid example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8 readOnly: true name: description: The name of the Config Store type: string example: My Name created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' CreateConfigStore: description: The request schema to create a Config Store. type: object properties: name: type: string example: Config Store maxLength: 100 minLength: 1 additionalProperties: false title: Create Config Store Request UpdateConfigStore: description: The request schema to update a Config Store. type: object properties: name: type: string example: Config Store maxLength: 100 minLength: 1 additionalProperties: false title: Update Config Store Request ACL: x-speakeasy-entity: GatewayACL type: object properties: consumer: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false x-speakeasy-terraform-ignore: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true group: type: string id: description: A string representing a UUID (universally unique identifier). type: string nullable: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true example: consumer: id: 84a73fb8-50fc-44a7-a4d5-aa17728ee83f group: foo id: b1f34145-0343-41a4-9602-4c69dec2f269 additionalProperties: false required: - group ACLPlugin: x-speakeasy-entity: GatewayPluginACL allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/ACLPluginConfig' ACLPluginConfig: properties: config: type: object properties: allow: description: Arbitrary group names that are allowed to consume the service or route. One of `config.allow` or `config.deny` must be specified. type: array items: type: string always_use_authenticated_groups: description: 'If enabled (`true`), the authenticated groups will always be used even when an authenticated consumer already exists. If the authenticated groups don''t exist, it will fallback to use the groups associated with the consumer. By default the authenticated groups will only be used when there is no consumer or the consumer is anonymous.' type: boolean deny: description: Arbitrary group names that are not allowed to consume the service or route. One of `config.allow` or `config.deny` must be specified. type: array items: type: string hide_groups_header: description: 'If enabled (`true`), prevents the `X-Consumer-Groups` header from being sent in the request to the upstream service.' type: boolean include_consumer_groups: description: 'If enabled (`true`), allows the consumer-groups to be used in the `allow|deny` fields' type: boolean name: type: string const: acl protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false ACLWithoutParents: x-speakeasy-entity: GatewayACL type: object properties: consumer: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false x-speakeasy-terraform-ignore: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true group: type: string id: description: A string representing a UUID (universally unique identifier). type: string nullable: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true example: group: foo id: b1f34145-0343-41a4-9602-4c69dec2f269 additionalProperties: false required: - group AcmePlugin: x-speakeasy-entity: GatewayPluginAcme allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AcmePluginConfig' AcmePluginConfig: properties: config: type: object properties: account_email: description: The account identifier. Can be reused in a different plugin instance. type: string pattern: '[a-zA-Z0-9]*[!-/:-@[-`{-~]*@+[a-zA-Z0-9]*%.?[a-zA-Z0-9]*' account_key: description: The private key associated with the account. type: object properties: key_id: description: The Key ID. type: string key_set: description: The ID of the key set to associate the Key ID with. type: string required: - key_id allow_any_domain: description: 'If set to `true`, the plugin allows all domains and ignores any values in the `domains` list.' type: boolean api_uri: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string cert_type: description: The certificate type to create. The possible values are `rsa` for RSA certificate or `ecc` for EC certificate. type: string enum: - ecc - rsa domains: description: 'An array of strings representing hosts. A valid host is a string containing one or more labels separated by periods, with at most one wildcard label (''*'')' type: array items: match_all: pattern: '^[^*]*%*?[^*]*$' match_any: patterns: - '%.%*$' - ^%*%. - '^[^*]*$' type: string eab_hmac_key: description: External account binding (EAB) base64-encoded URL string of the HMAC key. You usually don't need to set this unless it is explicitly required by the CA. type: string eab_kid: description: External account binding (EAB) key id. You usually don't need to set this unless it is explicitly required by the CA. type: string enable_ipv4_common_name: description: A boolean value that controls whether to include the IPv4 address in the common name field of generated certificates. type: boolean fail_backoff_minutes: description: |- Minutes to wait for each domain that fails to create a certificate. This applies to both a new certificate and a renewal certificate. type: number preferred_chain: description: A string value that specifies the preferred certificate chain to use when generating certificates. type: string renew_threshold_days: description: Days remaining to renew the certificate before it expires. type: number rsa_key_size: description: 'RSA private key size for the certificate. The possible values are 2048, 3072, or 4096.' type: integer enum: - 2048 - 3072 - 4096 storage: description: 'The backend storage type to use. In DB-less mode and Konnect, `kong` storage is unavailable. In hybrid mode and Konnect, `shm` storage is unavailable. `shm` storage does not persist during Kong restarts and does not work for Kong running on different machines, so consider using one of `kong`, `redis`, `consul`, or `vault` in production.' type: string enum: - consul - kong - redis - shm - vault storage_config: type: object properties: consul: type: object properties: host: description: 'A string representing a host name, such as example.com.' type: string https: description: Boolean representation of https. type: boolean kv_path: description: KV prefix path. type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 timeout: description: Timeout in milliseconds. type: number token: description: Consul ACL token. type: string kong: type: object additionalProperties: true redis: type: object properties: database: description: Database to use for the Redis connection when using the `redis` strategy type: integer extra_options: description: Custom ACME Redis options type: object properties: namespace: description: A namespace to prepend to all keys stored in Redis. type: string scan_count: description: The number of keys to return in Redis SCAN calls. type: number host: description: 'A string representing a host name, such as example.com.' type: string password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: auth: minLength: 0 type: string namespace: minLength: 0 type: string scan_count: type: integer ssl_server_name: type: string shm: type: object properties: shm_name: description: Name of shared memory zone used for Kong API gateway storage type: string vault: type: object properties: auth_method: description: 'Auth Method, default to token, can be ''token'' or ''kubernetes''.' type: string enum: - kubernetes - token auth_path: description: Vault's authentication path to use. type: string auth_role: description: The role to try and assign. type: string host: description: 'A string representing a host name, such as example.com.' type: string https: description: Boolean representation of https. type: boolean jwt_path: description: The path to the JWT. type: string kv_path: description: KV prefix path. type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 timeout: description: Timeout in milliseconds. type: number tls_server_name: description: 'SNI used in request, default to host if omitted.' type: string tls_verify: description: Turn on TLS verification. type: boolean token: description: Consul ACL token. type: string tos_accepted: description: 'If you are using Let''s Encrypt, you must set this to `true` to agree the terms of service.' type: boolean required: - account_email name: type: string const: acme protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set required: - config AiAwsGuardrailsPlugin: x-speakeasy-entity: GatewayPluginAiAwsGuardrails allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiAwsGuardrailsPluginConfig' AiAwsGuardrailsPluginConfig: properties: config: type: object properties: aws_access_key_id: description: The AWS access key ID to use for authentication type: string aws_region: description: The AWS region to use for the Bedrock API type: string aws_secret_access_key: description: The AWS secret access key to use for authentication type: string guarding_mode: description: The guardrail mode to use for the request type: string enum: - BOTH - INPUT - OUTPUT guardrails_id: description: The guardrail identifier used in the request to apply the guardrail type: string guardrails_version: description: The guardrail version used in the request to apply the guardrail type: string response_buffer_size: description: The amount of token receiving from upstream to be buffered before sending to the guardrails service. This only applies to the response content guard. type: number stop_on_error: description: Stop processing if an error occurs type: boolean text_source: description: Select where to pick the 'text' for the Content Guard Services request. type: string enum: - concatenate_all_content - concatenate_user_content timeout: description: Connection timeout with the bedrock service type: number required: - aws_region - guardrails_id - guardrails_version 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-aws-guardrails protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config AiAzureContentSafetyPlugin: x-speakeasy-entity: GatewayPluginAiAzureContentSafety allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiAzureContentSafetyPluginConfig' AiAzureContentSafetyPluginConfig: properties: config: type: object properties: azure_api_version: description: 'Sets the ?api-version URL parameter, used for defining the Azure Content Services interchange format.' type: string minLength: 1 azure_client_id: description: 'If `azure_use_managed_identity` is true, set the client ID if required.' type: string azure_client_secret: description: 'If `azure_use_managed_identity` is true, set the client secret if required.' type: string azure_tenant_id: description: 'If `azure_use_managed_identity` is true, set the tenant ID if required.' type: string azure_use_managed_identity: description: 'If checked, uses (if set) `azure_client_id`, `azure_client_secret`, and/or `azure_tenant_id` for Azure authentication, via Managed or User-assigned identity' type: boolean blocklist_names: description: Use these configured blocklists (in Azure Content Services) when inspecting content. type: array items: type: string categories: description: 'Array of categories, and their thresholds, to measure on.' type: array items: properties: name: type: string rejection_level: type: integer required: - name - rejection_level type: object content_safety_key: description: 'If `azure_use_managed_identity` is true, set the API key to call Content Safety.' type: string content_safety_url: description: 'Full URL, inc protocol, of the Azure Content Safety instance.' type: string halt_on_blocklist_hit: description: Tells Azure to reject the request if any blocklist filter is hit. type: boolean output_type: description: 'See https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/content-filter#content-filtering-categories' type: string enum: - EightSeverityLevels - FourSeverityLevels reveal_failure_reason: description: 'Set true to tell the caller why their request was rejected, if so.' type: boolean text_source: description: Select where to pick the 'text' for the Azure Content Services request. type: string enum: - concatenate_all_content - concatenate_user_content required: - content_safety_url name: type: string const: ai-azure-content-safety protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config AiPromptCompressorPlugin: x-speakeasy-entity: GatewayPluginAiPromptCompressor allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiPromptCompressorPluginConfig' AiPromptCompressorPluginConfig: properties: config: type: object properties: compression_ranges: description: What value to be used to compress with. The 'value' is interpreted as rate or target_token depending on compressor_type. type: array items: properties: max_tokens: type: integer min_tokens: type: integer value: type: number required: - max_tokens - min_tokens - value type: object compressor_type: description: What compression type to use to compress with type: string enum: - rate - target_token compressor_url: description: The url of the compressor type: string keepalive_timeout: description: The keepalive timeout for the established http connnection type: number log_text_data: description: Log the text data type: boolean message_type: type: array items: enum: - assistant - system - user type: string stop_on_error: description: Stop processing if an error occurs type: boolean timeout: description: Connection timeout with the compressor type: number required: - compression_ranges 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-prompt-compressor protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config AiPromptDecoratorPlugin: x-speakeasy-entity: GatewayPluginAiPromptDecorator allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiPromptDecoratorPluginConfig' AiPromptDecoratorPluginConfig: properties: config: type: object properties: llm_format: description: LLM input and output format and schema to use type: string enum: - bedrock - cohere - gemini - huggingface - openai max_request_body_size: description: 'max allowed body size allowed to be introspected. 0 means unlimited, but the size of this body will still be limited by Nginx''s client_max_body_size.' type: integer minimum: 0 prompts: type: object properties: append: description: Insert chat messages at the end of the chat message array. This array preserves exact order when adding messages. type: array items: properties: content: maxLength: 100000 minLength: 1 type: string role: type: string enum: - assistant - system - user required: - content type: object maxLength: 15 prepend: description: Insert chat messages at the beginning of the chat message array. This array preserves exact order when adding messages. type: array items: properties: content: maxLength: 100000 minLength: 1 type: string role: type: string enum: - assistant - system - user required: - content type: object maxLength: 15 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-prompt-decorator protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false AiPromptGuardPlugin: x-speakeasy-entity: GatewayPluginAiPromptGuard allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiPromptGuardPluginConfig' AiPromptGuardPluginConfig: properties: config: type: object properties: allow_all_conversation_history: description: 'If true, will ignore all previous chat prompts from the conversation history.' type: boolean allow_patterns: description: 'Array of valid regex patterns, or valid questions from the ''user'' role in chat.' type: array items: maxLength: 500 minLength: 1 type: string maxLength: 10 deny_patterns: description: 'Array of invalid regex patterns, or invalid questions from the ''user'' role in chat.' type: array items: maxLength: 500 minLength: 1 type: string maxLength: 10 genai_category: description: Generative AI category of the request type: string enum: - audio/speech - audio/transcription - image/generation - realtime/generation - text/embeddings - text/generation llm_format: description: LLM input and output format and schema to use type: string enum: - bedrock - cohere - gemini - huggingface - openai match_all_roles: description: 'If true, will match all roles in addition to ''user'' role in conversation history.' type: boolean max_request_body_size: description: 'max allowed body size allowed to be introspected. 0 means unlimited, but the size of this body will still be limited by Nginx''s client_max_body_size.' type: integer minimum: 0 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-prompt-guard protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false AiPromptTemplatePlugin: x-speakeasy-entity: GatewayPluginAiPromptTemplate allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiPromptTemplatePluginConfig' AiPromptTemplatePluginConfig: properties: config: type: object properties: allow_untemplated_requests: description: Set true to allow requests that don't call or match any template. type: boolean log_original_request: description: Set true to add the original request to the Kong log plugin(s) output. type: boolean max_request_body_size: description: 'max allowed body size allowed to be introspected. 0 means unlimited, but the size of this body will still be limited by Nginx''s client_max_body_size.' type: integer minimum: 0 templates: description: Array of templates available to the request context. type: array items: properties: name: description: 'Unique name for the template, can be called with `{template://NAME}`' type: string template: description: 'Template string for this request, supports mustache-style `{{placeholders}}`' type: string required: - name - template type: object required: - templates 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-prompt-template protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config AiProxyAdvancedPlugin: x-speakeasy-entity: GatewayPluginAiProxyAdvanced allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiProxyAdvancedPluginConfig' AiProxyAdvancedPluginConfig: properties: config: type: object properties: balancer: type: object properties: algorithm: description: Which load balancing algorithm to use. type: string enum: - consistent-hashing - lowest-latency - lowest-usage - priority - round-robin - semantic connect_timeout: type: integer maximum: 2147483646 minimum: 1 failover_criteria: description: 'Specifies in which cases an upstream response should be failover to the next target. Each option in the array is equivalent to the function of http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_next_upstream' type: array items: enum: - error - http_403 - http_404 - http_429 - http_500 - http_502 - http_503 - http_504 - invalid_header - non_idempotent - timeout type: string hash_on_header: description: The header to use for consistent-hashing. type: string latency_strategy: description: 'What metrics to use for latency. Available values are: `tpot` (time-per-output-token) and `e2e`.' type: string enum: - e2e - tpot read_timeout: type: integer maximum: 2147483646 minimum: 1 retries: description: The number of retries to execute upon failure to proxy. type: integer maximum: 32767 minimum: 0 slots: description: The number of slots in the load balancer algorithm. type: integer maximum: 65536 minimum: 10 tokens_count_strategy: description: 'What tokens to use for usage calculation. Available values are: `total_tokens` `prompt_tokens`, `completion_tokens` and `cost`.' type: string enum: - completion-tokens - cost - prompt-tokens - total-tokens write_timeout: type: integer maximum: 2147483646 minimum: 1 embeddings: type: object properties: auth: type: object properties: allow_override: description: 'If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.' type: boolean aws_access_key_id: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_ACCESS_KEY_ID environment variable for this plugin instance. type: string aws_secret_access_key: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_SECRET_ACCESS_KEY environment variable for this plugin instance. type: string azure_client_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client ID.' type: string azure_client_secret: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client secret.' type: string azure_tenant_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the tenant ID.' type: string azure_use_managed_identity: description: Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models. type: boolean gcp_service_account_json: description: 'Set this field to the full JSON of the GCP service account to authenticate, if required. If null (and gcp_use_service_account is true), Kong will attempt to read from environment variable `GCP_SERVICE_ACCOUNT`.' type: string gcp_use_service_account: description: Use service account auth for GCP-based providers and models. type: boolean header_name: description: 'If AI model requires authentication via Authorization or API key header, specify its name here.' type: string header_value: description: 'Specify the full auth header value for ''header_name'', for example ''Bearer key'' or just ''key''.' type: string param_location: description: 'Specify whether the ''param_name'' and ''param_value'' options go in a query string, or the POST form/JSON body.' type: string enum: - body - query param_name: description: 'If AI model requires authentication via query parameter, specify its name here.' type: string param_value: description: Specify the full parameter value for 'param_name'. type: string model: type: object properties: name: description: Model name to execute. type: string options: description: Key/value settings for the model type: object properties: azure: type: object properties: api_version: description: '''api-version'' for Azure OpenAI instances.' type: string deployment_id: description: Deployment ID for Azure OpenAI instances. type: string instance: description: Instance name for Azure OpenAI hosted models. type: string bedrock: type: object properties: aws_assume_role_arn: description: If using AWS providers (Bedrock) you can assume a different role after authentication with the current IAM context is successful. type: string aws_region: description: If using AWS providers (Bedrock) you can override the `AWS_REGION` environment variable by setting this option. type: string aws_role_session_name: description: 'If using AWS providers (Bedrock), set the identifier of the assumed role session.' type: string aws_sts_endpoint_url: description: 'If using AWS providers (Bedrock), override the STS endpoint URL when assuming a different role.' type: string embeddings_normalize: description: 'If using AWS providers (Bedrock), set to true to normalize the embeddings.' type: boolean performance_config_latency: description: Force the client's performance configuration 'latency' for all requests. Leave empty to let the consumer select the performance configuration. type: string gemini: type: object properties: api_endpoint: description: 'If running Gemini on Vertex, specify the regional API endpoint (hostname only).' type: string location_id: description: 'If running Gemini on Vertex, specify the location ID.' type: string project_id: description: 'If running Gemini on Vertex, specify the project ID.' type: string huggingface: type: object properties: use_cache: description: Use the cache layer on the inference API type: boolean wait_for_model: description: Wait for the model if it is not ready type: boolean upstream_url: description: upstream url for the embeddings type: string required: - azure provider: description: AI provider format to use for embeddings API type: string enum: - azure - bedrock - gemini - huggingface - mistral - openai required: - name - provider required: - model genai_category: description: Generative AI category of the request type: string enum: - audio/speech - audio/transcription - image/generation - realtime/generation - text/embeddings - text/generation llm_format: description: LLM input and output format and schema to use type: string enum: - bedrock - cohere - gemini - huggingface - openai max_request_body_size: description: 'max allowed body size allowed to be introspected. 0 means unlimited, but the size of this body will still be limited by Nginx''s client_max_body_size.' type: integer minimum: 0 model_name_header: description: Display the model name selected in the X-Kong-LLM-Model response header type: boolean response_streaming: description: 'Whether to ''optionally allow'', ''deny'', or ''always'' (force) the streaming of answers via server sent events.' type: string enum: - allow - always - deny targets: type: array items: properties: auth: type: object properties: allow_override: description: 'If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.' type: boolean aws_access_key_id: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_ACCESS_KEY_ID environment variable for this plugin instance. type: string aws_secret_access_key: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_SECRET_ACCESS_KEY environment variable for this plugin instance. type: string azure_client_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client ID.' type: string azure_client_secret: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client secret.' type: string azure_tenant_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the tenant ID.' type: string azure_use_managed_identity: description: Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models. type: boolean gcp_service_account_json: description: 'Set this field to the full JSON of the GCP service account to authenticate, if required. If null (and gcp_use_service_account is true), Kong will attempt to read from environment variable `GCP_SERVICE_ACCOUNT`.' type: string gcp_use_service_account: description: Use service account auth for GCP-based providers and models. type: boolean header_name: description: 'If AI model requires authentication via Authorization or API key header, specify its name here.' type: string header_value: description: 'Specify the full auth header value for ''header_name'', for example ''Bearer key'' or just ''key''.' type: string param_location: description: 'Specify whether the ''param_name'' and ''param_value'' options go in a query string, or the POST form/JSON body.' type: string enum: - body - query param_name: description: 'If AI model requires authentication via query parameter, specify its name here.' type: string param_value: description: Specify the full parameter value for 'param_name'. type: string description: description: 'The semantic description of the target, required if using semantic load balancing. Specially, setting this to ''CATCHALL'' will indicate such target to be used when no other targets match the semantic threshold.' type: string logging: type: object properties: log_payloads: description: 'If enabled, will log the request and response body into the Kong log plugin(s) output.' type: boolean log_statistics: description: 'If enabled and supported by the driver, will add model usage and token metrics into the Kong log plugin(s) output.' type: boolean model: type: object properties: name: description: Model name to execute. type: string options: description: Key/value settings for the model type: object properties: anthropic_version: description: 'Defines the schema/API version, if using Anthropic provider.' type: string azure_api_version: description: '''api-version'' for Azure OpenAI instances.' type: string azure_deployment_id: description: Deployment ID for Azure OpenAI instances. type: string azure_instance: description: Instance name for Azure OpenAI hosted models. type: string bedrock: type: object properties: aws_assume_role_arn: description: If using AWS providers (Bedrock) you can assume a different role after authentication with the current IAM context is successful. type: string aws_region: description: If using AWS providers (Bedrock) you can override the `AWS_REGION` environment variable by setting this option. type: string aws_role_session_name: description: 'If using AWS providers (Bedrock), set the identifier of the assumed role session.' type: string aws_sts_endpoint_url: description: 'If using AWS providers (Bedrock), override the STS endpoint URL when assuming a different role.' type: string embeddings_normalize: description: 'If using AWS providers (Bedrock), set to true to normalize the embeddings.' type: boolean performance_config_latency: description: Force the client's performance configuration 'latency' for all requests. Leave empty to let the consumer select the performance configuration. type: string cohere: type: object properties: embedding_input_type: description: The purpose of the input text to calculate embedding vectors. type: string enum: - classification - clustering - image - search_document - search_query wait_for_model: description: Wait for the model if it is not ready type: boolean embeddings_dimensions: description: 'If using embeddings models, set the number of dimensions to generate.' type: integer minimum: 0 gemini: type: object properties: api_endpoint: description: 'If running Gemini on Vertex, specify the regional API endpoint (hostname only).' type: string location_id: description: 'If running Gemini on Vertex, specify the location ID.' type: string project_id: description: 'If running Gemini on Vertex, specify the project ID.' type: string huggingface: type: object properties: use_cache: description: Use the cache layer on the inference API type: boolean wait_for_model: description: Wait for the model if it is not ready type: boolean input_cost: description: Defines the cost per 1M tokens in your prompt. type: number minimum: 0 llama2_format: description: 'If using llama2 provider, select the upstream message format.' type: string enum: - ollama - openai - raw max_tokens: description: 'Defines the max_tokens, if using chat or completion models.' type: integer mistral_format: description: 'If using mistral provider, select the upstream message format.' type: string enum: - ollama - openai output_cost: description: Defines the cost per 1M tokens in the output of the AI. type: number minimum: 0 temperature: description: 'Defines the matching temperature, if using chat or completion models.' type: number maximum: 5 minimum: 0 top_k: description: 'Defines the top-k most likely tokens, if supported.' type: integer maximum: 500 minimum: 0 top_p: description: 'Defines the top-p probability mass, if supported.' type: number maximum: 1 minimum: 0 upstream_path: description: 'Manually specify or override the AI operation path, used when e.g. using the ''preserve'' route_type.' type: string upstream_url: description: 'Manually specify or override the full URL to the AI operation endpoints, when calling (self-)hosted models, or for running via a private endpoint.' type: string provider: description: AI provider request format - Kong translates requests to and from the specified backend compatible formats. type: string enum: - anthropic - azure - bedrock - cohere - gemini - huggingface - llama2 - mistral - openai required: - provider route_type: description: 'The model''s operation implementation, for this provider. ' type: string enum: - audio/v1/audio/speech - audio/v1/audio/transcriptions - audio/v1/audio/translations - image/v1/images/edits - image/v1/images/generations - llm/v1/assistants - llm/v1/batches - llm/v1/chat - llm/v1/completions - llm/v1/embeddings - llm/v1/files - llm/v1/responses - preserve - realtime/v1/realtime weight: description: The weight this target gets within the upstream loadbalancer (1-65535). type: integer maximum: 65535 minimum: 1 required: - logging - model - route_type type: object vectordb: type: object properties: dimensions: description: the desired dimensionality for the vectors type: integer distance_metric: description: the distance metric to use for vector searches type: string enum: - cosine - euclidean pgvector: type: object properties: database: description: the database of the pgvector database type: string host: description: the host of the pgvector database type: string password: description: the password of the pgvector database type: string port: description: the port of the pgvector database type: integer ssl: description: whether to use ssl for the pgvector database type: boolean ssl_cert: description: the path of ssl cert to use for the pgvector database type: string ssl_cert_key: description: the path of ssl cert key to use for the pgvector database type: string ssl_required: description: whether ssl is required for the pgvector database type: boolean ssl_verify: description: whether to verify ssl for the pgvector database type: boolean ssl_version: description: the ssl version to use for the pgvector database type: string enum: - any - tlsv1_2 - tlsv1_3 timeout: description: the timeout of the pgvector database type: number user: description: the user of the pgvector database type: string redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer strategy: description: which vector database driver to use type: string enum: - pgvector - redis threshold: description: the default similarity threshold for accepting semantic search results (float) type: number required: - dimensions - distance_metric - pgvector - redis - strategy - threshold required: - targets 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-proxy-advanced 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: enum: - grpc - grpcs - http - https - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config AiProxyPlugin: x-speakeasy-entity: GatewayPluginAiProxy allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiProxyPluginConfig' AiProxyPluginConfig: properties: config: type: object properties: auth: type: object properties: allow_override: description: 'If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.' type: boolean aws_access_key_id: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_ACCESS_KEY_ID environment variable for this plugin instance. type: string aws_secret_access_key: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_SECRET_ACCESS_KEY environment variable for this plugin instance. type: string azure_client_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client ID.' type: string azure_client_secret: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client secret.' type: string azure_tenant_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the tenant ID.' type: string azure_use_managed_identity: description: Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models. type: boolean gcp_service_account_json: description: 'Set this field to the full JSON of the GCP service account to authenticate, if required. If null (and gcp_use_service_account is true), Kong will attempt to read from environment variable `GCP_SERVICE_ACCOUNT`.' type: string gcp_use_service_account: description: Use service account auth for GCP-based providers and models. type: boolean header_name: description: 'If AI model requires authentication via Authorization or API key header, specify its name here.' type: string header_value: description: 'Specify the full auth header value for ''header_name'', for example ''Bearer key'' or just ''key''.' type: string param_location: description: 'Specify whether the ''param_name'' and ''param_value'' options go in a query string, or the POST form/JSON body.' type: string enum: - body - query param_name: description: 'If AI model requires authentication via query parameter, specify its name here.' type: string param_value: description: Specify the full parameter value for 'param_name'. type: string genai_category: description: Generative AI category of the request type: string enum: - audio/speech - audio/transcription - image/generation - text/embeddings - text/generation llm_format: description: LLM input and output format and schema to use type: string enum: - bedrock - cohere - gemini - huggingface - openai logging: type: object properties: log_payloads: description: 'If enabled, will log the request and response body into the Kong log plugin(s) output.' type: boolean log_statistics: description: 'If enabled and supported by the driver, will add model usage and token metrics into the Kong log plugin(s) output.' type: boolean max_request_body_size: description: 'max allowed body size allowed to be introspected. 0 means unlimited, but the size of this body will still be limited by Nginx''s client_max_body_size.' type: integer minimum: 0 model: type: object properties: name: description: Model name to execute. type: string options: description: Key/value settings for the model type: object properties: anthropic_version: description: 'Defines the schema/API version, if using Anthropic provider.' type: string azure_api_version: description: '''api-version'' for Azure OpenAI instances.' type: string azure_deployment_id: description: Deployment ID for Azure OpenAI instances. type: string azure_instance: description: Instance name for Azure OpenAI hosted models. type: string bedrock: type: object properties: aws_assume_role_arn: description: If using AWS providers (Bedrock) you can assume a different role after authentication with the current IAM context is successful. type: string aws_region: description: If using AWS providers (Bedrock) you can override the `AWS_REGION` environment variable by setting this option. type: string aws_role_session_name: description: 'If using AWS providers (Bedrock), set the identifier of the assumed role session.' type: string aws_sts_endpoint_url: description: 'If using AWS providers (Bedrock), override the STS endpoint URL when assuming a different role.' type: string embeddings_normalize: description: 'If using AWS providers (Bedrock), set to true to normalize the embeddings.' type: boolean performance_config_latency: description: Force the client's performance configuration 'latency' for all requests. Leave empty to let the consumer select the performance configuration. type: string cohere: type: object properties: embedding_input_type: description: The purpose of the input text to calculate embedding vectors. type: string enum: - classification - clustering - image - search_document - search_query wait_for_model: description: Wait for the model if it is not ready type: boolean embeddings_dimensions: description: 'If using embeddings models, set the number of dimensions to generate.' type: integer minimum: 0 gemini: type: object properties: api_endpoint: description: 'If running Gemini on Vertex, specify the regional API endpoint (hostname only).' type: string location_id: description: 'If running Gemini on Vertex, specify the location ID.' type: string project_id: description: 'If running Gemini on Vertex, specify the project ID.' type: string huggingface: type: object properties: use_cache: description: Use the cache layer on the inference API type: boolean wait_for_model: description: Wait for the model if it is not ready type: boolean input_cost: description: Defines the cost per 1M tokens in your prompt. type: number minimum: 0 llama2_format: description: 'If using llama2 provider, select the upstream message format.' type: string enum: - ollama - openai - raw max_tokens: description: 'Defines the max_tokens, if using chat or completion models.' type: integer mistral_format: description: 'If using mistral provider, select the upstream message format.' type: string enum: - ollama - openai output_cost: description: Defines the cost per 1M tokens in the output of the AI. type: number minimum: 0 temperature: description: 'Defines the matching temperature, if using chat or completion models.' type: number maximum: 5 minimum: 0 top_k: description: 'Defines the top-k most likely tokens, if supported.' type: integer maximum: 500 minimum: 0 top_p: description: 'Defines the top-p probability mass, if supported.' type: number maximum: 1 minimum: 0 upstream_path: description: 'Manually specify or override the AI operation path, used when e.g. using the ''preserve'' route_type.' type: string upstream_url: description: 'Manually specify or override the full URL to the AI operation endpoints, when calling (self-)hosted models, or for running via a private endpoint.' type: string provider: description: AI provider request format - Kong translates requests to and from the specified backend compatible formats. type: string enum: - anthropic - azure - bedrock - cohere - gemini - huggingface - llama2 - mistral - openai required: - provider model_name_header: description: Display the model name selected in the X-Kong-LLM-Model response header type: boolean response_streaming: description: 'Whether to ''optionally allow'', ''deny'', or ''always'' (force) the streaming of answers via server sent events.' type: string enum: - allow - always - deny route_type: description: 'The model''s operation implementation, for this provider. ' type: string enum: - audio/v1/audio/speech - audio/v1/audio/transcriptions - audio/v1/audio/translations - image/v1/images/edits - image/v1/images/generations - llm/v1/assistants - llm/v1/batches - llm/v1/chat - llm/v1/completions - llm/v1/embeddings - llm/v1/files - llm/v1/responses - preserve - realtime/v1/realtime required: - model - route_type 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-proxy 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: enum: - grpc - grpcs - http - https - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config AiRagInjectorPlugin: x-speakeasy-entity: GatewayPluginAiRagInjector allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiRagInjectorPluginConfig' AiRagInjectorPluginConfig: properties: config: type: object properties: embeddings: type: object properties: auth: type: object properties: allow_override: description: 'If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.' type: boolean aws_access_key_id: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_ACCESS_KEY_ID environment variable for this plugin instance. type: string aws_secret_access_key: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_SECRET_ACCESS_KEY environment variable for this plugin instance. type: string azure_client_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client ID.' type: string azure_client_secret: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client secret.' type: string azure_tenant_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the tenant ID.' type: string azure_use_managed_identity: description: Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models. type: boolean gcp_service_account_json: description: 'Set this field to the full JSON of the GCP service account to authenticate, if required. If null (and gcp_use_service_account is true), Kong will attempt to read from environment variable `GCP_SERVICE_ACCOUNT`.' type: string gcp_use_service_account: description: Use service account auth for GCP-based providers and models. type: boolean header_name: description: 'If AI model requires authentication via Authorization or API key header, specify its name here.' type: string header_value: description: 'Specify the full auth header value for ''header_name'', for example ''Bearer key'' or just ''key''.' type: string param_location: description: 'Specify whether the ''param_name'' and ''param_value'' options go in a query string, or the POST form/JSON body.' type: string enum: - body - query param_name: description: 'If AI model requires authentication via query parameter, specify its name here.' type: string param_value: description: Specify the full parameter value for 'param_name'. type: string model: type: object properties: name: description: Model name to execute. type: string options: description: Key/value settings for the model type: object properties: azure: type: object properties: api_version: description: '''api-version'' for Azure OpenAI instances.' type: string deployment_id: description: Deployment ID for Azure OpenAI instances. type: string instance: description: Instance name for Azure OpenAI hosted models. type: string bedrock: type: object properties: aws_assume_role_arn: description: If using AWS providers (Bedrock) you can assume a different role after authentication with the current IAM context is successful. type: string aws_region: description: If using AWS providers (Bedrock) you can override the `AWS_REGION` environment variable by setting this option. type: string aws_role_session_name: description: 'If using AWS providers (Bedrock), set the identifier of the assumed role session.' type: string aws_sts_endpoint_url: description: 'If using AWS providers (Bedrock), override the STS endpoint URL when assuming a different role.' type: string embeddings_normalize: description: 'If using AWS providers (Bedrock), set to true to normalize the embeddings.' type: boolean performance_config_latency: description: Force the client's performance configuration 'latency' for all requests. Leave empty to let the consumer select the performance configuration. type: string gemini: type: object properties: api_endpoint: description: 'If running Gemini on Vertex, specify the regional API endpoint (hostname only).' type: string location_id: description: 'If running Gemini on Vertex, specify the location ID.' type: string project_id: description: 'If running Gemini on Vertex, specify the project ID.' type: string huggingface: type: object properties: use_cache: description: Use the cache layer on the inference API type: boolean wait_for_model: description: Wait for the model if it is not ready type: boolean upstream_url: description: upstream url for the embeddings type: string required: - azure provider: description: AI provider format to use for embeddings API type: string enum: - azure - bedrock - gemini - huggingface - mistral - openai required: - name - provider required: - model fetch_chunks_count: description: The maximum number of chunks to fetch from vectordb type: number inject_as_role: type: string enum: - assistant - system - user inject_template: type: string stop_on_failure: description: Halt the LLM request process in case of a vectordb or embeddings service failure type: boolean vectordb: type: object properties: dimensions: description: the desired dimensionality for the vectors type: integer distance_metric: description: the distance metric to use for vector searches type: string enum: - cosine - euclidean pgvector: type: object properties: database: description: the database of the pgvector database type: string host: description: the host of the pgvector database type: string password: description: the password of the pgvector database type: string port: description: the port of the pgvector database type: integer ssl: description: whether to use ssl for the pgvector database type: boolean ssl_cert: description: the path of ssl cert to use for the pgvector database type: string ssl_cert_key: description: the path of ssl cert key to use for the pgvector database type: string ssl_required: description: whether ssl is required for the pgvector database type: boolean ssl_verify: description: whether to verify ssl for the pgvector database type: boolean ssl_version: description: the ssl version to use for the pgvector database type: string enum: - any - tlsv1_2 - tlsv1_3 timeout: description: the timeout of the pgvector database type: number user: description: the user of the pgvector database type: string redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer strategy: description: which vector database driver to use type: string enum: - pgvector - redis required: - dimensions - distance_metric - strategy vectordb_namespace: description: The namespace of the vectordb to use for embeddings lookup type: string required: - embeddings - vectordb 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-rag-injector protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config AiRateLimitingAdvancedPlugin: x-speakeasy-entity: GatewayPluginAiRateLimitingAdvanced allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiRateLimitingAdvancedPluginConfig' AiRateLimitingAdvancedPluginConfig: properties: config: type: object properties: dictionary_name: description: 'The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is `config.strategy` is `cluster` or `redis` and `config.sync_rate` isn''t `-1`), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.' type: string disable_penalty: description: 'If set to `true`, this doesn''t count denied requests (status = `429`). If set to `false`, all requests, including denied ones, are counted. This parameter only affects the `sliding` window_type and the request prompt provider.' type: boolean error_code: description: Set a custom error code to return when the rate limit is exceeded. type: number minimum: 0 error_hide_providers: description: Optionally hide informative response that would otherwise provide information about the provider in the error message. type: boolean error_message: description: Set a custom error message to return when the rate limit is exceeded. type: string header_name: description: A string representing an HTTP header name. type: string hide_client_headers: description: Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters. type: boolean identifier: description: 'The type of identifier used to generate the rate limit key. Defines the scope used to increment the rate limiting counters. Can be `ip`, `credential`, `consumer`, `service`, `header`, `path` or `consumer-group`. Note if `identifier` is `consumer-group`, the plugin must be applied on a consumer group entity. Because a consumer may belong to multiple consumer groups, the plugin needs to know explicitly which consumer group to limit the rate.' type: string enum: - consumer - consumer-group - credential - header - ip - path - service llm_format: description: LLM input and output format and schema to use type: string enum: - bedrock - cohere - gemini - huggingface - openai llm_providers: description: 'The provider config. Takes an array of `name`, `limit` and `window size` values.' type: array items: properties: limit: description: One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified. type: array items: type: number name: description: The LLM provider to which the rate limit applies. type: string enum: - anthropic - azure - bedrock - cohere - gemini - huggingface - llama2 - mistral - openai - requestPrompt window_size: description: One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified. type: array items: type: number required: - limit - name - window_size type: object namespace: description: 'The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. `strategy`, `redis`, `sync_rate`, `dictionary_name`, need to be the same.' type: string path: description: 'A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).' type: string redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer request_prompt_count_function: description: 'If defined, it use custom function to count requests for the request prompt provider' type: string retry_after_jitter_max: description: 'The upper bound of a jitter (random delay) in seconds to be added to the `Retry-After` header of denied requests (status = `429`) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is `0`; in this case, the `Retry-After` header is equal to the `RateLimit-Reset` header.' type: number strategy: description: 'The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: `local` and `cluster`.' type: string enum: - cluster - local - redis sync_rate: description: How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms). type: number tokens_count_strategy: description: 'What tokens to use for cost calculation. Available values are: `total_tokens` `prompt_tokens`, `completion_tokens` or `cost`.' type: string enum: - completion_tokens - cost - prompt_tokens - total_tokens window_type: description: 'Sets the time window type to either `sliding` (default) or `fixed`. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window''s counters.' type: string enum: - fixed - sliding required: - llm_providers 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-rate-limiting-advanced protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config AiRequestTransformerPlugin: x-speakeasy-entity: GatewayPluginAiRequestTransformer allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiRequestTransformerPluginConfig' AiRequestTransformerPluginConfig: properties: config: type: object properties: http_proxy_host: description: 'A string representing a host name, such as example.com.' type: string http_proxy_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 http_timeout: description: Timeout in milliseconds for the AI upstream service. type: integer https_proxy_host: description: 'A string representing a host name, such as example.com.' type: string https_proxy_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 https_verify: description: Verify the TLS certificate of the AI upstream service. type: boolean llm: type: object properties: auth: type: object properties: allow_override: description: 'If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.' type: boolean aws_access_key_id: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_ACCESS_KEY_ID environment variable for this plugin instance. type: string aws_secret_access_key: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_SECRET_ACCESS_KEY environment variable for this plugin instance. type: string azure_client_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client ID.' type: string azure_client_secret: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client secret.' type: string azure_tenant_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the tenant ID.' type: string azure_use_managed_identity: description: Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models. type: boolean gcp_service_account_json: description: 'Set this field to the full JSON of the GCP service account to authenticate, if required. If null (and gcp_use_service_account is true), Kong will attempt to read from environment variable `GCP_SERVICE_ACCOUNT`.' type: string gcp_use_service_account: description: Use service account auth for GCP-based providers and models. type: boolean header_name: description: 'If AI model requires authentication via Authorization or API key header, specify its name here.' type: string header_value: description: 'Specify the full auth header value for ''header_name'', for example ''Bearer key'' or just ''key''.' type: string param_location: description: 'Specify whether the ''param_name'' and ''param_value'' options go in a query string, or the POST form/JSON body.' type: string enum: - body - query param_name: description: 'If AI model requires authentication via query parameter, specify its name here.' type: string param_value: description: Specify the full parameter value for 'param_name'. type: string logging: type: object properties: log_payloads: description: 'If enabled, will log the request and response body into the Kong log plugin(s) output.' type: boolean log_statistics: description: 'If enabled and supported by the driver, will add model usage and token metrics into the Kong log plugin(s) output.' type: boolean model: type: object properties: name: description: Model name to execute. type: string options: description: Key/value settings for the model type: object properties: anthropic_version: description: 'Defines the schema/API version, if using Anthropic provider.' type: string azure_api_version: description: '''api-version'' for Azure OpenAI instances.' type: string azure_deployment_id: description: Deployment ID for Azure OpenAI instances. type: string azure_instance: description: Instance name for Azure OpenAI hosted models. type: string bedrock: type: object properties: aws_assume_role_arn: description: If using AWS providers (Bedrock) you can assume a different role after authentication with the current IAM context is successful. type: string aws_region: description: If using AWS providers (Bedrock) you can override the `AWS_REGION` environment variable by setting this option. type: string aws_role_session_name: description: 'If using AWS providers (Bedrock), set the identifier of the assumed role session.' type: string aws_sts_endpoint_url: description: 'If using AWS providers (Bedrock), override the STS endpoint URL when assuming a different role.' type: string embeddings_normalize: description: 'If using AWS providers (Bedrock), set to true to normalize the embeddings.' type: boolean performance_config_latency: description: Force the client's performance configuration 'latency' for all requests. Leave empty to let the consumer select the performance configuration. type: string cohere: type: object properties: embedding_input_type: description: The purpose of the input text to calculate embedding vectors. type: string enum: - classification - clustering - image - search_document - search_query wait_for_model: description: Wait for the model if it is not ready type: boolean embeddings_dimensions: description: 'If using embeddings models, set the number of dimensions to generate.' type: integer minimum: 0 gemini: type: object properties: api_endpoint: description: 'If running Gemini on Vertex, specify the regional API endpoint (hostname only).' type: string location_id: description: 'If running Gemini on Vertex, specify the location ID.' type: string project_id: description: 'If running Gemini on Vertex, specify the project ID.' type: string huggingface: type: object properties: use_cache: description: Use the cache layer on the inference API type: boolean wait_for_model: description: Wait for the model if it is not ready type: boolean input_cost: description: Defines the cost per 1M tokens in your prompt. type: number minimum: 0 llama2_format: description: 'If using llama2 provider, select the upstream message format.' type: string enum: - ollama - openai - raw max_tokens: description: 'Defines the max_tokens, if using chat or completion models.' type: integer mistral_format: description: 'If using mistral provider, select the upstream message format.' type: string enum: - ollama - openai output_cost: description: Defines the cost per 1M tokens in the output of the AI. type: number minimum: 0 temperature: description: 'Defines the matching temperature, if using chat or completion models.' type: number maximum: 5 minimum: 0 top_k: description: 'Defines the top-k most likely tokens, if supported.' type: integer maximum: 500 minimum: 0 top_p: description: 'Defines the top-p probability mass, if supported.' type: number maximum: 1 minimum: 0 upstream_path: description: 'Manually specify or override the AI operation path, used when e.g. using the ''preserve'' route_type.' type: string upstream_url: description: 'Manually specify or override the full URL to the AI operation endpoints, when calling (self-)hosted models, or for running via a private endpoint.' type: string provider: description: AI provider request format - Kong translates requests to and from the specified backend compatible formats. type: string enum: - anthropic - azure - bedrock - cohere - gemini - huggingface - llama2 - mistral - openai required: - provider route_type: description: 'The model''s operation implementation, for this provider. ' type: string enum: - audio/v1/audio/speech - audio/v1/audio/transcriptions - audio/v1/audio/translations - image/v1/images/edits - image/v1/images/generations - llm/v1/assistants - llm/v1/batches - llm/v1/chat - llm/v1/completions - llm/v1/embeddings - llm/v1/files - llm/v1/responses - preserve - realtime/v1/realtime required: - model - route_type max_request_body_size: description: 'max allowed body size allowed to be introspected. 0 means unlimited, but the size of this body will still be limited by Nginx''s client_max_body_size.' type: integer minimum: 0 prompt: description: 'Use this prompt to tune the LLM system/assistant message for the incoming proxy request (from the client), and what you are expecting in return.' type: string transformation_extract_pattern: description: 'Defines the regular expression that must match to indicate a successful AI transformation at the request phase. The first match will be set as the outgoing body. If the AI service''s response doesn''t match this pattern, it is marked as a failure.' type: string required: - llm - prompt consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-request-transformer protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config AiResponseTransformerPlugin: x-speakeasy-entity: GatewayPluginAiResponseTransformer allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiResponseTransformerPluginConfig' AiResponseTransformerPluginConfig: properties: config: type: object properties: http_proxy_host: description: 'A string representing a host name, such as example.com.' type: string http_proxy_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 http_timeout: description: Timeout in milliseconds for the AI upstream service. type: integer https_proxy_host: description: 'A string representing a host name, such as example.com.' type: string https_proxy_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 https_verify: description: Verify the TLS certificate of the AI upstream service. type: boolean llm: type: object properties: auth: type: object properties: allow_override: description: 'If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.' type: boolean aws_access_key_id: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_ACCESS_KEY_ID environment variable for this plugin instance. type: string aws_secret_access_key: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_SECRET_ACCESS_KEY environment variable for this plugin instance. type: string azure_client_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client ID.' type: string azure_client_secret: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client secret.' type: string azure_tenant_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the tenant ID.' type: string azure_use_managed_identity: description: Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models. type: boolean gcp_service_account_json: description: 'Set this field to the full JSON of the GCP service account to authenticate, if required. If null (and gcp_use_service_account is true), Kong will attempt to read from environment variable `GCP_SERVICE_ACCOUNT`.' type: string gcp_use_service_account: description: Use service account auth for GCP-based providers and models. type: boolean header_name: description: 'If AI model requires authentication via Authorization or API key header, specify its name here.' type: string header_value: description: 'Specify the full auth header value for ''header_name'', for example ''Bearer key'' or just ''key''.' type: string param_location: description: 'Specify whether the ''param_name'' and ''param_value'' options go in a query string, or the POST form/JSON body.' type: string enum: - body - query param_name: description: 'If AI model requires authentication via query parameter, specify its name here.' type: string param_value: description: Specify the full parameter value for 'param_name'. type: string logging: type: object properties: log_payloads: description: 'If enabled, will log the request and response body into the Kong log plugin(s) output.' type: boolean log_statistics: description: 'If enabled and supported by the driver, will add model usage and token metrics into the Kong log plugin(s) output.' type: boolean model: type: object properties: name: description: Model name to execute. type: string options: description: Key/value settings for the model type: object properties: anthropic_version: description: 'Defines the schema/API version, if using Anthropic provider.' type: string azure_api_version: description: '''api-version'' for Azure OpenAI instances.' type: string azure_deployment_id: description: Deployment ID for Azure OpenAI instances. type: string azure_instance: description: Instance name for Azure OpenAI hosted models. type: string bedrock: type: object properties: aws_assume_role_arn: description: If using AWS providers (Bedrock) you can assume a different role after authentication with the current IAM context is successful. type: string aws_region: description: If using AWS providers (Bedrock) you can override the `AWS_REGION` environment variable by setting this option. type: string aws_role_session_name: description: 'If using AWS providers (Bedrock), set the identifier of the assumed role session.' type: string aws_sts_endpoint_url: description: 'If using AWS providers (Bedrock), override the STS endpoint URL when assuming a different role.' type: string embeddings_normalize: description: 'If using AWS providers (Bedrock), set to true to normalize the embeddings.' type: boolean performance_config_latency: description: Force the client's performance configuration 'latency' for all requests. Leave empty to let the consumer select the performance configuration. type: string cohere: type: object properties: embedding_input_type: description: The purpose of the input text to calculate embedding vectors. type: string enum: - classification - clustering - image - search_document - search_query wait_for_model: description: Wait for the model if it is not ready type: boolean embeddings_dimensions: description: 'If using embeddings models, set the number of dimensions to generate.' type: integer minimum: 0 gemini: type: object properties: api_endpoint: description: 'If running Gemini on Vertex, specify the regional API endpoint (hostname only).' type: string location_id: description: 'If running Gemini on Vertex, specify the location ID.' type: string project_id: description: 'If running Gemini on Vertex, specify the project ID.' type: string huggingface: type: object properties: use_cache: description: Use the cache layer on the inference API type: boolean wait_for_model: description: Wait for the model if it is not ready type: boolean input_cost: description: Defines the cost per 1M tokens in your prompt. type: number minimum: 0 llama2_format: description: 'If using llama2 provider, select the upstream message format.' type: string enum: - ollama - openai - raw max_tokens: description: 'Defines the max_tokens, if using chat or completion models.' type: integer mistral_format: description: 'If using mistral provider, select the upstream message format.' type: string enum: - ollama - openai output_cost: description: Defines the cost per 1M tokens in the output of the AI. type: number minimum: 0 temperature: description: 'Defines the matching temperature, if using chat or completion models.' type: number maximum: 5 minimum: 0 top_k: description: 'Defines the top-k most likely tokens, if supported.' type: integer maximum: 500 minimum: 0 top_p: description: 'Defines the top-p probability mass, if supported.' type: number maximum: 1 minimum: 0 upstream_path: description: 'Manually specify or override the AI operation path, used when e.g. using the ''preserve'' route_type.' type: string upstream_url: description: 'Manually specify or override the full URL to the AI operation endpoints, when calling (self-)hosted models, or for running via a private endpoint.' type: string provider: description: AI provider request format - Kong translates requests to and from the specified backend compatible formats. type: string enum: - anthropic - azure - bedrock - cohere - gemini - huggingface - llama2 - mistral - openai required: - provider route_type: description: 'The model''s operation implementation, for this provider. ' type: string enum: - audio/v1/audio/speech - audio/v1/audio/transcriptions - audio/v1/audio/translations - image/v1/images/edits - image/v1/images/generations - llm/v1/assistants - llm/v1/batches - llm/v1/chat - llm/v1/completions - llm/v1/embeddings - llm/v1/files - llm/v1/responses - preserve - realtime/v1/realtime required: - model - route_type max_request_body_size: description: 'max allowed body size allowed to be introspected. 0 means unlimited, but the size of this body will still be limited by Nginx''s client_max_body_size.' type: integer minimum: 0 parse_llm_response_json_instructions: description: 'Set true to read specific response format from the LLM, and accordingly set the status code / body / headers that proxy back to the client. You need to engineer your LLM prompt to return the correct format, see plugin docs ''Overview'' page for usage instructions.' type: boolean prompt: description: 'Use this prompt to tune the LLM system/assistant message for the returning proxy response (from the upstream), adn what response format you are expecting.' type: string transformation_extract_pattern: description: 'Defines the regular expression that must match to indicate a successful AI transformation at the response phase. The first match will be set as the returning body. If the AI service''s response doesn''t match this pattern, a failure is returned to the client.' type: string required: - llm - prompt 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-response-transformer protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config AiSanitizerPlugin: x-speakeasy-entity: GatewayPluginAiSanitizer allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiSanitizerPluginConfig' AiSanitizerPluginConfig: properties: config: type: object properties: anonymize: description: List of types to be anonymized type: array items: enum: - all - all_and_credentials - bank - credentials - creditcard - crypto - custom - date - domain - driverlicense - email - general - ip - medical - nationalid - nrp - passport - phone - ssn - url type: string custom_patterns: description: List of custom patterns to be used for anonymization type: array items: properties: name: type: string regex: type: string score: type: number maximum: 1 minimum: 0 required: - name - regex type: object minLength: 1 host: description: The host of the sanitizer type: string keepalive_timeout: description: The keepalive timeout for the established http connnection type: number port: description: The port of the sanitizer type: number recover_redacted: description: Whether to recover redacted data type: boolean redact_type: description: What value to be used to redacted to type: string enum: - placeholder - synthetic scheme: description: The protocol can be http and https type: string stop_on_error: description: Stop processing if an error occurs type: boolean timeout: description: Connection timeout with the sanitizer type: number 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-sanitizer protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false AiSemanticCachePlugin: x-speakeasy-entity: GatewayPluginAiSemanticCache allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiSemanticCachePluginConfig' AiSemanticCachePluginConfig: properties: config: type: object properties: cache_control: description: 'When enabled, respect the Cache-Control behaviors defined in RFC7234.' type: boolean cache_ttl: description: TTL in seconds of cache entities. Must be a value greater than 0. type: integer minimum: 0 embeddings: type: object properties: auth: type: object properties: allow_override: description: 'If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.' type: boolean aws_access_key_id: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_ACCESS_KEY_ID environment variable for this plugin instance. type: string aws_secret_access_key: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_SECRET_ACCESS_KEY environment variable for this plugin instance. type: string azure_client_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client ID.' type: string azure_client_secret: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client secret.' type: string azure_tenant_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the tenant ID.' type: string azure_use_managed_identity: description: Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models. type: boolean gcp_service_account_json: description: 'Set this field to the full JSON of the GCP service account to authenticate, if required. If null (and gcp_use_service_account is true), Kong will attempt to read from environment variable `GCP_SERVICE_ACCOUNT`.' type: string gcp_use_service_account: description: Use service account auth for GCP-based providers and models. type: boolean header_name: description: 'If AI model requires authentication via Authorization or API key header, specify its name here.' type: string header_value: description: 'Specify the full auth header value for ''header_name'', for example ''Bearer key'' or just ''key''.' type: string param_location: description: 'Specify whether the ''param_name'' and ''param_value'' options go in a query string, or the POST form/JSON body.' type: string enum: - body - query param_name: description: 'If AI model requires authentication via query parameter, specify its name here.' type: string param_value: description: Specify the full parameter value for 'param_name'. type: string model: type: object properties: name: description: Model name to execute. type: string options: description: Key/value settings for the model type: object properties: azure: type: object properties: api_version: description: '''api-version'' for Azure OpenAI instances.' type: string deployment_id: description: Deployment ID for Azure OpenAI instances. type: string instance: description: Instance name for Azure OpenAI hosted models. type: string bedrock: type: object properties: aws_assume_role_arn: description: If using AWS providers (Bedrock) you can assume a different role after authentication with the current IAM context is successful. type: string aws_region: description: If using AWS providers (Bedrock) you can override the `AWS_REGION` environment variable by setting this option. type: string aws_role_session_name: description: 'If using AWS providers (Bedrock), set the identifier of the assumed role session.' type: string aws_sts_endpoint_url: description: 'If using AWS providers (Bedrock), override the STS endpoint URL when assuming a different role.' type: string embeddings_normalize: description: 'If using AWS providers (Bedrock), set to true to normalize the embeddings.' type: boolean performance_config_latency: description: Force the client's performance configuration 'latency' for all requests. Leave empty to let the consumer select the performance configuration. type: string gemini: type: object properties: api_endpoint: description: 'If running Gemini on Vertex, specify the regional API endpoint (hostname only).' type: string location_id: description: 'If running Gemini on Vertex, specify the location ID.' type: string project_id: description: 'If running Gemini on Vertex, specify the project ID.' type: string huggingface: type: object properties: use_cache: description: Use the cache layer on the inference API type: boolean wait_for_model: description: Wait for the model if it is not ready type: boolean upstream_url: description: upstream url for the embeddings type: string required: - azure provider: description: AI provider format to use for embeddings API type: string enum: - azure - bedrock - gemini - huggingface - mistral - openai required: - name - provider required: - model exact_caching: description: 'When enabled, a first check for exact query will be done. It will impact DB size' type: boolean ignore_assistant_prompts: description: Ignore and discard any assistant prompts when Vectorizing the request type: boolean ignore_system_prompts: description: Ignore and discard any system prompts when Vectorizing the request type: boolean ignore_tool_prompts: description: Ignore and discard any tool prompts when Vectorizing the request type: boolean llm_format: description: LLM input and output format and schema to use type: string enum: - bedrock - cohere - gemini - huggingface - openai message_countback: description: Number of messages in the chat history to Vectorize/Cache type: number maximum: 1000 minimum: 1 stop_on_failure: description: Halt the LLM request process in case of a caching system failure type: boolean vectordb: type: object properties: dimensions: description: the desired dimensionality for the vectors type: integer distance_metric: description: the distance metric to use for vector searches type: string enum: - cosine - euclidean pgvector: type: object properties: database: description: the database of the pgvector database type: string host: description: the host of the pgvector database type: string password: description: the password of the pgvector database type: string port: description: the port of the pgvector database type: integer ssl: description: whether to use ssl for the pgvector database type: boolean ssl_cert: description: the path of ssl cert to use for the pgvector database type: string ssl_cert_key: description: the path of ssl cert key to use for the pgvector database type: string ssl_required: description: whether ssl is required for the pgvector database type: boolean ssl_verify: description: whether to verify ssl for the pgvector database type: boolean ssl_version: description: the ssl version to use for the pgvector database type: string enum: - any - tlsv1_2 - tlsv1_3 timeout: description: the timeout of the pgvector database type: number user: description: the user of the pgvector database type: string redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer strategy: description: which vector database driver to use type: string enum: - pgvector - redis threshold: description: the default similarity threshold for accepting semantic search results (float) type: number required: - dimensions - distance_metric - strategy - threshold required: - embeddings - vectordb 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-semantic-cache protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config AiSemanticPromptGuardPlugin: x-speakeasy-entity: GatewayPluginAiSemanticPromptGuard allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AiSemanticPromptGuardPluginConfig' AiSemanticPromptGuardPluginConfig: properties: config: type: object properties: embeddings: type: object properties: auth: type: object properties: allow_override: description: 'If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.' type: boolean aws_access_key_id: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_ACCESS_KEY_ID environment variable for this plugin instance. type: string aws_secret_access_key: description: Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_SECRET_ACCESS_KEY environment variable for this plugin instance. type: string azure_client_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client ID.' type: string azure_client_secret: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client secret.' type: string azure_tenant_id: description: 'If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the tenant ID.' type: string azure_use_managed_identity: description: Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models. type: boolean gcp_service_account_json: description: 'Set this field to the full JSON of the GCP service account to authenticate, if required. If null (and gcp_use_service_account is true), Kong will attempt to read from environment variable `GCP_SERVICE_ACCOUNT`.' type: string gcp_use_service_account: description: Use service account auth for GCP-based providers and models. type: boolean header_name: description: 'If AI model requires authentication via Authorization or API key header, specify its name here.' type: string header_value: description: 'Specify the full auth header value for ''header_name'', for example ''Bearer key'' or just ''key''.' type: string param_location: description: 'Specify whether the ''param_name'' and ''param_value'' options go in a query string, or the POST form/JSON body.' type: string enum: - body - query param_name: description: 'If AI model requires authentication via query parameter, specify its name here.' type: string param_value: description: Specify the full parameter value for 'param_name'. type: string model: type: object properties: name: description: Model name to execute. type: string options: description: Key/value settings for the model type: object properties: azure: type: object properties: api_version: description: '''api-version'' for Azure OpenAI instances.' type: string deployment_id: description: Deployment ID for Azure OpenAI instances. type: string instance: description: Instance name for Azure OpenAI hosted models. type: string bedrock: type: object properties: aws_assume_role_arn: description: If using AWS providers (Bedrock) you can assume a different role after authentication with the current IAM context is successful. type: string aws_region: description: If using AWS providers (Bedrock) you can override the `AWS_REGION` environment variable by setting this option. type: string aws_role_session_name: description: 'If using AWS providers (Bedrock), set the identifier of the assumed role session.' type: string aws_sts_endpoint_url: description: 'If using AWS providers (Bedrock), override the STS endpoint URL when assuming a different role.' type: string embeddings_normalize: description: 'If using AWS providers (Bedrock), set to true to normalize the embeddings.' type: boolean performance_config_latency: description: Force the client's performance configuration 'latency' for all requests. Leave empty to let the consumer select the performance configuration. type: string gemini: type: object properties: api_endpoint: description: 'If running Gemini on Vertex, specify the regional API endpoint (hostname only).' type: string location_id: description: 'If running Gemini on Vertex, specify the location ID.' type: string project_id: description: 'If running Gemini on Vertex, specify the project ID.' type: string huggingface: type: object properties: use_cache: description: Use the cache layer on the inference API type: boolean wait_for_model: description: Wait for the model if it is not ready type: boolean upstream_url: description: upstream url for the embeddings type: string required: - azure provider: description: AI provider format to use for embeddings API type: string enum: - azure - bedrock - gemini - huggingface - mistral - openai required: - name - provider required: - model genai_category: description: Generative AI category of the request type: string enum: - audio/speech - audio/transcription - image/generation - realtime/generation - text/embeddings - text/generation llm_format: description: LLM input and output format and schema to use type: string enum: - bedrock - cohere - gemini - huggingface - openai rules: type: object properties: allow_prompts: description: List of prompts to allow. type: array items: maxLength: 500 minLength: 1 type: string maxLength: 100 deny_prompts: description: List of prompts to deny. type: array items: maxLength: 500 minLength: 1 type: string maxLength: 100 match_all_conversation_history: description: 'If false, will ignore all previous chat prompts from the conversation history.' type: boolean match_all_roles: description: 'If true, will match all roles in addition to ''user'' role in conversation history.' type: boolean max_request_body_size: description: 'max allowed body size allowed to be introspected. 0 means unlimited, but the size of this body will still be limited by Nginx''s client_max_body_size.' type: integer minimum: 0 search: type: object properties: threshold: description: Threshold for the similarity score to be considered a match. type: number vectordb: type: object properties: dimensions: description: the desired dimensionality for the vectors type: integer distance_metric: description: the distance metric to use for vector searches type: string enum: - cosine - euclidean pgvector: type: object properties: database: description: the database of the pgvector database type: string host: description: the host of the pgvector database type: string password: description: the password of the pgvector database type: string port: description: the port of the pgvector database type: integer ssl: description: whether to use ssl for the pgvector database type: boolean ssl_cert: description: the path of ssl cert to use for the pgvector database type: string ssl_cert_key: description: the path of ssl cert key to use for the pgvector database type: string ssl_required: description: whether ssl is required for the pgvector database type: boolean ssl_verify: description: whether to verify ssl for the pgvector database type: boolean ssl_version: description: the ssl version to use for the pgvector database type: string enum: - any - tlsv1_2 - tlsv1_3 timeout: description: the timeout of the pgvector database type: number user: description: the user of the pgvector database type: string redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer strategy: description: which vector database driver to use type: string enum: - pgvector - redis threshold: description: the default similarity threshold for accepting semantic search results (float) type: number required: - dimensions - distance_metric - strategy - threshold required: - embeddings - vectordb 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ai-semantic-prompt-guard protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config AwsLambdaPlugin: x-speakeasy-entity: GatewayPluginAwsLambda allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AwsLambdaPluginConfig' AwsLambdaPluginConfig: properties: config: type: object properties: aws_assume_role_arn: description: The target AWS IAM role ARN used to invoke the Lambda function. type: string aws_imds_protocol_version: description: 'Identifier to select the IMDS protocol version to use: `v1` or `v2`.' type: string enum: - v1 - v2 aws_key: description: The AWS key credential to be used when invoking the function. type: string aws_region: description: 'A string representing a host name, such as example.com.' type: string aws_role_session_name: description: The identifier of the assumed role session. type: string aws_secret: description: 'The AWS secret credential to be used when invoking the function. ' type: string aws_sts_endpoint_url: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string awsgateway_compatible: description: An optional value that defines whether the plugin should wrap requests into the Amazon API gateway. type: boolean base64_encode_body: description: An optional value that Base64-encodes the request body. type: boolean disable_https: type: boolean empty_arrays_mode: description: 'An optional value that defines whether Kong should send empty arrays (returned by Lambda function) as `[]` arrays or `{}` objects in JSON responses. The value `legacy` means Kong will send empty arrays as `{}` objects in response' type: string enum: - correct - legacy forward_request_body: description: 'An optional value that defines whether the request body is sent in the request_body field of the JSON-encoded request. If the body arguments can be parsed, they are sent in the separate request_body_args field of the request. ' type: boolean forward_request_headers: description: An optional value that defines whether the original HTTP request headers are sent as a map in the request_headers field of the JSON-encoded request. type: boolean forward_request_method: description: An optional value that defines whether the original HTTP request method verb is sent in the request_method field of the JSON-encoded request. type: boolean forward_request_uri: description: An optional value that defines whether the original HTTP request URI is sent in the request_uri field of the JSON-encoded request. type: boolean function_name: description: The AWS Lambda function to invoke. Both function name and function ARN (including partial) are supported. type: string host: description: 'A string representing a host name, such as example.com.' type: string invocation_type: description: 'The InvocationType to use when invoking the function. Available types are RequestResponse, Event, DryRun.' type: string enum: - DryRun - Event - RequestResponse is_proxy_integration: description: An optional value that defines whether the response format to receive from the Lambda to this format. type: boolean keepalive: description: An optional value in milliseconds that defines how long an idle connection lives before being closed. type: number log_type: description: 'The LogType to use when invoking the function. By default, None and Tail are supported.' type: string enum: - None - Tail port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 proxy_url: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string qualifier: description: The qualifier to use when invoking the function. type: string skip_large_bodies: description: An optional value that defines whether Kong should send large bodies that are buffered to disk type: boolean timeout: description: An optional timeout in milliseconds when invoking the function. type: number unhandled_status: description: 'The response status code to use (instead of the default 200, 202, or 204) in the case of an Unhandled Function Error.' type: integer maximum: 999 minimum: 100 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: aws-lambda protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false AzureFunctionsPlugin: x-speakeasy-entity: GatewayPluginAzureFunctions allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/AzureFunctionsPluginConfig' AzureFunctionsPluginConfig: properties: config: type: object properties: apikey: description: 'The apikey to access the Azure resources. If provided, it is injected as the `x-functions-key` header.' type: string appname: description: The Azure app name. type: string clientid: description: 'The `clientid` to access the Azure resources. If provided, it is injected as the `x-functions-clientid` header.' type: string functionname: description: Name of the Azure function to invoke. type: string hostdomain: description: The domain where the function resides. type: string https: description: Use of HTTPS to connect with the Azure Functions server. type: boolean https_verify: description: Set to `true` to authenticate the Azure Functions server. type: boolean keepalive: description: Time in milliseconds during which an idle connection to the Azure Functions server lives before being closed. type: number routeprefix: description: Route prefix to use. type: string timeout: description: Timeout in milliseconds before closing a connection to the Azure Functions server. type: number required: - appname - functionname 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: azure-functions protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config BasicAuth: x-speakeasy-entity: GatewayBasicAuth type: object properties: consumer: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false x-speakeasy-terraform-ignore: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true password: type: string writeOnly: true x-speakeasy-param-sensitive: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true username: type: string example: consumer: id: 84a73fb8-50fc-44a7-a4d5-aa17728ee83f id: b2f34145-0343-41a4-9602-4c69dec2f269 password: hashedsoopersecretvalue username: darius additionalProperties: false required: - username - password BasicAuthPlugin: x-speakeasy-entity: GatewayPluginBasicAuth allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/BasicAuthPluginConfig' BasicAuthPluginConfig: properties: config: type: object properties: anonymous: description: 'An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure `4xx`. Please note that this value must refer to the Consumer `id` or `username` attribute, and **not** its `custom_id`.' type: string hide_credentials: description: 'An optional boolean value telling the plugin to show or hide the credential from the upstream service. If `true`, the plugin will strip the credential from the request (i.e. the `Authorization` header) before proxying it.' type: boolean realm: description: When authentication fails the plugin sends `WWW-Authenticate` header with `realm` attribute value. type: string name: type: string const: basic-auth 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: enum: - grpc - grpcs - http - https - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false BasicAuthWithoutParents: x-speakeasy-entity: GatewayBasicAuth type: object properties: consumer: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false x-speakeasy-terraform-ignore: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true password: type: string writeOnly: true x-speakeasy-param-sensitive: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true username: type: string example: id: b2f34145-0343-41a4-9602-4c69dec2f269 password: hashedsoopersecretvalue username: darius additionalProperties: false required: - username - password BotDetectionPlugin: x-speakeasy-entity: GatewayPluginBotDetection allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/BotDetectionPluginConfig' BotDetectionPluginConfig: properties: config: type: object properties: allow: description: An array of regular expressions that should be allowed. The regular expressions will be checked against the `User-Agent` header. type: array items: is_regex: true type: string deny: description: An array of regular expressions that should be denied. The regular expressions will be checked against the `User-Agent` header. type: array items: is_regex: true type: string name: type: string const: bot-detection protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false CACertificate: x-speakeasy-entity: GatewayCACertificate 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. type: object properties: cert: description: PEM-encoded public certificate of the CA. type: string cert_digest: description: 'SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.' type: string nullable: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true tags: description: An optional set of strings associated with the Certificate for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true example: cert: |- -----BEGIN CERTIFICATE----- certificate-content -----END CERTIFICATE----- cert_digest: 9b8aaf19a276885f6c8a6bc48a30700fdb3a351d8b05374d153bfb7b178e2a9f created_at: 1706598432 id: b2f34145-0343-41a4-9602-4c69dec2f260 tags: - trusted - api additionalProperties: false required: - cert CanaryPlugin: x-speakeasy-entity: GatewayPluginCanary allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/CanaryPluginConfig' CanaryPluginConfig: properties: config: type: object properties: canary_by_header_name: description: A string representing an HTTP header name. type: string duration: description: The duration of the canary release in seconds. type: number minimum: 0 groups: description: The groups allowed to access the canary release. type: array items: type: string hash: description: |- Hash algorithm to be used for canary release. * `consumer`: The hash will be based on the consumer. * `ip`: The hash will be based on the client IP address. * `none`: No hash will be applied. * `allow`: Allows the specified groups to access the canary release. * `deny`: Denies the specified groups from accessing the canary release. * `header`: The hash will be based on the specified header value. type: string enum: - allow - consumer - deny - header - ip - none hash_header: description: A string representing an HTTP header name. type: string percentage: description: The percentage of traffic to be routed to the canary release. type: number maximum: 100 minimum: 0 start: description: 'Future time in seconds since epoch, when the canary release will start. Ignored when `percentage` is set, or when using `allow` or `deny` in `hash`.' type: number steps: description: The number of steps for the canary release. type: number minimum: 1 upstream_fallback: description: Specifies whether to fallback to the upstream server if the canary release fails. type: boolean upstream_host: description: 'A string representing a host name, such as example.com.' type: string upstream_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 upstream_uri: description: The URI of the upstream server to be used for the canary release. type: string minLength: 1 shorthand_fields: hash: description: Hash algorithm to be used for canary release. `whitelist` is deprecated. Use `allow` instead `blacklist` is deprecated. Use `deny` instead. type: string name: type: string const: canary protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false Certificate: x-speakeasy-entity: GatewayCertificate description: 'A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order: main certificate on the top, followed by any intermediates.' type: object properties: cert: description: 'PEM-encoded public certificate chain 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 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 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 nullable: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true 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 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 nullable: true snis: type: array items: description: 'A string representing a wildcard host name, such as *.example.com.' type: string nullable: true tags: description: An optional set of strings associated with the Certificate for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true example: cert: |- -----BEGIN CERTIFICATE----- certificate-content -----END CERTIFICATE----- id: b2f34145-0343-41a4-9602-4c69dec2f269 key: |- -----BEGIN PRIVATE KEY----- private-key-content -----END PRIVATE KEY----- additionalProperties: false required: - cert - key ConfluentConsumePlugin: x-speakeasy-entity: GatewayPluginConfluentConsume allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/ConfluentConsumePluginConfig' ConfluentConsumePluginConfig: properties: config: type: object properties: auto_offset_reset: description: The offset to start from when there is no initial offset in the consumer group. type: string enum: - earliest - latest bootstrap_servers: description: 'Set of bootstrap brokers in a `{host: host, port: port}` list format.' type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 required: - host - port type: object cluster_api_key: description: Username/Apikey for SASL authentication. type: string cluster_api_secret: description: Password/ApiSecret for SASL authentication. type: string cluster_name: description: 'An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a `cluster_name` (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.' type: string commit_strategy: description: The strategy to use for committing offsets. type: string enum: - auto - 'off' confluent_cloud_api_key: description: 'Apikey for authentication with Confluent Cloud. This allows for management tasks such as creating topics, ACLs, etc.' type: string confluent_cloud_api_secret: description: The corresponding secret for the Confluent Cloud API key. type: string keepalive: description: Keepalive timeout in milliseconds. type: integer keepalive_enabled: type: boolean message_deserializer: description: The deserializer to use for the consumed messages. type: string enum: - json - noop mode: description: The mode of operation for the plugin. type: string enum: - http-get - server-sent-events schema_registry: description: The plugin-global schema registry configuration. type: object properties: confluent: type: object properties: authentication: type: object properties: basic: type: object properties: password: type: string username: type: string required: - password - username mode: description: Authentication mode to use with the schema registry. type: string enum: - basic - none ssl_verify: description: Set to false to disable SSL certificate verification when connecting to the schema registry. type: boolean ttl: description: The TTL in seconds for the schema registry cache. type: number maximum: 3600 minimum: 0 url: description: The URL of the schema registry. type: string required: - authentication timeout: description: Socket timeout in milliseconds. type: integer topics: description: The Kafka topics and their configuration you want to consume from. type: array items: properties: name: type: string schema_registry: description: The plugin-global schema registry configuration. type: object properties: confluent: type: object properties: authentication: type: object properties: basic: type: object properties: password: type: string username: type: string required: - password - username mode: description: Authentication mode to use with the schema registry. type: string enum: - basic - none ssl_verify: description: Set to false to disable SSL certificate verification when connecting to the schema registry. type: boolean ttl: description: The TTL in seconds for the schema registry cache. type: number maximum: 3600 minimum: 0 url: description: The URL of the schema registry. type: string required: - authentication required: - name - schema_registry type: object minLength: 1 required: - cluster_api_key - cluster_api_secret - topics 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: confluent-consume protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config ConfluentPlugin: x-speakeasy-entity: GatewayPluginConfluent allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/ConfluentPluginConfig' ConfluentPluginConfig: properties: config: type: object properties: allowed_topics: description: 'The list of allowed topic names to which messages can be sent. The default topic configured in the `topic` field is always allowed, regardless of its inclusion in `allowed_topics`.' type: array items: type: string bootstrap_servers: description: 'Set of bootstrap brokers in a `{host: host, port: port}` list format.' type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 required: - host - port type: object cluster_api_key: description: Username/Apikey for SASL authentication. type: string cluster_api_secret: description: Password/ApiSecret for SASL authentication. type: string cluster_name: description: 'An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a `cluster_name` (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.' type: string confluent_cloud_api_key: description: 'Apikey for authentication with Confluent Cloud. This allows for management tasks such as creating topics, ACLs, etc.' type: string confluent_cloud_api_secret: description: The corresponding secret for the Confluent Cloud API key. type: string forward_body: description: 'Include the request body in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.' type: boolean forward_headers: description: 'Include the request headers in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.' type: boolean forward_method: description: 'Include the request method in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.' type: boolean forward_uri: description: 'Include the request URI and URI arguments (as in, query arguments) in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.' type: boolean keepalive: description: Keepalive timeout in milliseconds. type: integer keepalive_enabled: type: boolean key_query_arg: description: 'The request query parameter name that contains the Kafka message key. If specified, messages with the same key will be sent to the same Kafka partition, ensuring consistent ordering.' type: string message_by_lua_functions: description: The Lua functions that manipulates the message being sent to the Kafka topic. type: array items: type: string producer_async: description: Flag to enable asynchronous mode. type: boolean producer_async_buffering_limits_messages_in_memory: description: Maximum number of messages that can be buffered in memory in asynchronous mode. type: integer producer_async_flush_timeout: description: Maximum time interval in milliseconds between buffer flushes in asynchronous mode. type: integer producer_request_acks: description: 'The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).' type: integer enum: - -1 - 0 - 1 producer_request_limits_bytes_per_request: description: Maximum size of a Produce request in bytes. type: integer producer_request_limits_messages_per_request: description: Maximum number of messages to include into a single producer request. type: integer producer_request_retries_backoff_timeout: description: Backoff interval between retry attempts in milliseconds. type: integer producer_request_retries_max_attempts: description: Maximum number of retry attempts per single Produce request. type: integer producer_request_timeout: description: Time to wait for a Produce response in milliseconds. type: integer schema_registry: description: The plugin-global schema registry configuration. This can be overwritten by the topic configuration. type: object properties: confluent: type: object properties: authentication: type: object properties: basic: type: object properties: password: type: string username: type: string required: - password - username mode: description: Authentication mode to use with the schema registry. type: string enum: - basic - none key_schema: type: object properties: schema_version: description: The schema version to use for serialization/deserialization. Use 'latest' to always fetch the most recent version. type: string match_any: patterns: - '^[0-9]+$' - ^latest$ subject_name: description: The name of the subject type: string ssl_verify: description: Set to false to disable SSL certificate verification when connecting to the schema registry. type: boolean ttl: description: The TTL in seconds for the schema registry cache. type: number maximum: 3600 minimum: 0 url: description: The URL of the schema registry. type: string value_schema: type: object properties: schema_version: description: The schema version to use for serialization/deserialization. Use 'latest' to always fetch the most recent version. type: string match_any: patterns: - '^[0-9]+$' - ^latest$ subject_name: description: The name of the subject type: string required: - authentication timeout: description: Socket timeout in milliseconds. type: integer topic: description: The default Kafka topic to publish to if the query parameter defined in the `topics_query_arg` does not exist in the request type: string topics_query_arg: description: The request query parameter name that contains the topics to publish to type: string required: - cluster_api_key - cluster_api_secret - topic 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: confluent protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config Consumer: x-speakeasy-entity: GatewayConsumer description: 'The Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong and your existing primary datastore.' type: object properties: created_at: description: Unix epoch when the resource was created. type: integer nullable: true 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. type: string nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true tags: description: An optional set of strings associated with the Consumer for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true username: description: The unique username of the Consumer. You must send either this field or `custom_id` with the request. type: string nullable: true example: custom_id: '4200' id: 8a388226-80e8-4027-a486-25e4f7db5d21 tags: - silver-tier username: bob-the-builder additionalProperties: false ConsumerGroup: x-speakeasy-entity: GatewayConsumerGroup type: object properties: created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true name: description: The name of the consumer group. type: string tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true additionalProperties: false required: - name ConsumerGroupInsideWrapper: type: object properties: consumer_group: $ref: '#/components/schemas/ConsumerGroup' CorrelationIdPlugin: x-speakeasy-entity: GatewayPluginCorrelationId allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/CorrelationIdPluginConfig' CorrelationIdPluginConfig: properties: config: type: object properties: echo_downstream: description: Whether to echo the header back to downstream (the client). type: boolean generator: description: 'The generator to use for the correlation ID. Accepted values are `uuid`, `uuid#counter`, and `tracker`. See [Generators](#generators).' type: string enum: - tracker - uuid - uuid#counter header_name: description: The HTTP header name to use for the correlation ID. type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: correlation-id protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false CorsPlugin: x-speakeasy-entity: GatewayPluginCors allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/CorsPluginConfig' CorsPluginConfig: properties: config: type: object properties: allow_origin_absent: description: A boolean value that skip cors response headers when origin header of request is empty type: boolean credentials: description: Flag to determine whether the `Access-Control-Allow-Credentials` header should be sent with `true` as the value. type: boolean exposed_headers: description: 'Value for the `Access-Control-Expose-Headers` header. If not specified, no custom headers are exposed.' type: array items: type: string headers: description: Value for the `Access-Control-Allow-Headers` header. type: array items: type: string max_age: description: 'Indicates how long the results of the preflight request can be cached, in `seconds`.' type: number methods: description: '''Value for the `Access-Control-Allow-Methods` header. Available options include `GET`, `HEAD`, `PUT`, `PATCH`, `POST`, `DELETE`, `OPTIONS`, `TRACE`, `CONNECT`. By default, all options are allowed.''' type: array items: enum: - CONNECT - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE type: string origins: description: 'List of allowed domains for the `Access-Control-Allow-Origin` header. If you want to allow all origins, add `*` as a single value to this configuration field. The accepted values can either be flat strings or PCRE regexes.' type: array items: type: string preflight_continue: description: A boolean value that instructs the plugin to proxy the `OPTIONS` preflight request to the Upstream service. type: boolean private_network: description: Flag to determine whether the `Access-Control-Allow-Private-Network` header should be sent with `true` as the value. type: boolean name: type: string const: cors protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https minLength: 1 type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false CustomPlugin: x-speakeasy-entity: GatewayCustomPluginStreaming type: object properties: created_at: description: Unix epoch when the resource was created. type: integer nullable: true handler: description: The handler for the given custom plugin. type: string id: description: A string representing a UUID (universally unique identifier). type: string nullable: true name: description: The name to associate with the given custom plugin. type: string schema: description: The schema for the given custom plugin. type: string tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true example: handler: 'return { VERSION = ''1.0,0'', PRIORITY = 500, access = function(self, config) kong.service.request.set_header(config.name, config.value) end }' id: 868346aa-1105-4b77-8346-aa1105fb77c4 name: set-header schema: 'return { name = ''set-header'', fields = { { protocols = require(''kong.db.schema.typedefs'').protocols_http }, { config = { type = ''record'', fields = { { name = { description = ''The name of the header to set.'', type = ''string'', required = true } }, { value = { description = ''The value for the header.'', type = ''string'', required = true } } } } } } }' additionalProperties: false required: - name - schema - handler DatadogPlugin: x-speakeasy-entity: GatewayPluginDatadog allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/DatadogPluginConfig' DatadogPluginConfig: properties: config: type: object properties: consumer_tag: description: String to be attached as tag of the consumer. type: string flush_timeout: description: 'Optional time in seconds. If `queue_size` > 1, this is the max idle time before sending a log with less than `queue_size` records.' type: number host: description: 'A string representing a host name, such as example.com.' type: string metrics: description: List of metrics to be logged. type: array items: properties: consumer_identifier: description: Authenticated user detail type: string enum: - consumer_id - custom_id - username name: description: Datadog metric’s name type: string enum: - kong_latency - latency - request_count - request_size - response_size - upstream_latency sample_rate: description: Sampling rate type: number maximum: 1 minimum: 0 stat_type: description: Determines what sort of event the metric represents type: string enum: - counter - distribution - gauge - histogram - meter - set - timer tags: description: List of tags type: array items: pattern: '^.*[^:]$' type: string required: - name - stat_type type: object port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 prefix: description: String to be attached as a prefix to a metric's name. type: string queue: type: object properties: concurrency_limit: description: The number of of queue delivery timers. -1 indicates unlimited. type: integer enum: - -1 - 1 initial_retry_delay: description: Time in seconds before the initial retry is made for a failing batch. type: number maximum: 1000000 minimum: 0.001 max_batch_size: description: Maximum number of entries that can be processed at a time. type: integer maximum: 1000000 minimum: 1 max_bytes: description: 'Maximum number of bytes that can be waiting on a queue, requires string content.' type: integer max_coalescing_delay: description: Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler. type: number maximum: 3600 minimum: 0 max_entries: description: Maximum number of entries that can be waiting on the queue. type: integer maximum: 1000000 minimum: 1 max_retry_delay: description: 'Maximum time in seconds between retries, caps exponential backoff.' type: number maximum: 1000000 minimum: 0.001 max_retry_time: description: Time in seconds before the queue gives up calling a failed handler for a batch. type: number queue_size: description: Maximum number of log entries to be sent on each message to the upstream server. type: integer retry_count: description: Number of times to retry when sending data to the upstream server. type: integer service_name_tag: description: String to be attached as the name of the service. type: string status_tag: description: String to be attached as the tag of the HTTP status. type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: datadog protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false DatadogTracingPlugin: x-speakeasy-entity: GatewayPluginDatadogTracing allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/DatadogTracingPluginConfig' DatadogTracingPluginConfig: properties: config: type: object properties: batch_flush_delay: type: integer batch_span_count: type: integer connect_timeout: type: integer maximum: 2147483646 minimum: 0 endpoint: type: string environment: type: string read_timeout: type: integer maximum: 2147483646 minimum: 0 send_timeout: type: integer maximum: 2147483646 minimum: 0 service_name: type: string consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: datadog-tracing 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: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false DatakitPlugin: x-speakeasy-entity: GatewayPluginDatakit allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/DatakitPluginConfig' DatakitPluginConfig: properties: config: type: object properties: debug: type: boolean nodes: type: array items: description: datakit nodes properties: name: description: A label that uniquely identifies the node within the plugin configuration so that it can be used for input/output connections. Must be valid `snake_case` or `kebab-case`. type: string match_all: pattern: '^[A-Za-z_][A-Za-z0-9_-]*$' maxLength: 255 minLength: 1 not_one_of: - request - response - service_request - service_response type: type: string enum: - call - exit - jq - property - static required: - name - type subschema_definitions: call: description: Make an external HTTP request properties: input: description: call node input type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false inputs: description: call node inputs type: object properties: body: description: HTTP request body type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false headers: description: HTTP request headers type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false query: description: HTTP request query type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false required: false method: description: 'A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.' type: string maxLength: 32 minLength: 1 pattern: ^%u+$ output: description: call node output type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false outputs: description: call node outputs type: object properties: body: description: HTTP response body type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false headers: description: HTTP response headers type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false status: description: HTTP response status code type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false required: false ssl_server_name: description: A string representing an SNI (server name indication) value for TLS. type: string timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 url: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string required: true type: object exit: description: Terminate the request and send a response to the client properties: input: description: exit node input type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false inputs: description: exit node inputs type: object properties: body: description: HTTP response body type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false headers: description: HTTP response headers type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false required: false status: description: HTTP status code type: integer maximum: 599 minimum: 200 warn_headers_sent: type: boolean required: false type: object jq: description: Process data using `jq` syntax properties: input: description: filter input(s) type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false inputs: description: filter input(s) type: object additionalProperties: true required: false jq: description: 'The jq filter text. Refer to https://jqlang.org/manual/ for full documentation.' type: string maxLength: 10240 minLength: 1 required: true output: description: filter output(s) type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false type: object property: description: Get or set a property properties: content_type: description: 'The expected mime type of the property value. When set to `application/json`, SET operations will JSON-encode input data before writing it, and GET operations will JSON-decode output data after reading it. Otherwise, this setting has no effect.' type: string enum: - application/json - application/octet-stream - text/plain required: false input: description: 'Property input source. When connected, this node operates in SET mode and writes input data to the property. Otherwise, the node operates in GET mode and reads the property.' type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false output: description: Property output. This can be connected regardless of whether the node is operating in GET mode or SET mode. type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false property: description: The property name to get/set type: string maxLength: 255 minLength: 1 required: true type: object static: description: Produce reusable outputs from statically-configured values properties: additionalProperties: {} output: description: The entire `.values` map type: string match_any: patterns: - '^[A-Za-z_][A-Za-z0-9_-]*$' - '^[A-Za-z_][A-Za-z0-9_-]*%..+$' maxLength: 255 minLength: 1 required: false outputs: description: 'Individual items from `.values`, referenced by key' type: object additionalProperties: true required: false type: object subschema_error: 'unknown node type: %q, expected one of: call, exit, jq, property, static' subschema_key: type subschema_override_parent: true type: object maxLength: 64 minLength: 1 required: - nodes 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: datakit protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config DegraphqlPlugin: x-speakeasy-entity: GatewayPluginDegraphql allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/DegraphqlPluginConfig' DegraphqlPluginConfig: properties: config: type: object properties: graphql_server_path: description: 'A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).' type: string name: type: string const: degraphql protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false ExitTransformerPlugin: x-speakeasy-entity: GatewayPluginExitTransformer allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/ExitTransformerPluginConfig' ExitTransformerPluginConfig: properties: config: type: object properties: functions: type: array items: type: string handle_unexpected: description: Determines whether to handle unexpected errors by transforming their responses. type: boolean handle_unknown: description: Determines whether to handle unknown status codes by transforming their responses. type: boolean required: - functions 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: exit-transformer protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config FileLogPlugin: x-speakeasy-entity: GatewayPluginFileLog allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/FileLogPluginConfig' FileLogPluginConfig: properties: config: type: object properties: custom_fields_by_lua: description: Lua code as a key-value map type: object additionalProperties: true path: description: The file path of the output log file. The plugin creates the log file if it doesn't exist yet. type: string reopen: description: Determines whether the log file is closed and reopened on every request. type: boolean required: - path 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: file-log protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config ForwardProxyPlugin: x-speakeasy-entity: GatewayPluginForwardProxy allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/ForwardProxyPluginConfig' ForwardProxyPluginConfig: properties: config: type: object properties: auth_password: description: |- The password to authenticate with, if the forward proxy is protected by basic authentication. type: string auth_username: description: |- The username to authenticate with, if the forward proxy is protected by basic authentication. type: string http_proxy_host: description: 'A string representing a host name, such as example.com.' type: string http_proxy_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 https_proxy_host: description: 'A string representing a host name, such as example.com.' type: string https_proxy_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 https_verify: description: Whether the server certificate will be verified according to the CA certificates specified in lua_ssl_trusted_certificate. type: boolean proxy_scheme: description: The proxy scheme to use when connecting. Only `http` is supported. type: string enum: - http x_headers: description: Determines how to handle headers when forwarding the request. type: string enum: - append - delete - transparent shorthand_fields: proxy_host: type: string proxy_port: type: integer 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: forward-proxy protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false GatewayUnauthorizedError: type: object properties: message: type: string status: type: integer required: - message - status GraphqlProxyCacheAdvancedPlugin: x-speakeasy-entity: GatewayPluginGraphqlProxyCacheAdvanced allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/GraphqlProxyCacheAdvancedPluginConfig' GraphqlProxyCacheAdvancedPluginConfig: properties: config: type: object properties: bypass_on_err: description: 'Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with `Bypass`, with the request going upstream.' type: boolean cache_ttl: description: TTL in seconds of cache entities. Must be a value greater than 0. type: integer minimum: 0 memory: type: object properties: dictionary_name: description: The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. This dictionary currently must be defined manually in the Kong Nginx template. type: string redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer strategy: description: The backing data store in which to hold cached entities. Accepted value is `memory`. type: string enum: - memory - redis vary_headers: description: 'Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.' type: array items: type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: graphql-proxy-cache-advanced protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false GraphqlRateLimitingAdvancedPlugin: x-speakeasy-entity: GatewayPluginGraphqlRateLimitingAdvanced allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/GraphqlRateLimitingAdvancedPluginConfig' GraphqlRateLimitingAdvancedPluginConfig: properties: config: type: object properties: cost_strategy: description: Strategy to use to evaluate query costs. Either `default` or `node_quantifier`. type: string enum: - default - node_quantifier dictionary_name: description: The shared dictionary where counters will be stored until the next sync cycle. type: string hide_client_headers: description: 'Optionally hide informative response headers. Available options: `true` or `false`.' type: boolean identifier: description: 'How to define the rate limit key. Can be `ip`, `credential`, `consumer`.' type: string enum: - consumer - credential - ip limit: description: One or more requests-per-window limits to apply. type: array items: type: number max_cost: description: A defined maximum cost per query. 0 means unlimited. type: number namespace: description: 'The rate limiting namespace to use for this plugin instance. This namespace is used to share rate limiting counters across different instances. If it is not provided, a random UUID is generated. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. `strategy`, `redis`, `sync_rate`, `window_size`, `dictionary_name`, need to be the same.' type: string pass_all_downstream_headers: description: pass all downstream headers to the upstream graphql server in introspection request type: boolean redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer score_factor: description: A scoring factor to multiply (or divide) the cost. The `score_factor` must always be greater than 0. type: number minimum: 0 strategy: description: The rate-limiting strategy to use for retrieving and incrementing the limits. type: string enum: - cluster - redis sync_rate: description: How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 syncs the counters in that many number of seconds. type: number window_size: description: One or more window sizes to apply a limit to (defined in seconds). type: array items: type: number window_type: description: Sets the time window to either `sliding` or `fixed`. type: string enum: - fixed - sliding required: - limit - sync_rate - window_size 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: graphql-rate-limiting-advanced protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config GrpcGatewayPlugin: x-speakeasy-entity: GatewayPluginGrpcGateway allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/GrpcGatewayPluginConfig' GrpcGatewayPluginConfig: properties: config: type: object properties: proto: description: Describes the gRPC types and methods. type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: grpc-gateway protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false GrpcWebPlugin: x-speakeasy-entity: GatewayPluginGrpcWeb allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/GrpcWebPluginConfig' GrpcWebPluginConfig: properties: config: type: object properties: allow_origin_header: description: The value of the `Access-Control-Allow-Origin` header in the response to the gRPC-Web client. type: string pass_stripped_path: description: If set to `true` causes the plugin to pass the stripped request path to the upstream gRPC service. type: boolean proto: description: 'If present, describes the gRPC types and methods. Required to support payload transcoding. When absent, the web client must use application/grpw-web+proto content.' type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: grpc-web protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false HMACAuth: x-speakeasy-entity: GatewayHMACAuth type: object properties: consumer: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false x-speakeasy-terraform-ignore: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true secret: type: string nullable: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true username: type: string example: consumer: id: 84a73fb8-50fc-44a7-a4d5-aa17728ee83f id: 75695322-e8a0-4109-aed4-5416b0308d85 secret: wQazJ304DW5huJklHgUfjfiSyCyTAEDZ username: xerxes additionalProperties: false required: - username HMACAuthWithoutParents: x-speakeasy-entity: GatewayHMACAuth type: object properties: consumer: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false x-speakeasy-terraform-ignore: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true secret: type: string nullable: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true username: type: string example: id: 75695322-e8a0-4109-aed4-5416b0308d85 secret: wQazJ304DW5huJklHgUfjfiSyCyTAEDZ username: xerxes additionalProperties: false required: - username HeaderCertAuthPlugin: x-speakeasy-entity: GatewayPluginHeaderCertAuth allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/HeaderCertAuthPluginConfig' HeaderCertAuthPluginConfig: properties: config: type: object properties: allow_partial_chain: description: 'Allow certificate verification with only an intermediate certificate. When this is enabled, you don''t need to upload the full chain to Kong Certificates.' type: boolean anonymous: description: 'An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure `4xx`. Note that this value must refer to the consumer `id` or `username` attribute, and **not** its `custom_id`.' type: string authenticated_group_by: description: 'Certificate property to use as the authenticated group. Valid values are `CN` (Common Name) or `DN` (Distinguished Name). Once `skip_consumer_lookup` is applied, any client with a valid certificate can access the Service/API. To restrict usage to only some of the authenticated users, also add the ACL plugin (not covered here) and create allowed or denied groups of users.' type: string enum: - CN - DN ca_certificates: description: List of CA Certificates strings to use as Certificate Authorities (CA) when validating a client certificate. At least one is required but you can specify as many as needed. The value of this array is comprised of primary keys (`id`). type: array items: type: string uuid: true cache_ttl: description: Cache expiry time in seconds. type: number cert_cache_ttl: description: The length of time in milliseconds between refreshes of the revocation check status cache. type: number certificate_header_format: description: 'Format of the certificate header. Supported formats: `base64_encoded`, `url_encoded`.' type: string enum: - base64_encoded - url_encoded certificate_header_name: description: 'Name of the header that contains the certificate, received from the WAF or other L7 downstream proxy.' type: string consumer_by: description: 'Whether to match the subject name of the client-supplied certificate against consumer''s `username` and/or `custom_id` attribute. If set to `[]` (the empty array), then auto-matching is disabled.' type: array items: enum: - custom_id - username type: string default_consumer: description: 'The UUID or username of the consumer to use when a trusted client certificate is presented but no consumer matches. Note that this value must refer to the consumer `id` or `username` attribute, and **not** its `custom_id`.' type: string http_proxy_host: description: 'A string representing a host name, such as example.com.' type: string http_proxy_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 http_timeout: description: HTTP timeout threshold in milliseconds when communicating with the OCSP server or downloading CRL. type: number https_proxy_host: description: 'A string representing a host name, such as example.com.' type: string https_proxy_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 revocation_check_mode: description: 'Controls client certificate revocation check behavior. If set to `SKIP`, no revocation check is performed. If set to `IGNORE_CA_ERROR`, the plugin respects the revocation status when either OCSP or CRL URL is set, and doesn''t fail on network issues. If set to `STRICT`, the plugin only treats the certificate as valid when it''s able to verify the revocation status.' type: string enum: - IGNORE_CA_ERROR - SKIP - STRICT secure_source: description: 'Whether to secure the source of the request. If set to `true`, the plugin will only allow requests from trusted IPs (configured by the `trusted_ips` config option).' type: boolean skip_consumer_lookup: description: Skip consumer lookup once certificate is trusted against the configured CA list. type: boolean required: - ca_certificates - certificate_header_format - certificate_header_name name: type: string const: header-cert-auth protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config HmacAuthPlugin: x-speakeasy-entity: GatewayPluginHmacAuth allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/HmacAuthPluginConfig' HmacAuthPluginConfig: properties: config: type: object properties: algorithms: description: 'A list of HMAC digest algorithms that the user wants to support. Allowed values are `hmac-sha1`, `hmac-sha256`, `hmac-sha384`, and `hmac-sha512`' type: array items: enum: - hmac-sha1 - hmac-sha256 - hmac-sha384 - hmac-sha512 type: string anonymous: description: An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. type: string clock_skew: description: Clock skew in seconds to prevent replay attacks. type: number minimum: 0 enforce_headers: description: A list of headers that the client should at least use for HTTP signature creation. type: array items: type: string hide_credentials: description: An optional boolean value telling the plugin to show or hide the credential from the upstream service. type: boolean realm: description: When authentication fails the plugin sends `WWW-Authenticate` header with `realm` attribute value. type: string validate_request_body: description: A boolean value telling the plugin to enable body validation. type: boolean name: type: string const: hmac-auth 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: enum: - grpc - grpcs - http - https - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false HttpLogPlugin: x-speakeasy-entity: GatewayPluginHttpLog allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/HttpLogPluginConfig' HttpLogPluginConfig: properties: config: type: object properties: content_type: description: Indicates the type of data sent. The only available option is `application/json`. type: string enum: - application/json - application/json; charset=utf-8 custom_fields_by_lua: description: Lua code as a key-value map type: object additionalProperties: true flush_timeout: description: 'Optional time in seconds. If `queue_size` > 1, this is the max idle time before sending a log with less than `queue_size` records.' type: number headers: description: 'An optional table of headers included in the HTTP message to the upstream server. Values are indexed by header name, and each header name accepts a single string.' type: object additionalProperties: true http_endpoint: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string keepalive: description: An optional value in milliseconds that defines how long an idle connection will live before being closed. type: number method: description: 'An optional method used to send data to the HTTP server. Supported values are `POST` (default), `PUT`, and `PATCH`.' type: string enum: - PATCH - POST - PUT queue: type: object properties: concurrency_limit: description: The number of of queue delivery timers. -1 indicates unlimited. type: integer enum: - -1 - 1 initial_retry_delay: description: Time in seconds before the initial retry is made for a failing batch. type: number maximum: 1000000 minimum: 0.001 max_batch_size: description: Maximum number of entries that can be processed at a time. type: integer maximum: 1000000 minimum: 1 max_bytes: description: 'Maximum number of bytes that can be waiting on a queue, requires string content.' type: integer max_coalescing_delay: description: Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler. type: number maximum: 3600 minimum: 0 max_entries: description: Maximum number of entries that can be waiting on the queue. type: integer maximum: 1000000 minimum: 1 max_retry_delay: description: 'Maximum time in seconds between retries, caps exponential backoff.' type: number maximum: 1000000 minimum: 0.001 max_retry_time: description: Time in seconds before the queue gives up calling a failed handler for a batch. type: number queue_size: description: Maximum number of log entries to be sent on each message to the upstream server. type: integer retry_count: description: Number of times to retry when sending data to the upstream server. type: integer timeout: description: An optional timeout in milliseconds when sending data to the upstream server. type: number required: - http_endpoint 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: http-log protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config InjectionProtectionPlugin: x-speakeasy-entity: GatewayPluginInjectionProtection allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/InjectionProtectionPluginConfig' InjectionProtectionPluginConfig: properties: config: type: object properties: custom_injections: description: Custom regexes to check for. type: array items: properties: name: description: A unique name for this injection. type: string regex: description: The regex to match against. type: string is_regex: true required: - name - regex type: object enforcement_mode: description: Enforcement mode of the security policy. type: string enum: - block - log_only error_message: description: The response message when validation fails type: string error_status_code: description: The response status code when validation fails. type: integer maximum: 499 minimum: 400 injection_types: description: The type of injections to check for. type: array items: enum: - java_exception - js - sql - ssi - xpath_abbreviated - xpath_extended type: string locations: description: The locations to check for injection. type: array items: enum: - body - headers - path_and_query type: string name: type: string const: injection-protection protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false IpRestrictionPlugin: x-speakeasy-entity: GatewayPluginIpRestriction allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/IpRestrictionPluginConfig' IpRestrictionPluginConfig: properties: config: type: object properties: allow: description: List of IPs or CIDR ranges to allow. One of `config.allow` or `config.deny` must be specified. type: array items: description: 'A string representing an IP address or CIDR block, such as 192.168.1.1 or 192.168.0.0/16.' type: string deny: description: List of IPs or CIDR ranges to deny. One of `config.allow` or `config.deny` must be specified. type: array items: description: 'A string representing an IP address or CIDR block, such as 192.168.1.1 or 192.168.0.0/16.' type: string message: description: The message to send as a response body to rejected requests. type: string status: description: The HTTP status of the requests that will be rejected by the plugin. type: number 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: ip-restriction protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false JWT: x-speakeasy-entity: GatewayJWT type: object properties: algorithm: type: string enum: - HS256 - HS384 - HS512 - RS256 - RS384 - RS512 - PS256 - PS384 - PS512 - ES256 - ES384 - ES512 - ESP256 - ESP384 - ESP512 - ESB256 - ESB320 - ESB384 - ESB512 - ES256K - EdDSA - Ed25519 - Ed448 nullable: true consumer: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false x-speakeasy-terraform-ignore: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true key: type: string nullable: true rsa_public_key: type: string nullable: true secret: type: string nullable: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true example: algorithm: HS256 consumer: id: 84a73fb8-50fc-44a7-a4d5-aa17728ee83f id: 75695322-e8a0-4109-aed4-5416b0308d85 key: YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz secret: C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X additionalProperties: false JWTWithoutParents: x-speakeasy-entity: GatewayJWT type: object properties: algorithm: type: string enum: - HS256 - HS384 - HS512 - RS256 - RS384 - RS512 - PS256 - PS384 - PS512 - ES256 - ES384 - ES512 - ESP256 - ESP384 - ESP512 - ESB256 - ESB320 - ESB384 - ESB512 - ES256K - EdDSA - Ed25519 - Ed448 nullable: true consumer: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false x-speakeasy-terraform-ignore: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true key: type: string nullable: true rsa_public_key: type: string nullable: true secret: type: string nullable: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true example: algorithm: HS256 id: 75695322-e8a0-4109-aed4-5416b0308d85 key: YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz secret: C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X additionalProperties: false JqPlugin: x-speakeasy-entity: GatewayPluginJq allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/JqPluginConfig' JqPluginConfig: properties: config: type: object properties: request_if_media_type: type: array items: type: string request_jq_program: type: string request_jq_program_options: type: object properties: ascii_output: type: boolean compact_output: type: boolean join_output: type: boolean raw_output: type: boolean sort_keys: type: boolean response_if_media_type: type: array items: type: string response_if_status_code: type: array items: maximum: 599 minimum: 100 type: integer response_jq_program: type: string response_jq_program_options: type: object properties: ascii_output: type: boolean compact_output: type: boolean join_output: type: boolean raw_output: type: boolean sort_keys: type: boolean 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: jq protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false JsonThreatProtectionPlugin: x-speakeasy-entity: GatewayPluginJsonThreatProtection allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/JsonThreatProtectionPluginConfig' JsonThreatProtectionPluginConfig: properties: config: type: object properties: allow_duplicate_object_entry_name: description: Allow or disallow duplicate object entry name. type: boolean enforcement_mode: description: Enforcement mode of the security policy. type: string enum: - block - log_only error_message: description: The response message when validation fails type: string error_status_code: description: The response status code when validation fails. type: integer maximum: 499 minimum: 400 max_array_element_count: description: Max number of elements in an array. -1 means unlimited. type: integer maximum: 2147483648 minimum: -1 max_body_size: description: Max size of the request body. -1 means unlimited. type: integer maximum: 2147483648 minimum: -1 max_container_depth: description: Max nested depth of objects and arrays. -1 means unlimited. type: integer maximum: 2147483648 minimum: -1 max_object_entry_count: description: Max number of entries in an object. -1 means unlimited. type: integer maximum: 2147483648 minimum: -1 max_object_entry_name_length: description: Max string length of object name. -1 means unlimited. type: integer maximum: 2147483648 minimum: -1 max_string_value_length: description: Max string value length. -1 means unlimited. type: integer maximum: 2147483648 minimum: -1 name: type: string const: json-threat-protection protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false JweDecryptPlugin: x-speakeasy-entity: GatewayPluginJweDecrypt allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/JweDecryptPluginConfig' JweDecryptPluginConfig: properties: config: type: object properties: forward_header_name: description: The name of the header that is used to set the decrypted value. type: string key_sets: description: Denote the name or names of all Key Sets that should be inspected when trying to find a suitable key to decrypt the JWE token. type: array items: type: string lookup_header_name: description: The name of the header to look for the JWE token. type: string strict: description: 'Defines how the plugin behaves in cases where no token was found in the request. When using `strict` mode, the request requires a token to be present and subsequently raise an error if none could be found.' type: boolean required: - key_sets name: type: string const: jwe-decrypt protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config JwtPlugin: x-speakeasy-entity: GatewayPluginJwt allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/JwtPluginConfig' JwtPluginConfig: properties: config: type: object properties: anonymous: description: An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. type: string claims_to_verify: description: 'A list of registered claims (according to RFC 7519) that Kong can verify as well. Accepted values: one of exp or nbf.' type: array items: enum: - exp - nbf type: string cookie_names: description: A list of cookie names that Kong will inspect to retrieve JWTs. type: array items: type: string header_names: description: A list of HTTP header names that Kong will inspect to retrieve JWTs. type: array items: type: string key_claim_name: description: 'The name of the claim in which the key identifying the secret must be passed. The plugin will attempt to read this claim from the JWT payload and the header, in that order.' type: string maximum_expiration: description: A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future. type: number maximum: 31536000 minimum: 0 realm: description: When authentication fails the plugin sends `WWW-Authenticate` header with `realm` attribute value. type: string run_on_preflight: description: 'A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests will always be allowed.' type: boolean secret_is_base64: description: 'If true, the plugin assumes the credential’s secret to be base64 encoded. You will need to create a base64-encoded secret for your Consumer, and sign your JWT with the original secret.' type: boolean uri_param_names: description: A list of querystring parameters that Kong will inspect to retrieve JWTs. type: array items: type: string name: type: string const: jwt protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false JwtSignerPlugin: x-speakeasy-entity: GatewayPluginJwtSigner allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/JwtSignerPluginConfig' JwtSignerPluginConfig: properties: config: type: object properties: access_token_consumer_by: description: 'When the plugin tries to apply an access token to a Kong consumer mapping, it tries to find a matching Kong consumer from properties defined using this configuration parameter. The parameter can take an array of alues. Valid values are `id`, `username`, and `custom_id`.' type: array items: enum: - custom_id - id - username type: string access_token_consumer_claim: description: 'When you set a value for this parameter, the plugin tries to map an arbitrary claim specified with this configuration parameter (for example, `sub` or `username`) in an access token to Kong consumer entity.' type: array items: type: string access_token_introspection_authorization: description: 'If the introspection endpoint requires client authentication (client being the JWT Signer plugin), you can specify the `Authorization` header''s value with this configuration parameter.' type: string access_token_introspection_body_args: description: 'This parameter allows you to pass URL encoded request body arguments. For example: `resource=` or `a=1&b=&c`.' type: string access_token_introspection_consumer_by: description: 'When the plugin tries to do access token introspection results to Kong consumer mapping, it tries to find a matching Kong consumer from properties defined using this configuration parameter. The parameter can take an array of values.' type: array items: enum: - custom_id - id - username type: string access_token_introspection_consumer_claim: description: 'When you set a value for this parameter, the plugin tries to map an arbitrary claim specified with this configuration parameter (such as `sub` or `username`) in access token introspection results to the Kong consumer entity.' type: array items: type: string access_token_introspection_endpoint: description: 'When you use `opaque` access tokens and you want to turn on access token introspection, you need to specify the OAuth 2.0 introspection endpoint URI with this configuration parameter.' type: string access_token_introspection_hint: description: 'If you need to give `hint` parameter when introspecting an access token, use this parameter to specify the value. By default, the plugin sends `hint=access_token`.' type: string access_token_introspection_jwt_claim: description: 'If your introspection endpoint returns an access token in one of the keys (or claims) within the introspection results (`JSON`). If the key cannot be found, the plugin responds with `401 Unauthorized`. Also if the key is found but cannot be decoded as JWT, it also responds with `401 Unauthorized`.' type: array items: type: string access_token_introspection_leeway: description: Adjusts clock skew between the token issuer introspection results and Kong. The value is added to introspection results (`JSON`) `exp` claim/property before checking token expiry against Kong servers current time in seconds. You can disable access token introspection `expiry` verification altogether with `config.verify_access_token_introspection_expiry`. type: number access_token_introspection_scopes_claim: description: 'Specify the claim/property in access token introspection results (`JSON`) to be verified against values of `config.access_token_introspection_scopes_required`. This supports nested claims. For example, with Keycloak you could use `[ "realm_access", "roles" ]`, hich can be given as `realm_access,roles` (form post). If the claim is not found in access token introspection results, and you have specified `config.access_token_introspection_scopes_required`, the plugin responds with `403 Forbidden`.' type: array items: type: string access_token_introspection_scopes_required: description: Specify the required values (or scopes) that are checked by an introspection claim/property specified by `config.access_token_introspection_scopes_claim`. type: array items: type: string access_token_introspection_timeout: description: 'Timeout in milliseconds for an introspection request. The plugin tries to introspect twice if the first request fails for some reason. If both requests timeout, then the plugin runs two times the `config.access_token_introspection_timeout` on access token introspection.' type: number access_token_issuer: description: The `iss` claim of a signed or re-signed access token is set to this value. Original `iss` claim of the incoming token (possibly introspected) is stored in `original_iss` claim of the newly signed access token. type: string access_token_jwks_uri: description: Specify the URI where the plugin can fetch the public keys (JWKS) to verify the signature of the access token. type: string access_token_jwks_uri_client_certificate: description: The client certificate that will be used to authenticate Kong if `access_token_jwks_uri` is an https uri that requires mTLS Auth. type: string access_token_jwks_uri_client_password: description: The client password that will be used to authenticate Kong if `access_token_jwks_uri` is a uri that requires Basic Auth. Should be configured together with `access_token_jwks_uri_client_username` type: string access_token_jwks_uri_client_username: description: The client username that will be used to authenticate Kong if `access_token_jwks_uri` is a uri that requires Basic Auth. Should be configured together with `access_token_jwks_uri_client_password` type: string access_token_jwks_uri_rotate_period: description: Specify the period (in seconds) to auto-rotate the jwks for `access_token_jwks_uri`. The default value 0 means no auto-rotation. type: number access_token_keyset: description: The name of the keyset containing signing keys. type: string access_token_keyset_client_certificate: description: The client certificate that will be used to authenticate Kong if `access_token_keyset` is an https uri that requires mTLS Auth. type: string access_token_keyset_client_password: description: The client password that will be used to authenticate Kong if `access_token_keyset` is a uri that requires Basic Auth. Should be configured together with `access_token_keyset_client_username` type: string access_token_keyset_client_username: description: The client username that will be used to authenticate Kong if `access_token_keyset` is a uri that requires Basic Auth. Should be configured together with `access_token_keyset_client_password` type: string access_token_keyset_rotate_period: description: Specify the period (in seconds) to auto-rotate the jwks for `access_token_keyset`. The default value 0 means no auto-rotation. type: number access_token_leeway: description: Adjusts clock skew between the token issuer and Kong. The value is added to the token's `exp` claim before checking token expiry against Kong servers' current time in seconds. You can disable access token `expiry` verification altogether with `config.verify_access_token_expiry`. type: number access_token_optional: description: 'If an access token is not provided or no `config.access_token_request_header` is specified, the plugin cannot verify the access token. In that case, the plugin normally responds with `401 Unauthorized` (client didn''t send a token) or `500 Unexpected` (a configuration error). Use this parameter to allow the request to proceed even when there is no token to check. If the token is provided, then this parameter has no effect' type: boolean access_token_request_header: description: This parameter tells the name of the header where to look for the access token. type: string access_token_scopes_claim: description: Specify the claim in an access token to verify against values of `config.access_token_scopes_required`. type: array items: type: string access_token_scopes_required: description: Specify the required values (or scopes) that are checked by a claim specified by `config.access_token_scopes_claim`. type: array items: type: string access_token_signing_algorithm: description: 'When this plugin sets the upstream header as specified with `config.access_token_upstream_header`, re-signs the original access token using the private keys of the JWT Signer plugin. Specify the algorithm that is used to sign the token. The `config.access_token_issuer` specifies which `keyset` is used to sign the new token issued by Kong using the specified signing algorithm.' type: string enum: - ES256 - ES384 - ES512 - EdDSA - HS256 - HS384 - HS512 - PS256 - PS384 - PS512 - RS256 - RS512 access_token_upstream_header: description: 'Removes the `config.access_token_request_header` from the request after reading its value. With `config.access_token_upstream_header`, you can specify the upstream header where the plugin adds the Kong signed token. If you don''t specify a value, such as use `null` or `""` (empty string), the plugin does not even try to sign or re-sign the token.' type: string access_token_upstream_leeway: description: 'If you want to add or subtract (using a negative value) expiry time (in seconds) of the original access token, you can specify a value that is added to the original access token''s `exp` claim.' type: number add_access_token_claims: description: 'Add customized claims if they are not present yet. Value can be a regular or JSON string; if JSON, decoded data is used as the claim''s value.' type: object additionalProperties: true add_channel_token_claims: description: 'Add customized claims if they are not present yet. Value can be a regular or JSON string; if JSON, decoded data is used as the claim''s value.' type: object additionalProperties: true add_claims: description: 'Add customized claims to both tokens if they are not present yet. Value can be a regular or JSON string; if JSON, decoded data is used as the claim''s value.' type: object additionalProperties: true cache_access_token_introspection: description: Whether to cache access token introspection results. type: boolean cache_channel_token_introspection: description: Whether to cache channel token introspection results. type: boolean channel_token_consumer_by: description: 'When the plugin tries to do channel token to Kong consumer mapping, it tries to find a matching Kong consumer from properties defined using this configuration parameter. The parameter can take an array of valid values: `id`, `username`, and `custom_id`.' type: array items: enum: - custom_id - id - username type: string channel_token_consumer_claim: description: 'When you set a value for this parameter, the plugin tries to map an arbitrary claim specified with this configuration parameter. Kong consumers have an `id`, a `username`, and a `custom_id`. If this parameter is enabled but the mapping fails, such as when there''s a non-existent Kong consumer, the plugin responds with `403 Forbidden`.' type: array items: type: string channel_token_introspection_authorization: description: 'When using `opaque` channel tokens, and you want to turn on channel token introspection, you need to specify the OAuth 2.0 introspection endpoint URI with this configuration parameter. Otherwise the plugin will not try introspection, and instead returns `401 Unauthorized` when using opaque channel tokens.' type: string items: type: string channel_token_introspection_body_args: description: 'If you need to pass additional body arguments to introspection endpoint when the plugin introspects the opaque channel token, you can use this config parameter to specify them. You should URL encode the value. For example: `resource=` or `a=1&b=&c`.' type: string items: type: string channel_token_introspection_consumer_by: description: 'When the plugin tries to do channel token introspection results to Kong consumer mapping, it tries to find a matching Kong consumer from properties defined using this configuration parameter. The parameter can take an array of values. Valid values are `id`, `username` and `custom_id`.' type: array items: enum: - custom_id - id - username type: string channel_token_introspection_consumer_claim: description: 'When you set a value for this parameter, the plugin tries to map an arbitrary claim specified with this configuration parameter (such as `sub` or `username`) in channel token introspection results to Kong consumer entity' type: array items: type: string channel_token_introspection_endpoint: description: 'When you use `opaque` access tokens and you want to turn on access token introspection, you need to specify the OAuth 2.0 introspection endpoint URI with this configuration parameter. Otherwise, the plugin does not try introspection and returns `401 Unauthorized` instead.' type: string channel_token_introspection_hint: description: 'If you need to give `hint` parameter when introspecting a channel token, you can use this parameter to specify the value of such parameter. By default, a `hint` isn''t sent with channel token introspection.' type: string items: type: string channel_token_introspection_jwt_claim: description: 'If your introspection endpoint returns a channel token in one of the keys (or claims) in the introspection results (`JSON`), the plugin can use that value instead of the introspection results when doing expiry verification and signing of the new token issued by Kong.' type: array items: type: string channel_token_introspection_leeway: description: You can use this parameter to adjust clock skew between the token issuer introspection results and Kong. The value will be added to introspection results (`JSON`) `exp` claim/property before checking token expiry against Kong servers current time (in seconds). You can disable channel token introspection `expiry` verification altogether with `config.verify_channel_token_introspection_expiry`. type: number channel_token_introspection_scopes_claim: description: Use this parameter to specify the claim/property in channel token introspection results (`JSON`) to be verified against values of `config.channel_token_introspection_scopes_required`. This supports nested claims. type: array items: type: string channel_token_introspection_scopes_required: description: Use this parameter to specify the required values (or scopes) that are checked by an introspection claim/property specified by `config.channel_token_introspection_scopes_claim`. type: array items: type: string channel_token_introspection_timeout: description: 'Timeout in milliseconds for an introspection request. The plugin tries to introspect twice if the first request fails for some reason. If both requests timeout, then the plugin runs two times the `config.access_token_introspection_timeout` on channel token introspection.' type: number channel_token_issuer: description: 'The `iss` claim of the re-signed channel token is set to this value, which is `kong` by default. The original `iss` claim of the incoming token (possibly introspected) is stored in the `original_iss` claim of the newly signed channel token.' type: string channel_token_jwks_uri: description: 'If you want to use `config.verify_channel_token_signature`, you must specify the URI where the plugin can fetch the public keys (JWKS) to verify the signature of the channel token. If you don''t specify a URI and you pass a JWT token to the plugin, then the plugin responds with `401 Unauthorized`.' type: string channel_token_jwks_uri_client_certificate: description: The client certificate that will be used to authenticate Kong if `access_token_jwks_uri` is an https uri that requires mTLS Auth. type: string channel_token_jwks_uri_client_password: description: The client password that will be used to authenticate Kong if `channel_token_jwks_uri` is a uri that requires Basic Auth. Should be configured together with `channel_token_jwks_uri_client_username` type: string channel_token_jwks_uri_client_username: description: The client username that will be used to authenticate Kong if `channel_token_jwks_uri` is a uri that requires Basic Auth. Should be configured together with `channel_token_jwks_uri_client_password` type: string channel_token_jwks_uri_rotate_period: description: Specify the period (in seconds) to auto-rotate the jwks for `channel_token_jwks_uri`. The default value 0 means no auto-rotation. type: number channel_token_keyset: description: The name of the keyset containing signing keys. type: string channel_token_keyset_client_certificate: description: The client certificate that will be used to authenticate Kong if `channel_token_keyset` is an https uri that requires mTLS Auth. type: string channel_token_keyset_client_password: description: The client password that will be used to authenticate Kong if `channel_token_keyset` is a uri that requires Basic Auth. Should be configured together with `channel_token_keyset_client_username` type: string channel_token_keyset_client_username: description: The client username that will be used to authenticate Kong if `channel_token_keyset` is a uri that requires Basic Auth. Should be configured together with `channel_token_keyset_client_password` type: string channel_token_keyset_rotate_period: description: Specify the period (in seconds) to auto-rotate the jwks for `channel_token_keyset`. The default value 0 means no auto-rotation. type: number channel_token_leeway: description: Adjusts clock skew between the token issuer and Kong. The value will be added to token's `exp` claim before checking token expiry against Kong servers current time in seconds. You can disable channel token `expiry` verification altogether with `config.verify_channel_token_expiry`. type: number channel_token_optional: description: 'If a channel token is not provided or no `config.channel_token_request_header` is specified, the plugin cannot verify the channel token. In that case, the plugin normally responds with `401 Unauthorized` (client didn''t send a token) or `500 Unexpected` (a configuration error). Enable this parameter to allow the request to proceed even when there is no channel token to check. If the channel token is provided, then this parameter has no effect' type: boolean channel_token_request_header: description: 'This parameter tells the name of the header where to look for the channel token. If you don''t want to do anything with the channel token, then you can set this to `null` or `""` (empty string).' type: string channel_token_scopes_claim: description: Specify the claim in a channel token to verify against values of `config.channel_token_scopes_required`. This supports nested claims. type: array items: type: string channel_token_scopes_required: description: Specify the required values (or scopes) that are checked by a claim specified by `config.channel_token_scopes_claim`. type: array items: type: string channel_token_signing_algorithm: description: 'When this plugin sets the upstream header as specified with `config.channel_token_upstream_header`, it also re-signs the original channel token using private keys of this plugin. Specify the algorithm that is used to sign the token.' type: string enum: - ES256 - ES384 - ES512 - EdDSA - HS256 - HS384 - HS512 - PS256 - PS384 - PS512 - RS256 - RS512 channel_token_upstream_header: description: This plugin removes the `config.channel_token_request_header` from the request after reading its value. type: string channel_token_upstream_leeway: description: 'If you want to add or perhaps subtract (using negative value) expiry time of the original channel token, you can specify a value that is added to the original channel token''s `exp` claim.' type: number enable_access_token_introspection: description: 'If you don''t want to support opaque access tokens, change this configuration parameter to `false` to disable introspection.' type: boolean enable_channel_token_introspection: description: 'If you don''t want to support opaque channel tokens, disable introspection by changing this configuration parameter to `false`.' type: boolean enable_hs_signatures: description: 'Tokens signed with HMAC algorithms such as `HS256`, `HS384`, or `HS512` are not accepted by default. If you need to accept such tokens for verification, enable this setting.' type: boolean enable_instrumentation: description: Writes log entries with some added information using `ngx.CRIT` (CRITICAL) level. type: boolean original_access_token_upstream_header: description: The HTTP header name used to store the original access token. type: string original_channel_token_upstream_header: description: The HTTP header name used to store the original channel token. type: string realm: description: 'When authentication or authorization fails, or there is an unexpected error, the plugin sends an `WWW-Authenticate` header with the `realm` attribute value.' type: string remove_access_token_claims: description: 'remove claims. It should be an array, and each element is a claim key string.' type: array items: type: string remove_channel_token_claims: description: 'remove claims. It should be an array, and each element is a claim key string.' type: array items: type: string set_access_token_claims: description: 'Set customized claims. If a claim is already present, it will be overwritten. Value can be a regular or JSON string; if JSON, decoded data is used as the claim''s value.' type: object additionalProperties: true set_channel_token_claims: description: 'Set customized claims. If a claim is already present, it will be overwritten. Value can be a regular or JSON string; if JSON, decoded data is used as the claim''s value.' type: object additionalProperties: true set_claims: description: 'Set customized claims to both tokens. If a claim is already present, it will be overwritten. Value can be a regular or JSON string; if JSON, decoded data is used as the claim''s value.' type: object additionalProperties: true trust_access_token_introspection: description: 'Use this parameter to enable and disable further checks on a payload before the new token is signed. If you set this to `true`, the expiry or scopes are not checked on a payload.' type: boolean trust_channel_token_introspection: description: 'Providing an opaque channel token for plugin introspection, and verifying expiry and scopes on introspection results may make further payload checks unnecessary before the plugin signs a new token. This also applies when using a JWT token with introspection JSON as per config.channel_token_introspection_jwt_claim. Use this parameter to manage additional payload checks before signing a new token. With true (default), payload''s expiry or scopes aren''t checked.' type: boolean verify_access_token_expiry: description: Quickly turn access token expiry verification off and on as needed. type: boolean verify_access_token_introspection_expiry: description: Quickly turn access token introspection expiry verification off and on as needed. type: boolean verify_access_token_introspection_scopes: description: 'Quickly turn off and on the access token introspection scopes verification, specified with `config.access_token_introspection_scopes_required`.' type: boolean verify_access_token_scopes: description: 'Quickly turn off and on the access token required scopes verification, specified with `config.access_token_scopes_required`.' type: boolean verify_access_token_signature: description: Quickly turn access token signature verification off and on as needed. type: boolean verify_channel_token_expiry: type: boolean verify_channel_token_introspection_expiry: description: Quickly turn on/off the channel token introspection expiry verification. type: boolean verify_channel_token_introspection_scopes: description: Quickly turn on/off the channel token introspection scopes verification specified with `config.channel_token_introspection_scopes_required`. type: boolean verify_channel_token_scopes: description: Quickly turn on/off the channel token required scopes verification specified with `config.channel_token_scopes_required`. type: boolean verify_channel_token_signature: description: Quickly turn on/off the channel token signature verification. type: boolean name: type: string const: jwt-signer protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false KafkaConsumePlugin: x-speakeasy-entity: GatewayPluginKafkaConsume allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/KafkaConsumePluginConfig' KafkaConsumePluginConfig: properties: config: type: object properties: authentication: type: object properties: mechanism: description: 'The SASL authentication mechanism. Supported options: `PLAIN` or `SCRAM-SHA-256`.' type: string enum: - PLAIN - SCRAM-SHA-256 - SCRAM-SHA-512 password: description: Password for SASL authentication. type: string strategy: description: 'The authentication strategy for the plugin, the only option for the value is `sasl`.' type: string enum: - sasl tokenauth: description: Enable this to indicate `DelegationToken` authentication type: boolean user: description: Username for SASL authentication. type: string auto_offset_reset: description: The offset to start from when there is no initial offset in the consumer group. type: string enum: - earliest - latest bootstrap_servers: description: 'Set of bootstrap brokers in a `{host: host, port: port}` list format.' type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 required: - host - port type: object cluster_name: description: An identifier for the Kafka cluster. type: string commit_strategy: description: The strategy to use for committing offsets. type: string enum: - auto - 'off' message_deserializer: description: The deserializer to use for the consumed messages. type: string enum: - json - noop mode: description: The mode of operation for the plugin. type: string enum: - http-get - server-sent-events - websocket schema_registry: description: The plugin-global schema registry configuration. type: object properties: confluent: type: object properties: authentication: type: object properties: basic: type: object properties: password: type: string username: type: string required: - password - username mode: description: Authentication mode to use with the schema registry. type: string enum: - basic - none ssl_verify: description: Set to false to disable SSL certificate verification when connecting to the schema registry. type: boolean ttl: description: The TTL in seconds for the schema registry cache. type: number maximum: 3600 minimum: 0 url: description: The URL of the schema registry. type: string required: - authentication security: type: object properties: certificate_id: description: UUID of certificate entity for mTLS authentication. type: string uuid: true ssl: description: Enables TLS. type: boolean topics: description: The Kafka topics and their configuration you want to consume from. type: array items: properties: name: type: string schema_registry: description: The plugin-global schema registry configuration. type: object properties: confluent: type: object properties: authentication: type: object properties: basic: type: object properties: password: type: string username: type: string required: - password - username mode: description: Authentication mode to use with the schema registry. type: string enum: - basic - none ssl_verify: description: Set to false to disable SSL certificate verification when connecting to the schema registry. type: boolean ttl: description: The TTL in seconds for the schema registry cache. type: number maximum: 3600 minimum: 0 url: description: The URL of the schema registry. type: string required: - authentication required: - name - schema_registry type: object minLength: 1 required: - bootstrap_servers - topics 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: kafka-consume 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: enum: - grpc - grpcs - http - https - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config KafkaLogPlugin: x-speakeasy-entity: GatewayPluginKafkaLog allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/KafkaLogPluginConfig' KafkaLogPluginConfig: properties: config: type: object properties: authentication: type: object properties: mechanism: description: 'The SASL authentication mechanism. Supported options: `PLAIN`, `SCRAM-SHA-256` or `SCRAM-SHA-512`.' type: string enum: - PLAIN - SCRAM-SHA-256 - SCRAM-SHA-512 password: description: Password for SASL authentication. type: string strategy: description: 'The authentication strategy for the plugin, the only option for the value is `sasl`.' type: string enum: - sasl tokenauth: description: Enable this to indicate `DelegationToken` authentication type: boolean user: description: Username for SASL authentication. type: string bootstrap_servers: description: 'Set of bootstrap brokers in a `{host: host, port: port}` list format.' type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 required: - host - port type: object cluster_name: description: 'An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a `cluster_name` (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.' type: string custom_fields_by_lua: description: Lua code as a key-value map type: object additionalProperties: true keepalive: type: integer keepalive_enabled: type: boolean key_query_arg: description: 'The request query parameter name that contains the Kafka message key. If specified, messages with the same key will be sent to the same Kafka partition, ensuring consistent ordering.' type: string producer_async: description: Flag to enable asynchronous mode. type: boolean producer_async_buffering_limits_messages_in_memory: description: Maximum number of messages that can be buffered in memory in asynchronous mode. type: integer producer_async_flush_timeout: description: Maximum time interval in milliseconds between buffer flushes in asynchronous mode. type: integer producer_request_acks: description: 'The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).' type: integer enum: - -1 - 0 - 1 producer_request_limits_bytes_per_request: description: Maximum size of a Produce request in bytes. type: integer producer_request_limits_messages_per_request: description: Maximum number of messages to include into a single Produce request. type: integer producer_request_retries_backoff_timeout: description: Backoff interval between retry attempts in milliseconds. type: integer producer_request_retries_max_attempts: description: Maximum number of retry attempts per single Produce request. type: integer producer_request_timeout: description: Time to wait for a Produce response in milliseconds type: integer schema_registry: description: The plugin-global schema registry configuration. This can be overwritten by the topic configuration. type: object properties: confluent: type: object properties: authentication: type: object properties: basic: type: object properties: password: type: string username: type: string required: - password - username mode: description: Authentication mode to use with the schema registry. type: string enum: - basic - none key_schema: type: object properties: schema_version: description: The schema version to use for serialization/deserialization. Use 'latest' to always fetch the most recent version. type: string match_any: patterns: - '^[0-9]+$' - ^latest$ subject_name: description: The name of the subject type: string ssl_verify: description: Set to false to disable SSL certificate verification when connecting to the schema registry. type: boolean ttl: description: The TTL in seconds for the schema registry cache. type: number maximum: 3600 minimum: 0 url: description: The URL of the schema registry. type: string value_schema: type: object properties: schema_version: description: The schema version to use for serialization/deserialization. Use 'latest' to always fetch the most recent version. type: string match_any: patterns: - '^[0-9]+$' - ^latest$ subject_name: description: The name of the subject type: string required: - authentication security: type: object properties: certificate_id: description: UUID of certificate entity for mTLS authentication. type: string uuid: true ssl: description: Enables TLS. type: boolean timeout: description: Socket timeout in milliseconds. type: integer topic: description: The Kafka topic to publish to. type: string required: - topic 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: kafka-log 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: enum: - grpc - grpcs - http - https - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config KafkaUpstreamPlugin: x-speakeasy-entity: GatewayPluginKafkaUpstream allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/KafkaUpstreamPluginConfig' KafkaUpstreamPluginConfig: properties: config: type: object properties: allowed_topics: description: 'The list of allowed topic names to which messages can be sent. The default topic configured in the `topic` field is always allowed, regardless of its inclusion in `allowed_topics`.' type: array items: type: string authentication: type: object properties: mechanism: description: 'The SASL authentication mechanism. Supported options: `PLAIN`, `SCRAM-SHA-256`, or `SCRAM-SHA-512`.' type: string enum: - PLAIN - SCRAM-SHA-256 - SCRAM-SHA-512 password: description: Password for SASL authentication. type: string strategy: description: 'The authentication strategy for the plugin, the only option for the value is `sasl`.' type: string enum: - sasl tokenauth: description: Enable this to indicate `DelegationToken` authentication. type: boolean user: description: Username for SASL authentication. type: string bootstrap_servers: description: 'Set of bootstrap brokers in a `{host: host, port: port}` list format.' type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 required: - host - port type: object cluster_name: description: 'An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a `cluster_name` (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.' type: string forward_body: description: 'Include the request body in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.' type: boolean forward_headers: description: 'Include the request headers in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.' type: boolean forward_method: description: 'Include the request method in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.' type: boolean forward_uri: description: 'Include the request URI and URI arguments (as in, query arguments) in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.' type: boolean keepalive: description: Keepalive timeout in milliseconds. type: integer keepalive_enabled: type: boolean key_query_arg: description: 'The request query parameter name that contains the Kafka message key. If specified, messages with the same key will be sent to the same Kafka partition, ensuring consistent ordering.' type: string message_by_lua_functions: description: The Lua functions that manipulates the message being sent to the Kafka topic. type: array items: type: string producer_async: description: Flag to enable asynchronous mode. type: boolean producer_async_buffering_limits_messages_in_memory: description: Maximum number of messages that can be buffered in memory in asynchronous mode. type: integer producer_async_flush_timeout: description: Maximum time interval in milliseconds between buffer flushes in asynchronous mode. type: integer producer_request_acks: description: 'The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).' type: integer enum: - -1 - 0 - 1 producer_request_limits_bytes_per_request: description: Maximum size of a Produce request in bytes. type: integer producer_request_limits_messages_per_request: description: Maximum number of messages to include into a single producer request. type: integer producer_request_retries_backoff_timeout: description: Backoff interval between retry attempts in milliseconds. type: integer producer_request_retries_max_attempts: description: Maximum number of retry attempts per single Produce request. type: integer producer_request_timeout: description: Time to wait for a Produce response in milliseconds. type: integer schema_registry: description: The plugin-global schema registry configuration. This can be overwritten by the topic configuration. type: object properties: confluent: type: object properties: authentication: type: object properties: basic: type: object properties: password: type: string username: type: string required: - password - username mode: description: Authentication mode to use with the schema registry. type: string enum: - basic - none key_schema: type: object properties: schema_version: description: The schema version to use for serialization/deserialization. Use 'latest' to always fetch the most recent version. type: string match_any: patterns: - '^[0-9]+$' - ^latest$ subject_name: description: The name of the subject type: string ssl_verify: description: Set to false to disable SSL certificate verification when connecting to the schema registry. type: boolean ttl: description: The TTL in seconds for the schema registry cache. type: number maximum: 3600 minimum: 0 url: description: The URL of the schema registry. type: string value_schema: type: object properties: schema_version: description: The schema version to use for serialization/deserialization. Use 'latest' to always fetch the most recent version. type: string match_any: patterns: - '^[0-9]+$' - ^latest$ subject_name: description: The name of the subject type: string required: - authentication security: type: object properties: certificate_id: description: UUID of certificate entity for mTLS authentication. type: string uuid: true ssl: description: Enables TLS. type: boolean timeout: description: Socket timeout in milliseconds. type: integer topic: description: The default Kafka topic to publish to if the query parameter defined in the `topics_query_arg` does not exist in the request type: string topics_query_arg: description: The request query parameter name that contains the topics to publish to type: string required: - topic 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: kafka-upstream protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config Key: x-speakeasy-entity: GatewayKey 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 nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true jwk: description: A JSON Web Key represented as a string. type: string nullable: true kid: description: A unique identifier for a key. type: string name: description: The name to associate with the given keys. type: string nullable: true pem: description: A keypair in PEM format. type: object nullable: true properties: private_key: type: string public_key: type: string set: description: The id (an UUID) of the key-set with which to associate the key. type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false tags: description: An optional set of strings associated with the Key for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true x5t: description: X.509 certificate SHA-1 thumbprint. type: string nullable: true 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 additionalProperties: false required: - kid KeyAuth: x-speakeasy-entity: GatewayKeyAuth type: object properties: consumer: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false x-speakeasy-terraform-ignore: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true key: type: string nullable: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true ttl: description: key-auth ttl in seconds type: integer nullable: true example: consumer: id: 84a73fb8-50fc-44a7-a4d5-aa17728ee83f id: b2f34145-0343-41a4-9602-4c69dec2f269 key: IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo additionalProperties: false KeyAuthEncPlugin: x-speakeasy-entity: GatewayPluginKeyAuthEnc allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/KeyAuthEncPluginConfig' KeyAuthEncPluginConfig: properties: config: type: object properties: anonymous: description: 'An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure `4xx`. Note that this value must refer to the consumer `id` or `username` attribute, and **not** its `custom_id`.' type: string hide_credentials: description: 'An optional boolean value telling the plugin to show or hide the credential from the upstream service. If `true`, the plugin strips the credential from the request (i.e., the header, query string, or request body containing the key) before proxying it.' type: boolean key_in_body: description: 'If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. Supported MIME types: `application/www-form-urlencoded`, `application/json`, and `multipart/form-data`.' type: boolean key_in_header: description: 'If enabled (default), the plugin reads the request header and tries to find the key in it.' type: boolean key_in_query: description: 'If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.' type: boolean key_names: description: 'Describes an array of parameter names where the plugin will look for a key. The client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. Key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.' type: array items: description: A string representing an HTTP header name. type: string realm: description: When authentication fails the plugin sends `WWW-Authenticate` header with `realm` attribute value. type: string run_on_preflight: description: 'A boolean value that indicates whether the plugin should run (and try to authenticate) on `OPTIONS` preflight requests. If set to `false`, then `OPTIONS` requests are always allowed.' type: boolean name: type: string const: key-auth-enc 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: enum: - grpc - grpcs - http - https - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false KeyAuthPlugin: x-speakeasy-entity: GatewayPluginKeyAuth allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/KeyAuthPluginConfig' KeyAuthPluginConfig: properties: config: type: object properties: anonymous: description: 'An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure `4xx`.' type: string hide_credentials: description: 'An optional boolean value telling the plugin to show or hide the credential from the upstream service. If `true`, the plugin strips the credential from the request.' type: boolean identity_realms: description: A configuration of Konnect Identity Realms that indicate where to source a consumer from. type: array items: properties: id: description: A string representing a UUID (universally unique identifier). type: string uuid: true region: type: string scope: type: string enum: - cp - realm type: object key_in_body: description: 'If enabled, the plugin reads the request body. Supported MIME types: `application/www-form-urlencoded`, `application/json`, and `multipart/form-data`.' type: boolean key_in_header: description: 'If enabled (default), the plugin reads the request header and tries to find the key in it.' type: boolean key_in_query: description: 'If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.' type: boolean key_names: description: 'Describes an array of parameter names where the plugin will look for a key. The key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.' type: array items: description: A string representing an HTTP header name. type: string realm: description: When authentication fails the plugin sends `WWW-Authenticate` header with `realm` attribute value. type: string run_on_preflight: description: 'A boolean value that indicates whether the plugin should run (and try to authenticate) on `OPTIONS` preflight requests. If set to `false`, then `OPTIONS` requests are always allowed.' type: boolean name: type: string const: key-auth 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: enum: - grpc - grpcs - http - https - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false KeyAuthWithoutParents: x-speakeasy-entity: GatewayKeyAuth type: object properties: consumer: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false x-speakeasy-terraform-ignore: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true key: type: string nullable: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true ttl: description: key-auth ttl in seconds type: integer nullable: true example: id: b2f34145-0343-41a4-9602-4c69dec2f269 key: IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo additionalProperties: false KeySet: x-speakeasy-entity: GatewayKeySet type: object properties: created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true name: description: The name to associate with the given key-set. type: string nullable: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true example: id: b58c7d9d-e54f-444c-b24d-cdfc4159f61e name: example-key-set tags: - idp-keys additionalProperties: false LdapAuthAdvancedPlugin: x-speakeasy-entity: GatewayPluginLdapAuthAdvanced allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/LdapAuthAdvancedPluginConfig' LdapAuthAdvancedPluginConfig: properties: config: type: object properties: anonymous: description: 'An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure `4xx`. Note that this value must refer to the consumer `id` or `username` attribute, and **not** its `custom_id`.' type: string attribute: description: 'Attribute to be used to search the user; e.g., "cn".' type: string base_dn: description: 'Base DN as the starting point for the search; e.g., ''dc=example,dc=com''.' type: string bind_dn: description: The DN to bind to. Used to perform LDAP search of user. This `bind_dn` should have permissions to search for the user being authenticated. type: string cache_ttl: description: Cache expiry time in seconds. type: number consumer_by: description: 'Whether to authenticate consumers based on `username`, `custom_id`, or both.' type: array items: enum: - custom_id - username type: string consumer_optional: description: 'Whether consumer mapping is optional. If `consumer_optional=true`, the plugin will not attempt to associate a consumer with the LDAP authenticated user.' type: boolean group_base_dn: description: 'Sets a distinguished name (DN) for the entry where LDAP searches for groups begin. This field is case-insensitive.'',dc=com''.' type: string group_member_attribute: description: Sets the attribute holding the members of the LDAP group. This field is case-sensitive. type: string group_name_attribute: description: 'Sets the attribute holding the name of a group, typically called `name` (in Active Directory) or `cn` (in OpenLDAP). This field is case-insensitive.' type: string groups_required: description: 'The groups required to be present in the LDAP search result for successful authorization. This config parameter works in both **AND** / **OR** cases. - When `["group1 group2"]` are in the same array indices, both `group1` AND `group2` need to be present in the LDAP search result. - When `["group1", "group2"]` are in different array indices, either `group1` OR `group2` need to be present in the LDAP search result.' type: array items: type: string header_type: description: 'An optional string to use as part of the Authorization header. By default, a valid Authorization header looks like this: `Authorization: ldap base64(username:password)`. If `header_type` is set to "basic", then the Authorization header would be `Authorization: basic base64(username:password)`. Note that `header_type` can take any string, not just `''ldap''` and `''basic''`.' type: string hide_credentials: description: An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request. type: boolean keepalive: description: An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed. type: number ldap_host: description: Host on which the LDAP server is running. type: string ldap_password: description: The password to the LDAP server. type: string ldap_port: description: 'TCP port where the LDAP server is listening. 389 is the default port for non-SSL LDAP and AD. 636 is the port required for SSL LDAP and AD. If `ldaps` is configured, you must use port 636.' type: number ldaps: description: 'Set it to `true` to use `ldaps`, a secure protocol (that can be configured to TLS) to connect to the LDAP server. When `ldaps` is configured, you must use port 636. If the `ldap` setting is enabled, ensure the `start_tls` setting is disabled.' type: boolean log_search_results: description: Displays all the LDAP search results received from the LDAP server for debugging purposes. Not recommended to be enabled in a production environment. type: boolean realm: description: When authentication fails the plugin sends `WWW-Authenticate` header with `realm` attribute value. type: string start_tls: description: 'Set it to `true` to issue StartTLS (Transport Layer Security) extended operation over `ldap` connection. If the `start_tls` setting is enabled, ensure the `ldaps` setting is disabled.' type: boolean timeout: description: An optional timeout in milliseconds when waiting for connection with LDAP server. type: number verify_ldap_host: description: Set to `true` to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the `lua_ssl_trusted_certificate` directive. type: boolean required: - attribute - base_dn - ldap_host name: type: string const: ldap-auth-advanced 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: enum: - grpc - grpcs - http - https - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config LdapAuthPlugin: x-speakeasy-entity: GatewayPluginLdapAuth allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/LdapAuthPluginConfig' LdapAuthPluginConfig: properties: config: type: object properties: anonymous: description: 'An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure `4xx`.' type: string attribute: description: Attribute to be used to search the user; e.g. cn type: string base_dn: description: 'Base DN as the starting point for the search; e.g., dc=example,dc=com' type: string cache_ttl: description: Cache expiry time in seconds. type: number header_type: description: An optional string to use as part of the Authorization header type: string hide_credentials: description: An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request. type: boolean keepalive: description: An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed. type: number ldap_host: description: 'A string representing a host name, such as example.com.' type: string ldap_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 ldaps: description: 'Set to `true` to connect using the LDAPS protocol (LDAP over TLS). When `ldaps` is configured, you must use port 636. If the `ldap` setting is enabled, ensure the `start_tls` setting is disabled.' type: boolean realm: description: When authentication fails the plugin sends `WWW-Authenticate` header with `realm` attribute value. type: string start_tls: description: 'Set it to `true` to issue StartTLS (Transport Layer Security) extended operation over `ldap` connection. If the `start_tls` setting is enabled, ensure the `ldaps` setting is disabled.' type: boolean timeout: description: An optional timeout in milliseconds when waiting for connection with LDAP server. type: number verify_ldap_host: description: Set to `true` to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the `lua_ssl_trusted_certificate` directive. type: boolean required: - attribute - base_dn - ldap_host name: type: string const: ldap-auth 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: enum: - grpc - grpcs - http - https - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config LogglyPlugin: x-speakeasy-entity: GatewayPluginLoggly allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/LogglyPluginConfig' LogglyPluginConfig: properties: config: type: object properties: client_errors_severity: type: string enum: - alert - crit - debug - emerg - err - info - notice - warning custom_fields_by_lua: description: Lua code as a key-value map type: object additionalProperties: true host: description: 'A string representing a host name, such as example.com.' type: string key: type: string log_level: type: string enum: - alert - crit - debug - emerg - err - info - notice - warning port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 server_errors_severity: type: string enum: - alert - crit - debug - emerg - err - info - notice - warning successful_severity: type: string enum: - alert - crit - debug - emerg - err - info - notice - warning tags: type: array items: type: string timeout: type: number required: - key 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: loggly protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config MTLSAuth: x-speakeasy-entity: GatewayMTLSAuth type: object properties: ca_certificate: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false consumer: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false x-speakeasy-terraform-ignore: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true subject_name: type: string tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true example: ca_certificate: id: b2f34145-0343-41a4-9602-4c69dec2f260 consumer: id: 84a73fb8-50fc-44a7-a4d5-aa17728ee83f id: b2f34145-0343-41a4-9602-4c69dec2f269 subject_name: CA_Subject_Name additionalProperties: false required: - subject_name MTLSAuthWithoutParents: x-speakeasy-entity: GatewayMTLSAuth type: object properties: ca_certificate: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false consumer: type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false x-speakeasy-terraform-ignore: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true subject_name: type: string tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true example: ca_certificate: id: b2f34145-0343-41a4-9602-4c69dec2f260 id: b2f34145-0343-41a4-9602-4c69dec2f269 subject_name: CA_Subject_Name additionalProperties: false required: - subject_name MockingPlugin: x-speakeasy-entity: GatewayPluginMocking allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/MockingPluginConfig' MockingPluginConfig: properties: config: type: object properties: api_specification: description: 'The contents of the specification file. You must use this option for hybrid or DB-less mode. You can include the full specification as part of the configuration. In Kong Manager, you can copy and paste the contents of the spec directly into the `Config.Api Specification` text field.' type: string api_specification_filename: description: The path and name of the specification file loaded into Kong Gateway's database. You cannot use this option for DB-less or hybrid mode. type: string custom_base_path: description: The base path to be used for path match evaluation. This value is ignored if `include_base_path` is set to `false`. type: string include_base_path: description: Indicates whether to include the base path when performing path match evaluation. type: boolean included_status_codes: description: A global list of the HTTP status codes that can only be selected and returned. type: array items: type: integer max_delay_time: description: The maximum value in seconds of delay time. Set this value when `random_delay` is enabled and you want to adjust the default. The value must be greater than the `min_delay_time`. type: number min_delay_time: description: The minimum value in seconds of delay time. Set this value when `random_delay` is enabled and you want to adjust the default. The value must be less than the `max_delay_time`. type: number random_delay: description: Enables a random delay in the mocked response. Introduces delays to simulate real-time response times by APIs. type: boolean random_examples: description: Randomly selects one example and returns it. This parameter requires the spec to have multiple examples configured. type: boolean random_status_code: description: 'Determines whether to randomly select an HTTP status code from the responses of the corresponding API method. The default value is `false`, which means the minimum HTTP status code is always selected and returned.' type: boolean 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: mocking protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false MtlsAuthPlugin: x-speakeasy-entity: GatewayPluginMtlsAuth allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/MtlsAuthPluginConfig' MtlsAuthPluginConfig: properties: config: type: object properties: allow_partial_chain: description: 'Allow certificate verification with only an intermediate certificate. When this is enabled, you don''t need to upload the full chain to Kong Certificates.' type: boolean anonymous: description: 'An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure `4xx`. Note that this value must refer to the consumer `id` or `username` attribute, and **not** its `custom_id`.' type: string authenticated_group_by: description: 'Certificate property to use as the authenticated group. Valid values are `CN` (Common Name) or `DN` (Distinguished Name). Once `skip_consumer_lookup` is applied, any client with a valid certificate can access the Service/API. To restrict usage to only some of the authenticated users, also add the ACL plugin (not covered here) and create allowed or denied groups of users.' type: string enum: - CN - DN ca_certificates: description: List of CA Certificates strings to use as Certificate Authorities (CA) when validating a client certificate. At least one is required but you can specify as many as needed. The value of this array is comprised of primary keys (`id`). type: array items: type: string uuid: true cache_ttl: description: Cache expiry time in seconds. type: number cert_cache_ttl: description: The length of time in seconds between refreshes of the revocation check status cache. type: number consumer_by: description: 'Whether to match the subject name of the client-supplied certificate against consumer''s `username` and/or `custom_id` attribute. If set to `[]` (the empty array), then auto-matching is disabled.' type: array items: enum: - custom_id - username type: string default_consumer: description: 'The UUID or username of the consumer to use when a trusted client certificate is presented but no consumer matches. Note that this value must refer to the consumer `id` or `username` attribute, and **not** its `custom_id`.' type: string http_proxy_host: description: 'A string representing a host name, such as example.com.' type: string http_proxy_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 http_timeout: description: HTTP timeout threshold in milliseconds when communicating with the OCSP server or downloading CRL. type: number https_proxy_host: description: 'A string representing a host name, such as example.com.' type: string https_proxy_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 revocation_check_mode: description: 'Controls client certificate revocation check behavior. If set to `SKIP`, no revocation check is performed. If set to `IGNORE_CA_ERROR`, the plugin respects the revocation status when either OCSP or CRL URL is set, and doesn''t fail on network issues. If set to `STRICT`, the plugin only treats the certificate as valid when it''s able to verify the revocation status.' type: string enum: - IGNORE_CA_ERROR - SKIP - STRICT send_ca_dn: description: Sends the distinguished names (DN) of the configured CA list in the TLS handshake message. type: boolean skip_consumer_lookup: description: Skip consumer lookup once certificate is trusted against the configured CA list. type: boolean required: - ca_certificates name: type: string const: mtls-auth protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config OasValidationPlugin: x-speakeasy-entity: GatewayPluginOasValidation allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/OasValidationPluginConfig' OasValidationPluginConfig: properties: config: type: object properties: allowed_header_parameters: description: 'List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header `User-Agent`, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.' type: string api_spec: description: 'The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.' type: string api_spec_encoded: description: Indicates whether the api_spec is URI-Encoded. type: boolean custom_base_path: description: The base path to be used for path match evaluation. This value is ignored if `include_base_path` is set to `false`. type: string header_parameter_check: description: 'If set to true, checks if HTTP header parameters in the request exist in the API specification.' type: boolean include_base_path: description: Indicates whether to include the base path when performing path match evaluation. type: boolean notify_only_request_validation_failure: description: 'If set to true, notifications via event hooks are enabled, but request based validation failures don''t affect the request flow.' type: boolean notify_only_response_body_validation_failure: description: 'If set to true, notifications via event hooks are enabled, but response validation failures don''t affect the response flow.' type: boolean query_parameter_check: description: 'If set to true, checks if query parameters in the request exist in the API specification.' type: boolean validate_request_body: description: 'If set to true, validates the request body content against the API specification.' type: boolean validate_request_header_params: description: 'If set to true, validates HTTP header parameters against the API specification.' type: boolean validate_request_query_params: description: 'If set to true, validates query parameters against the API specification.' type: boolean validate_request_uri_params: description: 'If set to true, validates URI parameters in the request against the API specification.' type: boolean validate_response_body: description: 'If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an `HTTP 406 Not Acceptable` status code.' type: boolean verbose_response: description: 'If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.' type: boolean required: - api_spec 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: oas-validation protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config Oauth2IntrospectionPlugin: x-speakeasy-entity: GatewayPluginOauth2Introspection allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/Oauth2IntrospectionPluginConfig' Oauth2IntrospectionPluginConfig: properties: config: type: object properties: anonymous: description: 'An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure `4xx`. Note that this value must refer to the consumer `id` or `username` attribute, and **not** its `custom_id`.' type: string authorization_value: description: 'The value to set as the `Authorization` header when querying the introspection endpoint. This depends on the OAuth 2.0 server, but usually is the `client_id` and `client_secret` as a Base64-encoded Basic Auth string (`Basic MG9hNWl...`).' type: string consumer_by: description: 'A string indicating whether to associate OAuth2 `username` or `client_id` with the consumer''s username. OAuth2 `username` is mapped to a consumer''s `username` field, while an OAuth2 `client_id` maps to a consumer''s `custom_id`.' type: string enum: - client_id - username custom_claims_forward: description: 'A list of custom claims to be forwarded from the introspection response to the upstream request. Claims are forwarded in headers with prefix `X-Credential-{claim-name}`.' type: array items: type: string custom_introspection_headers: description: A list of custom headers to be added in the introspection request. type: object additionalProperties: true hide_credentials: description: An optional boolean value telling the plugin to hide the credential to the upstream API server. It will be removed by Kong before proxying the request. type: boolean introspect_request: description: 'A boolean indicating whether to forward information about the current downstream request to the introspect endpoint. If true, headers `X-Request-Path` and `X-Request-Http-Method` will be inserted into the introspect request.' type: boolean introspection_url: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string keepalive: description: An optional value in milliseconds that defines how long an idle connection lives before being closed. type: integer run_on_preflight: description: 'A boolean value that indicates whether the plugin should run (and try to authenticate) on `OPTIONS` preflight requests. If set to `false`, then `OPTIONS` requests will always be allowed.' type: boolean timeout: description: An optional timeout in milliseconds when sending data to the upstream server. type: integer token_type_hint: description: The `token_type_hint` value to associate to introspection requests. type: string ttl: description: The TTL in seconds for the introspection response. Set to 0 to disable the expiration. type: number required: - authorization_value - introspection_url name: type: string const: oauth-2-introspection protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config OpaPlugin: x-speakeasy-entity: GatewayPluginOpa allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/OpaPluginConfig' OpaPluginConfig: properties: config: type: object properties: include_body_in_opa_input: type: boolean include_consumer_in_opa_input: description: 'If set to true, the Kong Gateway Consumer object in use for the current request (if any) is included as input to OPA.' type: boolean include_parsed_json_body_in_opa_input: description: 'If set to true and the `Content-Type` header of the current request is `application/json`, the request body will be JSON decoded and the decoded struct is included as input to OPA.' type: boolean include_route_in_opa_input: description: 'If set to true, the Kong Gateway Route object in use for the current request is included as input to OPA.' type: boolean include_service_in_opa_input: description: 'If set to true, the Kong Gateway Service object in use for the current request is included as input to OPA.' type: boolean include_uri_captures_in_opa_input: description: 'If set to true, the regex capture groups captured on the Kong Gateway Route''s path field in the current request (if any) are included as input to OPA.' type: boolean opa_host: description: 'A string representing a host name, such as example.com.' type: string opa_path: description: 'A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).' type: string opa_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 opa_protocol: description: The protocol to use when talking to Open Policy Agent (OPA) server. Allowed protocols are `http` and `https`. type: string enum: - http - https ssl_verify: description: 'If set to true, the OPA certificate will be verified according to the CA certificates specified in lua_ssl_trusted_certificate.' type: boolean required: - opa_path name: type: string const: opa protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config OpenidConnectPlugin: x-speakeasy-entity: GatewayPluginOpenidConnect allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/OpenidConnectPluginConfig' OpenidConnectPluginConfig: properties: config: type: object properties: anonymous: description: 'An optional string (consumer UUID or username) value that functions as an “anonymous” consumer if authentication fails. If empty (default null), requests that fail authentication will return a `4xx` HTTP status code. This value must refer to the consumer `id` or `username` attribute, and **not** its `custom_id`.' type: string audience: description: The audience passed to the authorization endpoint. type: array items: type: string audience_claim: description: 'The claim that contains the audience. If multiple values are set, it means the claim is inside a nested object of the token payload.' type: array items: type: string audience_required: description: The audiences (`audience_claim` claim) required to be present in the access token (or introspection results) for successful authorization. This config parameter works in both **AND** / **OR** cases. type: array items: type: string auth_methods: description: Types of credentials/grants to enable. type: array items: enum: - authorization_code - bearer - client_credentials - introspection - kong_oauth2 - password - refresh_token - session - userinfo type: string authenticated_groups_claim: description: 'The claim that contains authenticated groups. This setting can be used together with ACL plugin, but it also enables IdP managed groups with other applications and integrations. If multiple values are set, it means the claim is inside a nested object of the token payload.' type: array items: type: string authorization_cookie_domain: description: The authorization cookie Domain flag. type: string authorization_cookie_http_only: description: 'Forbids JavaScript from accessing the cookie, for example, through the `Document.cookie` property.' type: boolean authorization_cookie_name: description: The authorization cookie name. type: string authorization_cookie_path: description: The authorization cookie Path flag. type: string authorization_cookie_same_site: description: 'Controls whether a cookie is sent with cross-origin requests, providing some protection against cross-site request forgery attacks.' type: string enum: - Default - Lax - None - Strict authorization_cookie_secure: description: 'Cookie is only sent to the server when a request is made with the https: scheme (except on localhost), and therefore is more resistant to man-in-the-middle attacks.' type: boolean authorization_endpoint: description: The authorization endpoint. If set it overrides the value in `authorization_endpoint` returned by the discovery endpoint. type: string authorization_query_args_client: description: Extra query arguments passed from the client to the authorization endpoint. type: array items: type: string authorization_query_args_names: description: Extra query argument names passed to the authorization endpoint. type: array items: type: string authorization_query_args_values: description: Extra query argument values passed to the authorization endpoint. type: array items: type: string authorization_rolling_timeout: description: Specifies how long the session used for the authorization code flow can be used in seconds until it needs to be renewed. 0 disables the checks and rolling. type: number bearer_token_cookie_name: description: The name of the cookie in which the bearer token is passed. type: string bearer_token_param_type: description: 'Where to look for the bearer token: - `header`: search the `Authorization`, `access-token`, and `x-access-token` HTTP headers - `query`: search the URL''s query string - `body`: search the HTTP request body - `cookie`: search the HTTP request cookies specified with `config.bearer_token_cookie_name`.' type: array items: enum: - body - cookie - header - query type: string by_username_ignore_case: description: 'If `consumer_by` is set to `username`, specify whether `username` can match consumers case-insensitively.' type: boolean cache_introspection: description: Cache the introspection endpoint requests. type: boolean cache_token_exchange: description: Cache the token exchange endpoint requests. type: boolean cache_tokens: description: Cache the token endpoint requests. type: boolean cache_tokens_salt: description: Salt used for generating the cache key that is used for caching the token endpoint requests. type: string cache_ttl: description: The default cache ttl in seconds that is used in case the cached object does not specify the expiry. type: number cache_ttl_max: description: The maximum cache ttl in seconds (enforced). type: number cache_ttl_min: description: The minimum cache ttl in seconds (enforced). type: number cache_ttl_neg: description: The negative cache ttl in seconds. type: number cache_ttl_resurrect: description: The resurrection ttl in seconds. type: number cache_user_info: description: Cache the user info requests. type: boolean claims_forbidden: description: 'If given, these claims are forbidden in the token payload.' type: array items: type: string client_alg: description: The algorithm to use for client_secret_jwt (only HS***) or private_key_jwt authentication. type: array items: enum: - ES256 - ES384 - ES512 - EdDSA - HS256 - HS384 - HS512 - PS256 - PS384 - PS512 - RS256 - RS384 - RS512 type: string client_arg: description: The client to use for this request (the selection is made with a request parameter with the same name). type: string client_auth: description: 'The default OpenID Connect client authentication method is ''client_secret_basic'' (using ''Authorization: Basic'' header), ''client_secret_post'' (credentials in body), ''client_secret_jwt'' (signed client assertion in body), ''private_key_jwt'' (private key-signed assertion), ''tls_client_auth'' (client certificate), ''self_signed_tls_client_auth'' (self-signed client certificate), and ''none'' (no authentication).' type: array items: enum: - client_secret_basic - client_secret_jwt - client_secret_post - none - private_key_jwt - self_signed_tls_client_auth - tls_client_auth type: string client_credentials_param_type: description: 'Where to look for the client credentials: - `header`: search the HTTP headers - `query`: search the URL''s query string - `body`: search from the HTTP request body.' type: array items: enum: - body - header - query type: string client_id: description: The client id(s) that the plugin uses when it calls authenticated endpoints on the identity provider. type: array items: type: string client_jwk: description: The JWK used for the private_key_jwt authentication. type: array items: properties: alg: type: string crv: type: string d: type: string dp: type: string dq: type: string e: type: string issuer: type: string k: type: string key_ops: type: array items: type: string kid: type: string kty: type: string 'n': type: string oth: type: string p: type: string q: type: string qi: type: string r: type: string t: type: string use: type: string x: type: string x5c: type: array items: type: string x5t: type: string x5t#S256: type: string x5u: type: string 'y': type: string type: object client_secret: description: The client secret. type: array items: type: string cluster_cache_redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer cluster_cache_strategy: description: 'The strategy to use for the cluster cache. If set, the plugin will share cache with nodes configured with the same strategy backend. Currentlly only introspection cache is shared.' type: string enum: - 'off' - redis consumer_by: description: 'Consumer fields used for mapping: - `id`: try to find the matching Consumer by `id` - `username`: try to find the matching Consumer by `username` - `custom_id`: try to find the matching Consumer by `custom_id`.' type: array items: enum: - custom_id - id - username type: string consumer_claim: description: 'The claim used for consumer mapping. If multiple values are set, it means the claim is inside a nested object of the token payload.' type: array items: type: string consumer_optional: description: Do not terminate the request if consumer mapping fails. type: boolean credential_claim: description: 'The claim used to derive virtual credentials (e.g. to be consumed by the rate-limiting plugin), in case the consumer mapping is not used. If multiple values are set, it means the claim is inside a nested object of the token payload.' type: array items: type: string disable_session: description: Disable issuing the session cookie with the specified grants. type: array items: enum: - authorization_code - bearer - client_credentials - introspection - kong_oauth2 - password - refresh_token - session - userinfo type: string discovery_headers_names: description: Extra header names passed to the discovery endpoint. type: array items: type: string discovery_headers_values: description: Extra header values passed to the discovery endpoint. type: array items: type: string display_errors: description: Display errors on failure responses. type: boolean domains: description: The allowed values for the `hd` claim. type: array items: type: string downstream_access_token_header: description: The downstream access token header. type: string downstream_access_token_jwk_header: description: The downstream access token JWK header. type: string downstream_headers_claims: description: 'The downstream header claims. If multiple values are set, it means the claim is inside a nested object of the token payload.' type: array items: type: string downstream_headers_names: description: The downstream header names for the claim values. type: array items: type: string downstream_id_token_header: description: The downstream id token header. type: string downstream_id_token_jwk_header: description: The downstream id token JWK header. type: string downstream_introspection_header: description: The downstream introspection header. type: string downstream_introspection_jwt_header: description: The downstream introspection JWT header. type: string downstream_refresh_token_header: description: The downstream refresh token header. type: string downstream_session_id_header: description: The downstream session id header. type: string downstream_user_info_header: description: The downstream user info header. type: string downstream_user_info_jwt_header: description: The downstream user info JWT header (in case the user info returns a JWT response). type: string dpop_proof_lifetime: description: 'Specifies the lifetime in seconds of the DPoP proof. It determines how long the same proof can be used after creation. The creation time is determined by the nonce creation time if a nonce is used, and the iat claim otherwise.' type: number dpop_use_nonce: description: Specifies whether to challenge the client with a nonce value for DPoP proof. When enabled it will also be used to calculate the DPoP proof lifetime. type: boolean enable_hs_signatures: description: 'Enable shared secret, for example, HS256, signatures (when disabled they will not be accepted).' type: boolean end_session_endpoint: description: The end session endpoint. If set it overrides the value in `end_session_endpoint` returned by the discovery endpoint. type: string expose_error_code: description: 'Specifies whether to expose the error code header, as defined in RFC 6750. If an authorization request fails, this header is sent in the response. Set to `false` to disable.' type: boolean extra_jwks_uris: description: JWKS URIs whose public keys are trusted (in addition to the keys found with the discovery). type: array items: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string forbidden_destroy_session: description: Destroy any active session for the forbidden requests. type: boolean forbidden_error_message: description: The error message for the forbidden requests (when not using the redirection). type: string forbidden_redirect_uri: description: Where to redirect the client on forbidden requests. type: array items: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string groups_claim: description: 'The claim that contains the groups. If multiple values are set, it means the claim is inside a nested object of the token payload.' type: array items: type: string groups_required: description: The groups (`groups_claim` claim) required to be present in the access token (or introspection results) for successful authorization. This config parameter works in both **AND** / **OR** cases. type: array items: type: string hide_credentials: description: 'Remove the credentials used for authentication from the request. If multiple credentials are sent with the same request, the plugin will remove those that were used for successful authentication.' type: boolean http_proxy: description: The HTTP proxy. type: string http_proxy_authorization: description: The HTTP proxy authorization. type: string http_version: description: 'The HTTP version used for the requests by this plugin: - `1.1`: HTTP 1.1 (the default) - `1.0`: HTTP 1.0.' type: number https_proxy: description: The HTTPS proxy. type: string https_proxy_authorization: description: The HTTPS proxy authorization. type: string id_token_param_name: description: The name of the parameter used to pass the id token. type: string id_token_param_type: description: 'Where to look for the id token: - `header`: search the HTTP headers - `query`: search the URL''s query string - `body`: search the HTTP request body.' type: array items: enum: - body - header - query type: string ignore_signature: description: 'Skip the token signature verification on certain grants: - `password`: OAuth password grant - `client_credentials`: OAuth client credentials grant - `authorization_code`: authorization code flow - `refresh_token`: OAuth refresh token grant - `session`: session cookie authentication - `introspection`: OAuth introspection - `userinfo`: OpenID Connect user info endpoint authentication.' type: array items: enum: - authorization_code - client_credentials - introspection - password - refresh_token - session - userinfo type: string introspect_jwt_tokens: description: Specifies whether to introspect the JWT access tokens (can be used to check for revocations). type: boolean introspection_accept: description: 'The value of `Accept` header for introspection requests: - `application/json`: introspection response as JSON - `application/token-introspection+jwt`: introspection response as JWT (from the current IETF draft document) - `application/jwt`: introspection response as JWT (from the obsolete IETF draft document).' type: string enum: - application/json - application/jwt - application/token-introspection+jwt introspection_check_active: description: Check that the introspection response has an `active` claim with a value of `true`. type: boolean introspection_endpoint: description: The introspection endpoint. If set it overrides the value in `introspection_endpoint` returned by the discovery endpoint. type: string introspection_endpoint_auth_method: description: 'The introspection endpoint authentication method: : `client_secret_basic`, `client_secret_post`, `client_secret_jwt`, `private_key_jwt`, `tls_client_auth`, `self_signed_tls_client_auth`, or `none`: do not authenticate' type: string enum: - client_secret_basic - client_secret_jwt - client_secret_post - none - private_key_jwt - self_signed_tls_client_auth - tls_client_auth introspection_headers_client: description: Extra headers passed from the client to the introspection endpoint. type: array items: type: string introspection_headers_names: description: Extra header names passed to the introspection endpoint. type: array items: type: string introspection_headers_values: description: Extra header values passed to the introspection endpoint. type: array items: type: string introspection_hint: description: Introspection hint parameter value passed to the introspection endpoint. type: string introspection_post_args_client: description: Extra post arguments passed from the client to the introspection endpoint. type: array items: type: string introspection_post_args_client_headers: description: Extra post arguments passed from the client headers to the introspection endpoint. type: array items: type: string introspection_post_args_names: description: Extra post argument names passed to the introspection endpoint. type: array items: type: string introspection_post_args_values: description: Extra post argument values passed to the introspection endpoint. type: array items: type: string introspection_token_param_name: description: Designate token's parameter name for introspection. type: string issuer: description: 'The discovery endpoint (or the issuer identifier). When there is no discovery endpoint, please also configure `config.using_pseudo_issuer=true`.' type: string issuers_allowed: description: The issuers allowed to be present in the tokens (`iss` claim). type: array items: type: string jwt_session_claim: description: The claim to match against the JWT session cookie. type: string jwt_session_cookie: description: The name of the JWT session cookie. type: string keepalive: description: Use keepalive with the HTTP client. type: boolean leeway: description: 'Defines leeway time (in seconds) for `auth_time`, `exp`, `iat`, and `nbf` claims' type: number login_action: description: 'What to do after successful login: - `upstream`: proxy request to upstream service - `response`: terminate request with a response - `redirect`: redirect to a different location.' type: string enum: - redirect - response - upstream login_methods: description: Enable login functionality with specified grants. type: array items: enum: - authorization_code - bearer - client_credentials - introspection - kong_oauth2 - password - refresh_token - session - userinfo type: string login_redirect_mode: description: 'Where to place `login_tokens` when using `redirect` `login_action`: - `query`: place tokens in query string - `fragment`: place tokens in url fragment (not readable by servers).' type: string enum: - fragment - query login_redirect_uri: description: Where to redirect the client when `login_action` is set to `redirect`. type: array items: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string login_tokens: description: 'What tokens to include in `response` body or `redirect` query string or fragment: - `id_token`: include id token - `access_token`: include access token - `refresh_token`: include refresh token - `tokens`: include the full token endpoint response - `introspection`: include introspection response.' type: array items: enum: - access_token - id_token - introspection - refresh_token - tokens type: string logout_methods: description: 'The request methods that can activate the logout: - `POST`: HTTP POST method - `GET`: HTTP GET method - `DELETE`: HTTP DELETE method.' type: array items: enum: - DELETE - GET - POST type: string logout_post_arg: description: The request body argument that activates the logout. type: string logout_query_arg: description: The request query argument that activates the logout. type: string logout_redirect_uri: description: Where to redirect the client after the logout. type: array items: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string logout_revoke: description: |- Revoke tokens as part of the logout. For more granular token revocation, you can also adjust the `logout_revoke_access_token` and `logout_revoke_refresh_token` parameters. type: boolean logout_revoke_access_token: description: Revoke the access token as part of the logout. Requires `logout_revoke` to be set to `true`. type: boolean logout_revoke_refresh_token: description: Revoke the refresh token as part of the logout. Requires `logout_revoke` to be set to `true`. type: boolean logout_uri_suffix: description: The request URI suffix that activates the logout. type: string max_age: description: The maximum age (in seconds) compared to the `auth_time` claim. type: number mtls_introspection_endpoint: description: Alias for the introspection endpoint to be used for mTLS client authentication. If set it overrides the value in `mtls_endpoint_aliases` returned by the discovery endpoint. type: string mtls_revocation_endpoint: description: Alias for the introspection endpoint to be used for mTLS client authentication. If set it overrides the value in `mtls_endpoint_aliases` returned by the discovery endpoint. type: string mtls_token_endpoint: description: Alias for the token endpoint to be used for mTLS client authentication. If set it overrides the value in `mtls_endpoint_aliases` returned by the discovery endpoint. type: string no_proxy: description: Do not use proxy with these hosts. type: string password_param_type: description: 'Where to look for the username and password: - `header`: search the HTTP headers - `query`: search the URL''s query string - `body`: search the HTTP request body.' type: array items: enum: - body - header - query type: string preserve_query_args: description: 'With this parameter, you can preserve request query arguments even when doing authorization code flow.' type: boolean proof_of_possession_auth_methods_validation: description: 'If set to true, only the auth_methods that are compatible with Proof of Possession (PoP) can be configured when PoP is enabled. If set to false, all auth_methods will be configurable and PoP checks will be silently skipped for those auth_methods that are not compatible with PoP.' type: boolean proof_of_possession_dpop: description: 'Enable Demonstrating Proof-of-Possession (DPoP). If set to strict, all request are verified despite the presence of the DPoP key claim (cnf.jkt). If set to optional, only tokens bound with DPoP''s key are verified with the proof.' type: string enum: - 'off' - optional - strict proof_of_possession_mtls: description: 'Enable mtls proof of possession. If set to strict, all tokens (from supported auth_methods: bearer, introspection, and session granted with bearer or introspection) are verified, if set to optional, only tokens that contain the certificate hash claim are verified. If the verification fails, the request will be rejected with 401.' type: string enum: - 'off' - optional - strict pushed_authorization_request_endpoint: description: The pushed authorization endpoint. If set it overrides the value in `pushed_authorization_request_endpoint` returned by the discovery endpoint. type: string pushed_authorization_request_endpoint_auth_method: description: 'The pushed authorization request endpoint authentication method: `client_secret_basic`, `client_secret_post`, `client_secret_jwt`, `private_key_jwt`, `tls_client_auth`, `self_signed_tls_client_auth`, or `none`: do not authenticate' type: string enum: - client_secret_basic - client_secret_jwt - client_secret_post - none - private_key_jwt - self_signed_tls_client_auth - tls_client_auth redirect_uri: description: The redirect URI passed to the authorization and token endpoints. type: array items: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 prefix: description: The Redis session key prefix. type: string read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string socket: description: The Redis unix socket path. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer rediscovery_lifetime: description: Specifies how long (in seconds) the plugin waits between discovery attempts. Discovery is still triggered on an as-needed basis. type: number refresh_token_param_name: description: The name of the parameter used to pass the refresh token. type: string refresh_token_param_type: description: 'Where to look for the refresh token: - `header`: search the HTTP headers - `query`: search the URL''s query string - `body`: search the HTTP request body.' type: array items: enum: - body - header - query type: string refresh_tokens: description: Specifies whether the plugin should try to refresh (soon to be) expired access tokens if the plugin has a `refresh_token` available. type: boolean require_proof_key_for_code_exchange: description: 'Forcibly enable or disable the proof key for code exchange. When not set the value is determined through the discovery using the value of `code_challenge_methods_supported`, and enabled automatically (in case the `code_challenge_methods_supported` is missing, the PKCE will not be enabled).' type: boolean require_pushed_authorization_requests: description: Forcibly enable or disable the pushed authorization requests. When not set the value is determined through the discovery using the value of `require_pushed_authorization_requests` (which defaults to `false`). type: boolean require_signed_request_object: description: 'Forcibly enable or disable the usage of signed request object on authorization or pushed authorization endpoint. When not set the value is determined through the discovery using the value of `require_signed_request_object`, and enabled automatically (in case the `require_signed_request_object` is missing, the feature will not be enabled).' type: boolean resolve_distributed_claims: description: 'Distributed claims are represented by the `_claim_names` and `_claim_sources` members of the JSON object containing the claims. If this parameter is set to `true`, the plugin explicitly resolves these distributed claims.' type: boolean response_mode: description: 'Response mode passed to the authorization endpoint: - `query`: for parameters in query string - `form_post`: for parameters in request body - `fragment`: for parameters in uri fragment (rarely useful as the plugin itself cannot read it) - `query.jwt`, `form_post.jwt`, `fragment.jwt`: similar to `query`, `form_post` and `fragment` but the parameters are encoded in a JWT - `jwt`: shortcut that indicates the default encoding for the requested response type.' type: string enum: - form_post - form_post.jwt - fragment - fragment.jwt - jwt - query - query.jwt response_type: description: The response type passed to the authorization endpoint. type: array items: type: string reverify: description: Specifies whether to always verify tokens stored in the session. type: boolean revocation_endpoint: description: The revocation endpoint. If set it overrides the value in `revocation_endpoint` returned by the discovery endpoint. type: string revocation_endpoint_auth_method: description: 'The revocation endpoint authentication method: : `client_secret_basic`, `client_secret_post`, `client_secret_jwt`, `private_key_jwt`, `tls_client_auth`, `self_signed_tls_client_auth`, or `none`: do not authenticate' type: string enum: - client_secret_basic - client_secret_jwt - client_secret_post - none - private_key_jwt - self_signed_tls_client_auth - tls_client_auth revocation_token_param_name: description: Designate token's parameter name for revocation. type: string roles_claim: description: 'The claim that contains the roles. If multiple values are set, it means the claim is inside a nested object of the token payload.' type: array items: type: string roles_required: description: The roles (`roles_claim` claim) required to be present in the access token (or introspection results) for successful authorization. This config parameter works in both **AND** / **OR** cases. type: array items: type: string run_on_preflight: description: Specifies whether to run this plugin on pre-flight (`OPTIONS`) requests. type: boolean scopes: description: The scopes passed to the authorization and token endpoints. type: array items: type: string default: [] nullable: true scopes_claim: description: 'The claim that contains the scopes. If multiple values are set, it means the claim is inside a nested object of the token payload.' type: array items: type: string scopes_required: description: The scopes (`scopes_claim` claim) required to be present in the access token (or introspection results) for successful authorization. This config parameter works in both **AND** / **OR** cases. type: array items: type: string search_user_info: description: 'Specify whether to use the user info endpoint to get additional claims for consumer mapping, credential mapping, authenticated groups, and upstream and downstream headers.' type: boolean session_absolute_timeout: description: 'Limits how long the session can be renewed in seconds, until re-authentication is required. 0 disables the checks.' type: number session_audience: description: 'The session audience, which is the intended target application. For example `"my-application"`.' type: string session_cookie_domain: description: The session cookie Domain flag. type: string session_cookie_http_only: description: 'Forbids JavaScript from accessing the cookie, for example, through the `Document.cookie` property.' type: boolean session_cookie_name: description: The session cookie name. type: string session_cookie_path: description: The session cookie Path flag. type: string session_cookie_same_site: description: 'Controls whether a cookie is sent with cross-origin requests, providing some protection against cross-site request forgery attacks.' type: string enum: - Default - Lax - None - Strict session_cookie_secure: description: 'Cookie is only sent to the server when a request is made with the https: scheme (except on localhost), and therefore is more resistant to man-in-the-middle attacks.' type: boolean session_enforce_same_subject: description: 'When set to `true`, audiences are forced to share the same subject.' type: boolean session_hash_storage_key: description: 'When set to `true`, the storage key (session ID) is hashed for extra security. Hashing the storage key means it is impossible to decrypt data from the storage without a cookie.' type: boolean session_hash_subject: description: 'When set to `true`, the value of subject is hashed before being stored. Only applies when `session_store_metadata` is enabled.' type: boolean session_idling_timeout: description: Specifies how long the session can be inactive until it is considered invalid in seconds. 0 disables the checks and touching. type: number session_memcached_host: description: The memcached host. type: string session_memcached_port: description: The memcached port. type: integer maximum: 65535 minimum: 0 session_memcached_prefix: description: The memcached session key prefix. type: string session_memcached_socket: description: The memcached unix socket path. type: string session_remember: description: Enables or disables persistent sessions. type: boolean session_remember_absolute_timeout: description: 'Limits how long the persistent session can be renewed in seconds, until re-authentication is required. 0 disables the checks.' type: number session_remember_cookie_name: description: Persistent session cookie name. Use with the `remember` configuration parameter. type: string session_remember_rolling_timeout: description: Specifies how long the persistent session is considered valid in seconds. 0 disables the checks and rolling. type: number session_request_headers: description: 'Set of headers to send to upstream, use id, audience, subject, timeout, idling-timeout, rolling-timeout, absolute-timeout. E.g. `[ "id", "timeout" ]` will set Session-Id and Session-Timeout request headers.' type: array items: enum: - absolute-timeout - audience - id - idling-timeout - rolling-timeout - subject - timeout type: string session_response_headers: description: 'Set of headers to send to downstream, use id, audience, subject, timeout, idling-timeout, rolling-timeout, absolute-timeout. E.g. `[ "id", "timeout" ]` will set Session-Id and Session-Timeout response headers.' type: array items: enum: - absolute-timeout - audience - id - idling-timeout - rolling-timeout - subject - timeout type: string session_rolling_timeout: description: Specifies how long the session can be used in seconds until it needs to be renewed. 0 disables the checks and rolling. type: number session_secret: description: The session secret. type: string session_storage: description: 'The session storage for session data: - `cookie`: stores session data with the session cookie (the session cannot be invalidated or revoked without changing session secret, but is stateless, and doesn''t require a database) - `memcache`: stores session data in memcached - `redis`: stores session data in Redis.' type: string enum: - cookie - memcache - memcached - redis session_store_metadata: description: Configures whether or not session metadata should be stored. This metadata includes information about the active sessions for a specific audience belonging to a specific subject. type: boolean ssl_verify: description: 'Verify identity provider server certificate. If set to `true`, the plugin uses the CA certificate set in the `kong.conf` config parameter `lua_ssl_trusted_certificate`.' type: boolean timeout: description: Network IO timeout in milliseconds. type: number tls_client_auth_cert_id: description: ID of the Certificate entity representing the client certificate to use for mTLS client authentication for connections between Kong and the Auth Server. type: string uuid: true tls_client_auth_ssl_verify: description: Verify identity provider server certificate during mTLS client authentication. type: boolean token_cache_key_include_scope: description: 'Include the scope in the token cache key, so token with different scopes are considered diffrent tokens.' type: boolean token_endpoint: description: The token endpoint. If set it overrides the value in `token_endpoint` returned by the discovery endpoint. type: string token_endpoint_auth_method: description: 'The token endpoint authentication method: `client_secret_basic`, `client_secret_post`, `client_secret_jwt`, `private_key_jwt`, `tls_client_auth`, `self_signed_tls_client_auth`, or `none`: do not authenticate' type: string enum: - client_secret_basic - client_secret_jwt - client_secret_post - none - private_key_jwt - self_signed_tls_client_auth - tls_client_auth token_exchange_endpoint: description: The token exchange endpoint. type: string token_headers_client: description: Extra headers passed from the client to the token endpoint. type: array items: type: string token_headers_grants: description: 'Enable the sending of the token endpoint response headers only with certain grants: - `password`: with OAuth password grant - `client_credentials`: with OAuth client credentials grant - `authorization_code`: with authorization code flow - `refresh_token` with refresh token grant.' type: array items: enum: - authorization_code - client_credentials - password - refresh_token type: string token_headers_names: description: Extra header names passed to the token endpoint. type: array items: type: string token_headers_prefix: description: Add a prefix to the token endpoint response headers before forwarding them to the downstream client. type: string token_headers_replay: description: The names of token endpoint response headers to forward to the downstream client. type: array items: type: string token_headers_values: description: Extra header values passed to the token endpoint. type: array items: type: string token_post_args_client: description: 'Pass extra arguments from the client to the OpenID-Connect plugin. If arguments exist, the client can pass them using: - Query parameters - Request Body - Request Header This parameter can be used with `scope` values, like this: `config.token_post_args_client=scope` In this case, the token would take the `scope` value from the query parameter or from the request body or from the header and send it to the token endpoint.' type: array items: type: string token_post_args_names: description: Extra post argument names passed to the token endpoint. type: array items: type: string token_post_args_values: description: Extra post argument values passed to the token endpoint. type: array items: type: string unauthorized_destroy_session: description: Destroy any active session for the unauthorized requests. type: boolean unauthorized_error_message: description: The error message for the unauthorized requests (when not using the redirection). type: string unauthorized_redirect_uri: description: Where to redirect the client on unauthorized requests. type: array items: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string unexpected_redirect_uri: description: Where to redirect the client when unexpected errors happen with the requests. type: array items: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string upstream_access_token_header: description: The upstream access token header. type: string upstream_access_token_jwk_header: description: The upstream access token JWK header. type: string upstream_headers_claims: description: The upstream header claims. Only top level claims are supported. type: array items: type: string upstream_headers_names: description: The upstream header names for the claim values. type: array items: type: string upstream_id_token_header: description: The upstream id token header. type: string upstream_id_token_jwk_header: description: The upstream id token JWK header. type: string upstream_introspection_header: description: The upstream introspection header. type: string upstream_introspection_jwt_header: description: The upstream introspection JWT header. type: string upstream_refresh_token_header: description: The upstream refresh token header. type: string upstream_session_id_header: description: The upstream session id header. type: string upstream_user_info_header: description: The upstream user info header. type: string upstream_user_info_jwt_header: description: The upstream user info JWT header (in case the user info returns a JWT response). type: string userinfo_accept: description: 'The value of `Accept` header for user info requests: - `application/json`: user info response as JSON - `application/jwt`: user info response as JWT (from the obsolete IETF draft document).' type: string enum: - application/json - application/jwt userinfo_endpoint: description: The user info endpoint. If set it overrides the value in `userinfo_endpoint` returned by the discovery endpoint. type: string userinfo_headers_client: description: Extra headers passed from the client to the user info endpoint. type: array items: type: string userinfo_headers_names: description: Extra header names passed to the user info endpoint. type: array items: type: string userinfo_headers_values: description: Extra header values passed to the user info endpoint. type: array items: type: string userinfo_query_args_client: description: Extra query arguments passed from the client to the user info endpoint. type: array items: type: string userinfo_query_args_names: description: Extra query argument names passed to the user info endpoint. type: array items: type: string userinfo_query_args_values: description: Extra query argument values passed to the user info endpoint. type: array items: type: string using_pseudo_issuer: description: 'If the plugin uses a pseudo issuer. When set to true, the plugin will not discover the configuration from the issuer URL specified with `config.issuer`.' type: boolean verify_claims: description: Verify tokens for standard claims. type: boolean verify_nonce: description: Verify nonce on authorization code flow. type: boolean verify_parameters: description: Verify plugin configuration against discovery. type: boolean verify_signature: description: Verify signature of tokens. type: boolean required: - issuer shorthand_fields: authorization_cookie_httponly: type: boolean authorization_cookie_lifetime: type: number authorization_cookie_samesite: type: string session_compressor: type: string session_cookie_httponly: type: boolean session_cookie_idletime: type: number session_cookie_lifetime: type: number session_cookie_maxsize: type: integer session_cookie_renew: type: number session_cookie_samesite: type: string session_memcache_host: type: string session_memcache_port: type: integer session_memcache_prefix: type: string session_memcache_socket: type: string session_redis_cluster_max_redirections: type: integer session_redis_cluster_nodes: items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object type: array session_redis_connect_timeout: type: integer session_redis_host: type: string session_redis_password: type: string session_redis_port: type: integer session_redis_prefix: type: string session_redis_read_timeout: type: integer session_redis_send_timeout: type: integer session_redis_server_name: type: string session_redis_socket: type: string session_redis_ssl: type: boolean session_redis_ssl_verify: type: boolean session_redis_username: type: string session_strategy: type: string name: type: string const: openid-connect protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config OpentelemetryPlugin: x-speakeasy-entity: GatewayPluginOpentelemetry allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/OpentelemetryPluginConfig' OpentelemetryPluginConfig: properties: config: type: object properties: batch_flush_delay: description: 'The delay, in seconds, between two consecutive batches.' type: integer batch_span_count: description: The number of spans to be sent in a single batch. type: integer connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 header_type: type: string enum: - aws - b3 - b3-single - datadog - gcp - ignore - instana - jaeger - ot - preserve - w3c headers: description: The custom headers to be added in the HTTP request sent to the OTLP server. This setting is useful for adding the authentication headers (token) for the APM backend. type: object additionalProperties: true http_response_header_for_traceid: type: string logs_endpoint: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string propagation: type: object properties: clear: description: 'Header names to clear after context extraction. This allows to extract the context from a certain header and then remove it from the request, useful when extraction and injection are performed on different header formats and the original header should not be sent to the upstream. If left empty, no headers are cleared.' type: array items: type: string default_format: description: 'The default header format to use when extractors did not match any format in the incoming headers and `inject` is configured with the value: `preserve`. This can happen when no tracing header was found in the request, or the incoming tracing header formats were not included in `extract`.' type: string enum: - aws - b3 - b3-single - datadog - gcp - instana - jaeger - ot - w3c extract: description: 'Header formats used to extract tracing context from incoming requests. If multiple values are specified, the first one found will be used for extraction. If left empty, Kong will not extract any tracing context information from incoming requests and generate a trace with no parent and a new trace ID.' type: array items: enum: - aws - b3 - datadog - gcp - instana - jaeger - ot - w3c type: string inject: description: 'Header formats used to inject tracing context. The value `preserve` will use the same header format as the incoming request. If multiple values are specified, all of them will be used during injection. If left empty, Kong will not inject any tracing context information in outgoing requests.' type: array items: enum: - aws - b3 - b3-single - datadog - gcp - instana - jaeger - ot - preserve - w3c type: string queue: type: object properties: concurrency_limit: description: The number of of queue delivery timers. -1 indicates unlimited. type: integer enum: - -1 - 1 initial_retry_delay: description: Time in seconds before the initial retry is made for a failing batch. type: number maximum: 1000000 minimum: 0.001 max_batch_size: description: Maximum number of entries that can be processed at a time. type: integer maximum: 1000000 minimum: 1 max_bytes: description: 'Maximum number of bytes that can be waiting on a queue, requires string content.' type: integer max_coalescing_delay: description: Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler. type: number maximum: 3600 minimum: 0 max_entries: description: Maximum number of entries that can be waiting on the queue. type: integer maximum: 1000000 minimum: 1 max_retry_delay: description: 'Maximum time in seconds between retries, caps exponential backoff.' type: number maximum: 1000000 minimum: 0.001 max_retry_time: description: Time in seconds before the queue gives up calling a failed handler for a batch. type: number read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 resource_attributes: type: object additionalProperties: true sampling_rate: description: 'Tracing sampling rate for configuring the probability-based sampler. When set, this value supersedes the global `tracing_sampling_rate` setting from kong.conf.' type: number maximum: 1 minimum: 0 sampling_strategy: description: 'The sampling strategy to use for OTLP `traces`. Set `parent_drop_probability_fallback` if you want parent-based sampling when the parent span contains a `false` sampled flag, and fallback to probability-based sampling otherwise. Set `parent_probability_fallback` if you want parent-based sampling when the parent span contains a valid sampled flag (`true` or `false`), and fallback to probability-based sampling otherwise.' type: string enum: - parent_drop_probability_fallback - parent_probability_fallback send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 traces_endpoint: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string shorthand_fields: endpoint: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: opentelemetry protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false Partial: x-speakeasy-entity: GatewayPartial type: object discriminator: mapping: redis-ce: '#/components/schemas/PartialRedisCe' redis-ee: '#/components/schemas/PartialRedisEe' propertyName: type oneOf: - $ref: '#/components/schemas/PartialRedisCe' - $ref: '#/components/schemas/PartialRedisEe' PartialRedisCe: type: object properties: config: type: object properties: database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true name: description: A unique string representing a UTF-8 encoded name. type: string nullable: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true type: type: string const: redis-ce updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true example: config: database: 0 host: localhost password: password port: 6379 server_name: redis ssl: false ssl_verify: false timeout: 2000 username: username type: redis-ce additionalProperties: false required: - type - config PartialRedisEe: type: object properties: config: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer type: object connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer type: object sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - master - slave - any sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true name: description: A unique string representing a UTF-8 encoded name. type: string nullable: true tags: description: A set of strings representing tags. type: array items: description: A string representing a tag. type: string nullable: true type: type: string const: redis-ee updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true example: config: cluster_nodes: - ip: 192.168.1.10 port: 6380 connect_timeout: 2000 database: 0 host: localhost keepalive_pool_size: 256 password: password port: 6379 read_timeout: 1000 send_timeout: 1000 sentinel_nodes: - host: sentinel1.redis.server port: 26379 server_name: redis-ee ssl: false ssl_verify: false username: username type: redis-ee additionalProperties: false required: - type - config Plugin: description: 'A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.' 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 additionalProperties: true 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.). Leave unset for the plugin to activate regardless of the authenticated Consumer.' type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified group has been authenticated' type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false created_at: description: Unix epoch when the resource was created. type: integer nullable: true enabled: description: Whether the plugin is applied. type: boolean nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true instance_name: description: A unique string representing a UTF-8 encoded name. type: string nullable: true 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 nullable: true properties: after: type: object properties: access: type: array items: type: string before: type: object properties: access: type: array items: type: string 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: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string default: - grpc - grpcs - http - https 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.' type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false 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 default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false tags: description: An optional set of strings associated with the Plugin for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true 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 additionalProperties: false required: - name PluginBase: description: 'A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.' type: object properties: created_at: description: Unix epoch when the resource was created. type: integer nullable: true enabled: description: Whether the plugin is applied. type: boolean nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true instance_name: description: A unique string representing a UTF-8 encoded name. type: string nullable: true 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 nullable: true properties: after: type: object properties: access: type: array items: type: string before: type: object properties: access: type: array items: type: string partials: description: A list of partials to be used by the plugin. type: array items: properties: id: description: A string representing a UUID (universally unique identifier). type: string name: description: A unique string representing a UTF-8 encoded name. type: string path: type: string type: object nullable: true tags: description: An optional set of strings associated with the Plugin for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true additionalProperties: false required: - name PostFunctionPlugin: x-speakeasy-entity: GatewayPluginPostFunction allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/PostFunctionPluginConfig' PostFunctionPluginConfig: properties: config: type: object properties: access: type: array items: type: string body_filter: type: array items: type: string certificate: type: array items: type: string header_filter: type: array items: type: string log: type: array items: type: string rewrite: type: array items: type: string ws_client_frame: type: array items: type: string ws_close: type: array items: type: string ws_handshake: type: array items: type: string ws_upstream_frame: type: array items: type: string name: type: string const: post-function protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false PreFunctionPlugin: x-speakeasy-entity: GatewayPluginPreFunction allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/PreFunctionPluginConfig' PreFunctionPluginConfig: properties: config: type: object properties: access: type: array items: type: string body_filter: type: array items: type: string certificate: type: array items: type: string header_filter: type: array items: type: string log: type: array items: type: string rewrite: type: array items: type: string ws_client_frame: type: array items: type: string ws_close: type: array items: type: string ws_handshake: type: array items: type: string ws_upstream_frame: type: array items: type: string name: type: string const: pre-function protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false PrometheusPlugin: x-speakeasy-entity: GatewayPluginPrometheus allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/PrometheusPluginConfig' PrometheusPluginConfig: properties: config: type: object properties: ai_metrics: description: 'A boolean value that determines if ai metrics should be collected. If enabled, the `ai_llm_requests_total`, `ai_llm_cost_total` and `ai_llm_tokens_total` metrics will be exported.' type: boolean bandwidth_metrics: description: 'A boolean value that determines if bandwidth metrics should be collected. If enabled, `bandwidth_bytes` and `stream_sessions_total` metrics will be exported.' type: boolean latency_metrics: description: 'A boolean value that determines if latency metrics should be collected. If enabled, `kong_latency_ms`, `upstream_latency_ms` and `request_latency_ms` metrics will be exported.' type: boolean per_consumer: description: 'A boolean value that determines if per-consumer metrics should be collected. If enabled, the `kong_http_requests_total` and `kong_bandwidth_bytes` metrics fill in the consumer label when available.' type: boolean status_code_metrics: description: 'A boolean value that determines if status code metrics should be collected. If enabled, `http_requests_total`, `stream_sessions_total` metrics will be exported.' type: boolean upstream_health_metrics: description: 'A boolean value that determines if upstream metrics should be collected. If enabled, `upstream_target_health` metric will be exported.' type: boolean wasm_metrics: description: A boolean value that determines if Wasm metrics should be collected. type: boolean 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: prometheus protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false ProxyCacheAdvancedPlugin: x-speakeasy-entity: GatewayPluginProxyCacheAdvanced allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/ProxyCacheAdvancedPluginConfig' ProxyCacheAdvancedPluginConfig: properties: config: type: object properties: bypass_on_err: description: 'Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with `Bypass`, with the request going upstream.' type: boolean cache_control: description: 'When enabled, respect the Cache-Control behaviors defined in RFC7234.' type: boolean cache_ttl: description: TTL in seconds of cache entities. type: integer minimum: 0 content_type: description: 'Upstream response content types considered cacheable. The plugin performs an **exact match** against each specified value; for example, if the upstream is expected to respond with a `application/json; charset=utf-8` content-type, the plugin configuration must contain said value or a `Bypass` cache status is returned.' type: array items: type: string ignore_uri_case: description: 'Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.' type: boolean memory: type: object properties: dictionary_name: description: The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template. type: string redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer request_method: description: 'Downstream request methods considered cacheable. Available options: `HEAD`, `GET`, `POST`, `PATCH`, `PUT`.' type: array items: enum: - GET - HEAD - PATCH - POST - PUT type: string response_code: description: Upstream response status code considered cacheable. The integers must be a value between 100 and 900. type: array items: maximum: 900 minimum: 100 type: integer minLength: 1 response_headers: description: Caching related diagnostic headers that should be included in cached responses type: object properties: X-Cache-Key: type: boolean X-Cache-Status: type: boolean age: type: boolean storage_ttl: description: Number of seconds to keep resources in the storage backend. This value is independent of `cache_ttl` or resource TTLs defined by Cache-Control behaviors. type: integer strategy: description: 'The backing data store in which to hold cache entities. Accepted values are: `memory` and `redis`.' type: string enum: - memory - redis vary_headers: description: 'Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.' type: array items: type: string vary_query_params: description: 'Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration. By default, the max number of params accepted is 100. You can change this value via the `lua_max_post_args` in `kong.conf`.' type: array items: type: string required: - strategy 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: proxy-cache-advanced protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config ProxyCachePlugin: x-speakeasy-entity: GatewayPluginProxyCache allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/ProxyCachePluginConfig' ProxyCachePluginConfig: properties: config: type: object properties: cache_control: description: 'When enabled, respect the Cache-Control behaviors defined in RFC7234.' type: boolean cache_ttl: description: 'TTL, in seconds, of cache entities.' type: integer minimum: 0 content_type: description: Upstream response content types considered cacheable. The plugin performs an **exact match** against each specified value. type: array items: type: string ignore_uri_case: type: boolean memory: type: object properties: dictionary_name: description: The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template. type: string request_method: description: Downstream request methods considered cacheable. type: array items: enum: - GET - HEAD - PATCH - POST - PUT type: string response_code: description: Upstream response status code considered cacheable. type: array items: maximum: 900 minimum: 100 type: integer minLength: 1 response_headers: description: Caching related diagnostic headers that should be included in cached responses type: object properties: X-Cache-Key: type: boolean X-Cache-Status: type: boolean age: type: boolean storage_ttl: description: Number of seconds to keep resources in the storage backend. This value is independent of `cache_ttl` or resource TTLs defined by Cache-Control behaviors. type: integer strategy: description: The backing data store in which to hold cache entities. type: string enum: - memory vary_headers: description: 'Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.' type: array items: type: string vary_query_params: description: 'Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.' type: array items: type: string required: - strategy 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: proxy-cache protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config RateLimitingAdvancedPlugin: x-speakeasy-entity: GatewayPluginRateLimitingAdvanced allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/RateLimitingAdvancedPluginConfig' RateLimitingAdvancedPluginConfig: properties: config: type: object properties: compound_identifier: description: 'Similar to `identifer`, but supports combining multiple items. The priority of `compound_identifier` is higher than `identifier`, which means if `compound_identifer` is set, it will be used, otherwise `identifier` will be used.' type: array items: enum: - consumer - consumer-group - credential - header - ip - path - service type: string consumer_groups: description: List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if `enforce_consumer_groups` is set to `true`. type: array items: type: string dictionary_name: description: 'The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is `config.strategy` is `cluster` or `redis` and `config.sync_rate` isn''t `-1`), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.' type: string disable_penalty: description: 'If set to `true`, this doesn''t count denied requests (status = `429`). If set to `false`, all requests, including denied ones, are counted. This parameter only affects the `sliding` window_type.' type: boolean enforce_consumer_groups: description: 'Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping `enforce_consumer_groups` from `true` to `false` disables the group override, but does not clear the list of consumer groups. You can then flip `enforce_consumer_groups` to `true` to re-enforce the groups.' type: boolean error_code: description: Set a custom error code to return when the rate limit is exceeded. type: number minimum: 0 error_message: description: Set a custom error message to return when the rate limit is exceeded. type: string header_name: description: A string representing an HTTP header name. type: string hide_client_headers: description: Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters. type: boolean identifier: description: 'The type of identifier used to generate the rate limit key. Defines the scope used to increment the rate limiting counters. Can be `ip`, `credential`, `consumer`, `service`, `header`, `path` or `consumer-group`. Note if `identifier` is `consumer-group`, the plugin must be applied on a consumer group entity. Because a consumer may belong to multiple consumer groups, the plugin needs to know explicitly which consumer group to limit the rate.' type: string enum: - consumer - consumer-group - credential - header - ip - path - service limit: description: One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified. type: array items: type: number lock_dictionary_name: description: The shared dictionary where concurrency control locks are stored. The default shared dictionary is `kong_locks`. The shared dictionary should be declare in nginx-kong.conf. type: string namespace: description: 'The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. `strategy`, `redis`, `sync_rate`, `dictionary_name`, need to be the same.' type: string path: description: 'A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).' type: string redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 redis_proxy_type: description: 'If the `connection_is_proxied` is enabled, this field indicates the proxy type and version you are using. For example, you can enable this optioin when you want authentication between Kong and Envoy proxy.' type: string enum: - envoy_v1.31 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer retry_after_jitter_max: description: 'The upper bound of a jitter (random delay) in seconds to be added to the `Retry-After` header of denied requests (status = `429`) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is `0`; in this case, the `Retry-After` header is equal to the `RateLimit-Reset` header.' type: number strategy: description: 'The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: `local` and `cluster`.' type: string enum: - cluster - local - redis sync_rate: description: How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms). type: number window_size: description: One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified. type: array items: type: number window_type: description: 'Sets the time window type to either `sliding` (default) or `fixed`. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window''s counters.' type: string enum: - fixed - sliding required: - limit - window_size 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: rate-limiting-advanced protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config RateLimitingPlugin: x-speakeasy-entity: GatewayPluginRateLimiting allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/RateLimitingPluginConfig' RateLimitingPluginConfig: properties: config: type: object properties: day: description: The number of HTTP requests that can be made per day. type: number minimum: 0 error_code: description: Set a custom error code to return when the rate limit is exceeded. type: number minimum: 0 error_message: description: Set a custom error message to return when the rate limit is exceeded. type: string fault_tolerant: description: 'A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party data store. If `true`, requests will be proxied anyway, effectively disabling the rate-limiting function until the data store is working again. If `false`, then the clients will see `500` errors.' type: boolean header_name: description: A string representing an HTTP header name. type: string hide_client_headers: description: Optionally hide informative response headers. type: boolean hour: description: The number of HTTP requests that can be made per hour. type: number minimum: 0 limit_by: description: The entity that is used when aggregating the limits. type: string enum: - consumer - consumer-group - credential - header - ip - path - service minute: description: The number of HTTP requests that can be made per minute. type: number minimum: 0 month: description: The number of HTTP requests that can be made per month. type: number minimum: 0 path: description: 'A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).' type: string policy: description: The rate-limiting policies to use for retrieving and incrementing the limits. type: string enum: - cluster - local - redis redis: description: Redis configuration type: object properties: database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string second: description: The number of HTTP requests that can be made per second. type: number minimum: 0 sync_rate: description: How often to sync counter data to the central data store. A value of -1 results in synchronous behavior. type: number year: description: The number of HTTP requests that can be made per year. type: number minimum: 0 shorthand_fields: redis_database: type: integer redis_host: type: string redis_password: minLength: 0 type: string redis_port: type: integer redis_server_name: type: string redis_ssl: type: boolean redis_ssl_verify: type: boolean redis_timeout: type: integer redis_username: type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: rate-limiting protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false RedirectPlugin: x-speakeasy-entity: GatewayPluginRedirect allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/RedirectPluginConfig' RedirectPluginConfig: properties: config: type: object properties: keep_incoming_path: description: Use the incoming request's path and query string in the redirect URL type: boolean location: description: The URL to redirect to type: string status_code: description: The response code to send. Must be an integer between 100 and 599. type: integer maximum: 599 minimum: 100 required: - location 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: redirect protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config RequestCalloutPlugin: x-speakeasy-entity: GatewayPluginRequestCallout allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/RequestCalloutPluginConfig' RequestCalloutPluginConfig: properties: config: type: object properties: cache: description: Plugin global caching configuration. type: object properties: cache_ttl: description: TTL in seconds of cache entities. type: integer minimum: 0 memory: type: object properties: dictionary_name: description: The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template. type: string redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer strategy: description: 'The backing data store in which to hold cache entities. Accepted values are: `off`, `memory`, and `redis`.' type: string enum: - memory - 'off' - redis callouts: description: 'A collection of callout objects, where each object represents an HTTP request made in the context of a proxy request.' type: array items: properties: cache: description: Callout caching configuration. type: object properties: bypass: description: 'If `true`, skips caching the callout response.' type: boolean depends_on: description: An array of callout names the current callout depends on. This dependency list determines the callout execution order via a topological sorting algorithm. type: array items: type: string name: description: A string identifier for a callout. A callout object is referenceable via its name in the `kong.ctx.shared.callouts.` type: string request: description: The customizations for the callout request. type: object properties: body: description: Callout request body customizations. type: object properties: custom: description: The custom body fields to be added to the callout HTTP request. Values can contain Lua expressions in the form $(some_lua_expression). The syntax is based on `request-transformer-advanced` templates. type: object additionalProperties: true decode: description: 'If `true`, decodes the request''s body and make it available for customizations. Only JSON content type is supported.' type: boolean forward: description: 'If `true`, forwards the incoming request''s body to the callout request.' type: boolean by_lua: description: Lua code that executes before the callout request is made. **Warning** can impact system behavior. Standard Lua sandboxing restrictions apply. type: string error: description: The error handling policy the plugin will apply to TCP and HTTP errors. type: object properties: error_response_code: description: The error code to respond with if `on_error` is `fail` or if `retries` is achieved. type: integer error_response_msg: description: The error mesasge to respond with if `on_error` is set to `fail` or if `retries` is achieved. Templating with Lua expressions is supported. type: string http_statuses: description: The list of HTTP status codes considered errors under the error handling policy. type: array items: maximum: 999 minimum: 100 type: integer on_error: type: string enum: - continue - fail - retry retries: description: The number of retries the plugin will attempt on TCP and HTTP errors if `on_error` is set to `retry`. type: integer headers: description: Callout request header customizations. type: object properties: custom: description: The custom headers to be added in the callout HTTP request. Values can contain Lua expressions in the form `$(some_lua_expression)`. The syntax is based on `request-transformer-advanced` templates. type: object additionalProperties: true forward: description: 'If `true`, forwards the incoming request''s headers to the callout request. ' type: boolean http_opts: description: HTTP connection parameters. type: object properties: proxy: description: Proxy settings. type: object properties: auth_password: description: 'The password to authenticate with, if the forward proxy is protected by basic authentication.' type: string auth_username: description: 'The username to authenticate with, if the forward proxy is protected by basic authentication.' type: string http_proxy: description: The HTTP proxy URL. This proxy server will be used for HTTP requests. type: string https_proxy: description: The HTTPS proxy URL. This proxy server will be used for HTTPS requests. type: string ssl_server_name: description: The SNI used in the callout request. Defaults to host if omitted. type: string ssl_verify: description: 'If set to `true`, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean timeouts: description: Socket timeouts in milliseconds. All or none must be set. type: object properties: connect: description: The socket connect timeout. type: integer maximum: 2147483646 minimum: 0 read: description: 'The socket read timeout. ' type: integer maximum: 2147483646 minimum: 0 write: description: The socket write timeout. type: integer maximum: 2147483646 minimum: 0 method: description: The HTTP method that will be requested. type: string pattern: '^[A-Z]+$' query: description: Callout request query param customizations. type: object properties: custom: description: The custom query params to be added in the callout HTTP request. Values can contain Lua expressions in the form `$(some_lua_expression)`. The syntax is based on `request-transformer-advanced` templates. type: object additionalProperties: true forward: description: 'If `true`, forwards the incoming request''s query params to the callout request. ' type: boolean url: description: The URL that will be requested. type: string required: - body - error - headers - http_opts - query - url response: description: Configurations of callout response handling. type: object properties: body: type: object properties: decode: description: 'If `true`, decodes the response body before storing into the context. Only JSON is supported.' type: boolean store: description: 'If `false`, skips storing the callout response body into kong.ctx.shared.callouts..response.body.' type: boolean by_lua: description: 'Lua code that executes after the callout response is received, before caching takes place. Can produce side effects. Standard Lua sandboxing restrictions apply.' type: string headers: description: Callout response header customizations. type: object properties: store: description: 'If `false`, skips storing the callout response headers into kong.ctx.shared.callouts..response.headers.' type: boolean required: - body - headers required: - cache - name - request - response type: object upstream: description: Customizations to the upstream request. type: object properties: body: description: Callout request body customizations. type: object properties: custom: description: The custom body fields to be added in the upstream request body. Values can contain Lua expressions in the form $(some_lua_expression). The syntax is based on `request-transformer-advanced` templates. type: object additionalProperties: true decode: description: 'If `true`, decodes the request''s body to make it available for upstream by_lua customizations. Only JSON content type is supported.' type: boolean forward: description: 'If `false`, skips forwarding the incoming request''s body to the upstream request.' type: boolean by_lua: description: Lua code that executes before the upstream request is made. Can produce side effects. Standard Lua sandboxing restrictions apply. type: string headers: description: Callout request header customizations. type: object properties: custom: description: The custom headers to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_expression). The syntax is based on `request-transformer-advanced` templates. type: object additionalProperties: true forward: description: 'If `false`, does not forward request headers to upstream request.' type: boolean query: description: Upstream request query param customizations. type: object properties: custom: description: The custom query params to be added in the upstream HTTP request. Values can contain Lua expressions in the form `$(some_lua_expression)`. The syntax is based on `request-transformer-advanced` templates. type: object additionalProperties: true forward: description: 'If `false`, does not forward request query params to upstream request.' type: boolean required: - callouts 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: request-callout protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config RequestSizeLimitingPlugin: x-speakeasy-entity: GatewayPluginRequestSizeLimiting allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/RequestSizeLimitingPluginConfig' RequestSizeLimitingPluginConfig: properties: config: type: object properties: allowed_payload_size: description: Allowed request payload size in megabytes. Default is `128` megabytes (128000000 bytes). type: integer require_content_length: description: Set to `true` to ensure a valid `Content-Length` header exists before reading the request body. type: boolean size_unit: description: 'Size unit can be set either in `bytes`, `kilobytes`, or `megabytes` (default). This configuration is not available in versions prior to Kong Gateway 1.3 and Kong Gateway (OSS) 2.0.' type: string enum: - bytes - kilobytes - megabytes 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: request-size-limiting protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false RequestTerminationPlugin: x-speakeasy-entity: GatewayPluginRequestTermination allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/RequestTerminationPluginConfig' RequestTerminationPluginConfig: properties: config: type: object properties: body: description: The raw response body to send. This is mutually exclusive with the `config.message` field. type: string content_type: description: Content type of the raw response configured with `config.body`. type: string echo: description: 'When set, the plugin will echo a copy of the request back to the client. The main usecase for this is debugging. It can be combined with `trigger` in order to debug requests on live systems without disturbing real traffic.' type: boolean message: description: 'The message to send, if using the default response generator.' type: string status_code: description: The response code to send. Must be an integer between 100 and 599. type: integer maximum: 599 minimum: 100 trigger: description: A string representing an HTTP header name. type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: request-termination protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false RequestTransformerAdvancedPlugin: x-speakeasy-entity: GatewayPluginRequestTransformerAdvanced allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/RequestTransformerAdvancedPluginConfig' RequestTransformerAdvancedPluginConfig: properties: config: type: object properties: add: type: object properties: body: type: array items: type: string headers: type: array items: type: string json_types: type: array items: enum: - boolean - number - string type: string querystring: type: array items: type: string allow: type: object properties: body: type: array items: type: string append: type: object properties: body: type: array items: type: string headers: type: array items: type: string json_types: type: array items: enum: - boolean - number - string type: string querystring: type: array items: type: string dots_in_keys: description: 'Specify whether dots (for example, `customers.info.phone`) should be treated as part of a property name or used to descend into nested JSON objects. See [Arrays and nested objects](#arrays-and-nested-objects).' type: boolean http_method: description: 'A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.' type: string pattern: '^[A-Z]+$' remove: type: object properties: body: type: array items: type: string headers: type: array items: type: string querystring: type: array items: type: string rename: type: object properties: body: type: array items: type: string headers: type: array items: type: string querystring: type: array items: type: string replace: type: object properties: body: type: array items: type: string headers: type: array items: type: string json_types: type: array items: enum: - boolean - number - string type: string querystring: type: array items: type: string uri: type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: request-transformer-advanced protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false RequestTransformerPlugin: x-speakeasy-entity: GatewayPluginRequestTransformer allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/RequestTransformerPluginConfig' RequestTransformerPluginConfig: properties: config: type: object properties: add: type: object properties: body: type: array items: type: string headers: type: array items: pattern: '^[^:]+:.*$' type: string querystring: type: array items: type: string append: type: object properties: body: type: array items: type: string headers: type: array items: pattern: '^[^:]+:.*$' type: string querystring: type: array items: type: string http_method: description: 'A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.' type: string pattern: '^[A-Z]+$' remove: type: object properties: body: type: array items: type: string headers: type: array items: type: string querystring: type: array items: type: string rename: type: object properties: body: type: array items: type: string headers: type: array items: pattern: '^[^:]+:.*$' type: string querystring: type: array items: type: string replace: type: object properties: body: type: array items: type: string headers: type: array items: pattern: '^[^:]+:.*$' type: string querystring: type: array items: type: string uri: type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: request-transformer protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false RequestValidatorPlugin: x-speakeasy-entity: GatewayPluginRequestValidator allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/RequestValidatorPluginConfig' RequestValidatorPluginConfig: properties: config: type: object properties: allowed_content_types: description: 'List of allowed content types. The value can be configured with the `charset` parameter. For example, `application/json; charset=UTF-8`.' type: array items: type: string body_schema: description: The request body schema specification. One of `body_schema` or `parameter_schema` must be specified. type: string content_type_parameter_validation: description: Determines whether to enable parameters validation of request content-type. type: boolean parameter_schema: description: Array of parameter validator specification. One of `body_schema` or `parameter_schema` must be specified. type: array items: properties: explode: description: 'Required when `schema` and `style` are set. When `explode` is `true`, parameter values of type `array` or `object` generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters, this property has no effect.' type: boolean in: description: The location of the parameter. type: string enum: - header - path - query name: description: 'The name of the parameter. Parameter names are case-sensitive, and correspond to the parameter name used by the `in` property. If `in` is `path`, the `name` field MUST correspond to the named capture group from the configured `route`.' type: string required: description: Determines whether this parameter is mandatory. type: boolean schema: description: 'Required when `style` and `explode` are set. This is the schema defining the type used for the parameter. It is validated using `draft4` for JSON Schema draft 4 compliant validator. In addition to being a valid JSON Schema, the parameter schema MUST have a top-level `type` property to enable proper deserialization before validating.' type: string style: description: Required when `schema` and `explode` are set. Describes how the parameter value will be deserialized depending on the type of the parameter value. type: string enum: - deepObject - form - label - matrix - pipeDelimited - simple - spaceDelimited required: - in - name - required type: object verbose_response: description: 'If enabled, the plugin returns more verbose and detailed validation errors.' type: boolean version: description: 'Which validator to use. Supported values are `kong` (default) for using Kong''s own schema validator, or `draft4`, `draft7`, `draft201909`, and `draft202012` for using their respective JSON Schema Draft compliant validators.' type: string enum: - draft201909 - draft202012 - draft4 - draft6 - draft7 - kong 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: request-validator protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false ResponseRatelimitingPlugin: x-speakeasy-entity: GatewayPluginResponseRatelimiting allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/ResponseRatelimitingPluginConfig' ResponseRatelimitingPluginConfig: properties: config: type: object properties: block_on_first_violation: description: A boolean value that determines if the requests should be blocked as soon as one limit is being exceeded. This will block requests that are supposed to consume other limits too. type: boolean fault_tolerant: description: 'A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party datastore. If `true`, requests will be proxied anyway, effectively disabling the rate-limiting function until the datastore is working again. If `false`, then the clients will see `500` errors.' type: boolean header_name: description: The name of the response header used to increment the counters. type: string hide_client_headers: description: Optionally hide informative response headers. type: boolean limit_by: description: 'The entity that will be used when aggregating the limits: `consumer`, `credential`, `ip`. If the `consumer` or the `credential` cannot be determined, the system will always fallback to `ip`.' type: string enum: - consumer - credential - ip limits: description: A map that defines rate limits for the plugin. type: object additionalProperties: true minLength: 1 policy: description: The rate-limiting policies to use for retrieving and incrementing the limits. type: string enum: - cluster - local - redis redis: description: Redis configuration type: object properties: database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: redis_database: type: integer redis_host: type: string redis_password: minLength: 0 type: string redis_port: type: integer redis_server_name: type: string redis_ssl: type: boolean redis_ssl_verify: type: boolean redis_timeout: type: integer redis_username: type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: response-ratelimiting protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false ResponseTransformerAdvancedPlugin: x-speakeasy-entity: GatewayPluginResponseTransformerAdvanced allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/ResponseTransformerAdvancedPluginConfig' ResponseTransformerAdvancedPluginConfig: properties: config: type: object properties: add: type: object properties: headers: type: array items: type: string if_status: type: array items: type: string json: type: array items: type: string json_types: type: array items: enum: - boolean - number - string type: string allow: type: object properties: json: type: array items: type: string append: type: object properties: headers: type: array items: type: string if_status: type: array items: type: string json: type: array items: type: string json_types: type: array items: enum: - boolean - number - string type: string dots_in_keys: description: 'Whether dots (for example, `customers.info.phone`) should be treated as part of a property name or used to descend into nested JSON objects..' type: boolean remove: type: object properties: headers: type: array items: type: string if_status: type: array items: type: string json: type: array items: type: string rename: type: object properties: headers: type: array items: pattern: '^[^:]+:.*$' type: string if_status: type: array items: type: string replace: type: object properties: body: description: String with which to replace the entire response body. type: string headers: type: array items: type: string if_status: type: array items: type: string json: type: array items: type: string json_types: type: array items: enum: - boolean - number - string type: string transform: type: object properties: functions: type: array items: type: string if_status: type: array items: type: string json: type: array items: type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: response-transformer-advanced protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false ResponseTransformerPlugin: x-speakeasy-entity: GatewayPluginResponseTransformer allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/ResponseTransformerPluginConfig' ResponseTransformerPluginConfig: properties: config: type: object properties: add: type: object properties: headers: type: array items: pattern: '^[^:]+:.*$' type: string json: type: array items: pattern: '^[^:]+:.*$' type: string json_types: description: |- List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string. type: array items: enum: - boolean - number - string type: string append: type: object properties: headers: type: array items: pattern: '^[^:]+:.*$' type: string json: type: array items: pattern: '^[^:]+:.*$' type: string json_types: description: |- List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string. type: array items: enum: - boolean - number - string type: string remove: type: object properties: headers: type: array items: type: string json: type: array items: type: string rename: type: object properties: headers: type: array items: pattern: '^[^:]+:.*$' type: string json: type: array items: pattern: '^[^:]+:.*$' type: string replace: type: object properties: headers: type: array items: pattern: '^[^:]+:.*$' type: string json: type: array items: pattern: '^[^:]+:.*$' type: string json_types: description: |- List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string. type: array items: enum: - boolean - number - string type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: response-transformer protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false RouteByHeaderPlugin: x-speakeasy-entity: GatewayPluginRouteByHeader allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/RouteByHeaderPluginConfig' RouteByHeaderPluginConfig: properties: config: type: object properties: rules: description: Route by header rules. type: array items: properties: condition: type: object additionalProperties: true minLength: 1 upstream_name: type: string required: - condition - upstream_name 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: route-by-header protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false RouteExpression: x-speakeasy-entity: GatewayRouteExpression description: 'Route 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. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.' type: object properties: created_at: description: Unix epoch when the resource was created. type: integer nullable: true expression: description: Use Router Expression to perform route match. This option is only available when `router_flavor` is set to `expressions`. type: string nullable: true 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 enum: - 426 - 301 - 302 - 307 - 308 nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true 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 nullable: true 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 enum: - v0 - v1 nullable: true 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 nullable: true priority: description: 'A number used to specify the matching order for expression routes. The higher the `priority`, the sooner an route will be evaluated. This field is ignored unless `expression` field is set.' type: integer nullable: true 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: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string default: - http - https nullable: 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.' type: boolean nullable: 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 nullable: true service: description: The Service this Route is associated to. This is where the Route proxies traffic to. type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false strip_path: description: 'When matching a Route via one of the `paths`, strip the matching prefix from the upstream request URL.' type: boolean nullable: true tags: description: An optional set of strings associated with the Route for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true additionalProperties: false RouteJson: x-speakeasy-entity: GatewayRoute description: 'Route 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. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.' type: object properties: created_at: description: Unix epoch when the resource was created. type: integer nullable: true 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: properties: ip: description: 'A string representing an IP address or CIDR block, such as 192.168.1.1 or 192.168.0.0/16.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer type: object nullable: true 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 additionalProperties: items: type: string type: array nullable: true hosts: description: A list of domain names that match this Route. Note that the hosts value is case sensitive. type: array items: type: string nullable: true 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 enum: - 426 - 301 - 302 - 307 - 308 nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true methods: description: A list of HTTP methods that match this Route. type: array items: description: 'A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.' type: string nullable: true 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 nullable: true 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 enum: - v0 - v1 nullable: true paths: description: A list of paths that match this Route. type: array items: description: 'A string representing a router path. It must start with a forward slash (''/'') for a fixed path, or the sequence ''~/'' for a regex path. It must not have empty segments.' type: string nullable: true 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 nullable: true 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: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string default: - http - https nullable: true 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 nullable: 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.' type: boolean nullable: 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 nullable: true service: description: The Service this Route is associated to. This is where the Route proxies traffic to. type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false snis: description: A list of SNIs that match this Route when using stream routing. type: array items: description: 'A string representing a wildcard host name, such as *.example.com.' type: string nullable: true 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: properties: ip: description: 'A string representing an IP address or CIDR block, such as 192.168.1.1 or 192.168.0.0/16.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer type: object nullable: true strip_path: description: 'When matching a Route via one of the `paths`, strip the matching prefix from the upstream request URL.' type: boolean nullable: true tags: description: An optional set of strings associated with the Route for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true 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 additionalProperties: false RouteTransformerAdvancedPlugin: x-speakeasy-entity: GatewayPluginRouteTransformerAdvanced allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/RouteTransformerAdvancedPluginConfig' RouteTransformerAdvancedPluginConfig: properties: config: type: object properties: escape_path: type: boolean host: type: string path: type: string port: type: string 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: route-transformer-advanced protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false SNI: x-speakeasy-entity: GatewaySNI 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 default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false created_at: description: Unix epoch when the resource was created. type: integer nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true name: description: The SNI name to associate with the given certificate. type: string tags: description: An optional set of strings associated with the SNIs for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true example: certificate: id: bd380f99-659d-415e-b0e7-72ea05df3218 id: 36c4566c-14cc-4132-9011-4139fcbbe50a name: some.example.org additionalProperties: false required: - name - certificate SamlPlugin: x-speakeasy-entity: GatewayPluginSaml allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/SamlPluginConfig' SamlPluginConfig: properties: config: type: object properties: anonymous: description: 'An optional string (consumer UUID or username) value to use as an “anonymous” consumer. If not set, a Kong Consumer must exist for the SAML IdP user credentials, mapping the username format to the Kong Consumer username.' type: string assertion_consumer_path: description: 'A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).' type: string idp_certificate: description: The public certificate provided by the IdP. This is used to validate responses from the IdP. Only include the contents of the certificate. Do not include the header (`BEGIN CERTIFICATE`) and footer (`END CERTIFICATE`) lines. type: string idp_sso_url: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string issuer: description: The unique identifier of the IdP application. Formatted as a URL containing information about the IdP so the SP can validate that the SAML assertions it receives are issued from the correct IdP. type: string nameid_format: description: 'The requested `NameId` format. Options available are: - `Unspecified` - `EmailAddress` - `Persistent` - `Transient`' type: string enum: - EmailAddress - Persistent - Transient - Unspecified redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 prefix: description: The Redis session key prefix. type: string read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string socket: description: The Redis unix socket path. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer request_digest_algorithm: description: 'The digest algorithm for Authn requests: - `SHA256` - `SHA1`' type: string enum: - SHA1 - SHA256 request_signature_algorithm: description: 'The signature algorithm for signing Authn requests. Options available are: - `SHA256` - `SHA384` - `SHA512`' type: string enum: - SHA256 - SHA384 - SHA512 request_signing_certificate: description: The certificate for signing requests. type: string request_signing_key: description: 'The private key for signing requests. If this parameter is set, requests sent to the IdP are signed. The `request_signing_certificate` parameter must be set as well.' type: string response_digest_algorithm: description: 'The algorithm for verifying digest in SAML responses: - `SHA256` - `SHA1`' type: string enum: - SHA1 - SHA256 response_encryption_key: description: The private encryption key required to decrypt encrypted assertions. type: string response_signature_algorithm: description: 'The algorithm for validating signatures in SAML responses. Options available are: - `SHA256` - `SHA384` - `SHA512`' type: string enum: - SHA256 - SHA384 - SHA512 session_absolute_timeout: description: The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid. type: number session_audience: description: 'The session audience, for example "my-application"' type: string session_cookie_domain: description: The session cookie domain flag. type: string session_cookie_http_only: description: 'Forbids JavaScript from accessing the cookie, for example, through the `Document.cookie` property.' type: boolean session_cookie_name: description: The session cookie name. type: string session_cookie_path: description: 'A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).' type: string session_cookie_same_site: description: 'Controls whether a cookie is sent with cross-origin requests, providing some protection against cross-site request forgery attacks.' type: string enum: - Default - Lax - None - Strict session_cookie_secure: description: 'The cookie is only sent to the server when a request is made with the https:scheme (except on localhost), and therefore is more resistant to man-in-the-middle attacks.' type: boolean session_enforce_same_subject: description: 'When set to `true`, audiences are forced to share the same subject.' type: boolean session_hash_storage_key: description: 'When set to `true`, the storage key (session ID) is hashed for extra security. Hashing the storage key means it is impossible to decrypt data from the storage without a cookie.' type: boolean session_hash_subject: description: 'When set to `true`, the value of subject is hashed before being stored. Only applies when `session_store_metadata` is enabled.' type: boolean session_idling_timeout: description: The session cookie idle time in seconds. type: number session_memcached_host: description: The memcached host. type: string session_memcached_port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 session_memcached_prefix: description: The memcached session key prefix. type: string session_memcached_socket: description: The memcached unix socket path. type: string session_remember: description: Enables or disables persistent sessions type: boolean session_remember_absolute_timeout: description: Persistent session absolute timeout in seconds. type: number session_remember_cookie_name: description: Persistent session cookie name type: string session_remember_rolling_timeout: description: Persistent session rolling timeout in seconds. type: number session_request_headers: type: array items: enum: - absolute-timeout - audience - id - idling-timeout - rolling-timeout - subject - timeout type: string session_response_headers: type: array items: enum: - absolute-timeout - audience - id - idling-timeout - rolling-timeout - subject - timeout type: string session_rolling_timeout: description: The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid. type: number session_secret: description: 'The session secret. This must be a random string of 32 characters from the base64 alphabet (letters, numbers, `/`, `_` and `+`). It is used as the secret key for encrypting session data as well as state information that is sent to the IdP in the authentication exchange.' type: string maxLength: 32 minLength: 32 pattern: '^[0-9a-zA-Z/_+]+$' session_storage: description: 'The session storage for session data: - `cookie`: stores session data with the session cookie. The session cannot be invalidated or revoked without changing the session secret, but is stateless, and doesn''t require a database. - `memcached`: stores session data in memcached - `redis`: stores session data in Redis' type: string enum: - cookie - memcache - memcached - redis session_store_metadata: description: Configures whether or not session metadata should be stored. This includes information about the active sessions for the `specific_audience` belonging to a specific subject. type: boolean validate_assertion_signature: description: Enable signature validation for SAML responses. type: boolean required: - assertion_consumer_path - idp_sso_url - issuer - session_secret shorthand_fields: session_auth_ttl: type: number session_compressor: type: string session_cookie_httponly: type: boolean session_cookie_idletime: type: number session_cookie_lifetime: type: number session_cookie_maxsize: type: integer session_cookie_renew: type: number session_cookie_samesite: type: string session_memcache_host: type: string session_memcache_port: type: integer session_memcache_prefix: type: string session_memcache_socket: type: string session_redis_cluster_max_redirections: type: integer session_redis_cluster_maxredirections: type: integer session_redis_cluster_nodes: items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object type: array session_redis_connect_timeout: type: integer session_redis_host: type: string session_redis_password: type: string session_redis_port: type: integer session_redis_prefix: type: string session_redis_read_timeout: type: integer session_redis_send_timeout: type: integer session_redis_server_name: type: string session_redis_socket: type: string session_redis_ssl: type: boolean session_redis_ssl_verify: type: boolean session_redis_username: type: string session_strategy: type: string name: type: string const: saml protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config Service: x-speakeasy-entity: GatewayService description: 'Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its `protocol`, `host`, `port` and `path` individually. Services are associated to Routes (a Service can have many Routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a Route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.' type: object properties: 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. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).' type: array items: type: string nullable: true client_certificate: description: Certificate to be used as client certificate while TLS handshaking to the upstream server. type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false connect_timeout: description: The timeout in milliseconds for establishing a connection to the upstream server. type: integer nullable: true created_at: description: Unix epoch when the resource was created. type: integer nullable: true 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 nullable: true host: description: The host of the upstream server. Note that the host value is case sensitive. type: string id: description: A string representing a UUID (universally unique identifier). type: string nullable: true name: description: The Service name. type: string nullable: true path: description: The path to be used in requests to the upstream server. type: string nullable: true port: description: The upstream server port. type: integer nullable: true protocol: description: The protocol used to communicate with the upstream. type: string enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss nullable: true read_timeout: description: The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. type: integer nullable: true retries: description: The number of retries to execute upon failure to proxy. type: integer nullable: true tags: description: An optional set of strings associated with the Service for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true tls_sans: type: object nullable: true properties: dnsnames: description: A dnsName for TLS verification. type: array items: description: A string representing an SNI (server name indication) value for TLS. type: string uris: description: An URI for TLS verification. type: array items: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string tls_verify: description: 'Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected.' type: boolean nullable: 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.' type: integer nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true url: description: 'Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses.' type: string writeOnly: true x-speakeasy-ignore: true write_timeout: description: The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. type: integer nullable: true example: host: example.internal id: 49fd316e-c457-481c-9fc7-8079153e4f3c name: example-service path: / port: 80 protocol: http additionalProperties: false required: - host ServiceProtectionPlugin: x-speakeasy-entity: GatewayPluginServiceProtection allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/ServiceProtectionPluginConfig' ServiceProtectionPluginConfig: properties: config: type: object properties: dictionary_name: description: 'The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is `config.strategy` is `cluster` or `redis` and `config.sync_rate` isn''t `-1`), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.' type: string disable_penalty: description: 'If set to `true`, this doesn''t count denied requests (status = `429`). If set to `false`, all requests, including denied ones, are counted. This parameter only affects the `sliding` window_type.' type: boolean error_code: description: Set a custom error code to return when the rate limit is exceeded. type: number minimum: 0 error_message: description: Set a custom error message to return when the rate limit is exceeded. type: string hide_client_headers: description: Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters. type: boolean limit: description: One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified. type: array items: type: number lock_dictionary_name: description: The shared dictionary where concurrency control locks are stored. The default shared dictionary is `kong_locks`. The shared dictionary should be declared in nginx-kong.conf. type: string namespace: description: 'The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. `strategy`, `redis`, `sync_rate`, `dictionary_name`, need to be the same.' type: string redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer retry_after_jitter_max: description: 'The upper bound of a jitter (random delay) in seconds to be added to the `Retry-After` header of denied requests (status = `429`) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is `0`; in this case, the `Retry-After` header is equal to the `RateLimit-Reset` header.' type: number strategy: description: 'The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: `local` and `cluster`.' type: string enum: - cluster - local - redis sync_rate: description: How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms). type: number window_size: description: One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified. type: array items: type: number window_type: description: 'Sets the time window type to either `sliding` (default) or `fixed`. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window''s counters.' type: string enum: - fixed - sliding required: - limit - window_size name: type: string const: service-protection protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config SessionPlugin: x-speakeasy-entity: GatewayPluginSession allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/SessionPluginConfig' SessionPluginConfig: properties: config: type: object properties: absolute_timeout: description: 'The session cookie absolute timeout, in seconds. Specifies how long the session can be used until it is no longer valid.' type: number audience: description: 'The session audience, which is the intended target application. For example `"my-application"`.' type: string cookie_domain: description: The domain with which the cookie is intended to be exchanged. type: string cookie_http_only: description: Applies the `HttpOnly` tag so that the cookie is sent only to a server. type: boolean cookie_name: description: The name of the cookie. type: string cookie_path: description: The resource in the host where the cookie is available. type: string cookie_same_site: description: Determines whether and how a cookie may be sent with cross-site requests. type: string enum: - Default - Lax - None - Strict cookie_secure: description: Applies the Secure directive so that the cookie may be sent to the server only with an encrypted request over the HTTPS protocol. type: boolean hash_subject: description: Whether to hash or not the subject when store_metadata is enabled. type: boolean idling_timeout: description: 'The session cookie idle time, in seconds.' type: number logout_methods: description: A set of HTTP methods that the plugin will respond to. type: array items: enum: - DELETE - GET - POST type: string logout_post_arg: description: The POST argument passed to logout requests. Do not change this property. type: string logout_query_arg: description: The query argument passed to logout requests. type: string read_body_for_logout: type: boolean remember: description: Enables or disables persistent sessions. type: boolean remember_absolute_timeout: description: 'The persistent session absolute timeout limit, in seconds.' type: number remember_cookie_name: description: Persistent session cookie name. Use with the `remember` configuration parameter. type: string remember_rolling_timeout: description: 'The persistent session rolling timeout window, in seconds.' type: number request_headers: description: 'List of information to include, as headers, in the response to the downstream.' type: array items: enum: - absolute-timeout - audience - id - idling-timeout - rolling-timeout - subject - timeout type: string response_headers: description: 'List of information to include, as headers, in the response to the downstream.' type: array items: enum: - absolute-timeout - audience - id - idling-timeout - rolling-timeout - subject - timeout type: string rolling_timeout: description: 'The session cookie rolling timeout, in seconds. Specifies how long the session can be used until it needs to be renewed.' type: number secret: description: The secret that is used in keyed HMAC generation. type: string stale_ttl: description: 'The duration, in seconds, after which an old cookie is discarded, starting from the moment when the session becomes outdated and is replaced by a new one.' type: number storage: description: 'Determines where the session data is stored. `kong`: Stores encrypted session data into Kong''s current database strategy; the cookie will not contain any session data. `cookie`: Stores encrypted session data within the cookie itself.' type: string enum: - cookie - kong store_metadata: description: 'Whether to also store metadata of sessions, such as collecting data of sessions for a specific audience belonging to a specific subject.' type: boolean shorthand_fields: cookie_discard: type: number cookie_httponly: type: boolean cookie_idletime: type: number cookie_lifetime: type: number cookie_persistent: type: boolean cookie_renew: type: number cookie_samesite: type: string name: type: string const: session protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false SolaceUpstreamPlugin: x-speakeasy-entity: GatewayPluginSolaceUpstream allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/SolaceUpstreamPluginConfig' SolaceUpstreamPluginConfig: properties: config: type: object properties: message: description: The message related configuration. type: object properties: ack_timeout: description: 'When using a non-DIRECT guaranteed delivery mode, this property sets the message acknowledgement timeout (waiting time).' type: integer maximum: 100000 minimum: 1 default_content: description: 'When not using `forward_method`, `forward_uri`, `forward_headers` or `forward_body`, this sets the message content.' type: string delivery_mode: description: Sets the message delivery mode. type: string enum: - DIRECT - PERSISTENT destinations: description: The message destinations. type: array items: properties: name: description: 'The name of the destination. You can use `$(uri_captures[''topic_name'']` in this field.' type: string type: description: The type of the destination. type: string enum: - QUEUE - TOPIC required: - name type: object minLength: 1 dmq_eligible: description: Sets the dead message queue (DMQ) eligible property on the message. type: boolean forward_body: description: Include the request body and the body arguments in the message. type: boolean forward_headers: description: Include the request headers in the message. type: boolean forward_method: description: Include the request method in the message. type: boolean forward_uri: description: 'Include the request URI and the URI arguments (as in, query arguments) in the message.' type: boolean functions: description: 'The Lua functions that manipulates (or generates) the message being sent to Solace. The `message` variable can be used to access the current message content, and the function can return a new content.' type: array items: type: string priority: description: Sets the message priority. type: integer maximum: 255 minimum: 0 sender_id: description: Allows the application to set the content of the sender identifier. type: string tracing: description: 'Enable or disable the tracing. This is primarily used for distributed tracing and message correlation, especially in debugging or tracking message flows across multiple systems.' type: boolean tracing_sampled: description: 'Indicates whether the message should be included in distributed tracing (i.e., if it should be "sampled" for the tracing)' type: boolean ttl: description: Sets the time to live (TTL) in milliseconds for the message. Setting the time to live to zero disables the TTL for the message. type: integer minimum: -1 required: - destinations session: description: Session related configuration. type: object properties: authentication: description: Session authentication related configuration. type: object properties: access_token: description: The OAuth2 access token used with `OAUTH2` authentication scheme when connecting to an event broker. type: string access_token_header: type: string id_token: description: The OpenID Connect ID token used with `OAUTH2` authentication scheme when connecting to an event broker. type: string id_token_header: type: string password: description: The password used with `BASIC` authentication scheme when connecting to an event broker. type: string scheme: description: The client authentication scheme used when connection to an event broker. type: string enum: - BASIC - NONE - OAUTH2 username: description: The username used with `BASIC` authentication scheme when connecting to an event broker . type: string connect_timeout: description: The timeout period (in milliseconds) for a connect operation to a given host (per host). type: integer maximum: 100000 minimum: 100 host: description: 'The IPv4 or IPv6 address or host name to connect to (see: https://docs.solace.com/API-Developer-Online-Ref-Documentation/c/index.html#host-entry).' type: string properties: description: Additional Solace session properties (each setting needs to have `SESSION_` prefix). type: object additionalProperties: true ssl_validate_certificate: description: Indicates whether the API should validate server certificates with the trusted certificates. type: boolean vpn_name: description: The name of the Message VPN to attempt to join when connecting to an event broker. type: string required: - host required: - message - session name: type: string const: solace-upstream protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config StandardWebhooksPlugin: x-speakeasy-entity: GatewayPluginStandardWebhooks allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/StandardWebhooksPluginConfig' StandardWebhooksPluginConfig: properties: config: type: object properties: secret_v1: description: Webhook secret type: string tolerance_second: description: 'Tolerance of the webhook timestamp in seconds. If the webhook timestamp is older than this number of seconds, it will be rejected with a ''400'' response.' type: integer minimum: -1 required: - secret_v1 consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: standard-webhooks protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config StatsdAdvancedPlugin: x-speakeasy-entity: GatewayPluginStatsdAdvanced allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/StatsdAdvancedPluginConfig' StatsdAdvancedPluginConfig: properties: config: type: object properties: allow_status_codes: description: List of status code ranges that are allowed to be logged in metrics. type: array items: pattern: '^[0-9]+-[0-9]+$' type: string consumer_identifier_default: description: 'The default consumer identifier for metrics. This will take effect when a metric''s consumer identifier is omitted. Allowed values are `custom_id`, `consumer_id`, `username`.' type: string enum: - consumer_id - custom_id - username host: description: 'A string representing a host name, such as example.com.' type: string hostname_in_prefix: description: Include the `hostname` in the `prefix` for each metric name. type: boolean metrics: description: List of Metrics to be logged. type: array items: properties: consumer_identifier: type: string enum: - consumer_id - custom_id - username name: type: string enum: - cache_datastore_hits_total - cache_datastore_misses_total - kong_latency - latency - request_count - request_per_user - request_size - response_size - shdict_usage - status_count - status_count_per_user - status_count_per_user_per_route - status_count_per_workspace - unique_users - upstream_latency sample_rate: type: number minimum: 0 service_identifier: type: string enum: - service_host - service_id - service_name - service_name_or_host stat_type: type: string enum: - counter - gauge - histogram - meter - set - timer workspace_identifier: type: string enum: - workspace_id - workspace_name required: - name - stat_type type: object port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 prefix: description: String to prefix to each metric's name. type: string queue: type: object properties: concurrency_limit: description: The number of of queue delivery timers. -1 indicates unlimited. type: integer enum: - -1 - 1 initial_retry_delay: description: Time in seconds before the initial retry is made for a failing batch. type: number maximum: 1000000 minimum: 0.001 max_batch_size: description: Maximum number of entries that can be processed at a time. type: integer maximum: 1000000 minimum: 1 max_bytes: description: 'Maximum number of bytes that can be waiting on a queue, requires string content.' type: integer max_coalescing_delay: description: Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler. type: number maximum: 3600 minimum: 0 max_entries: description: Maximum number of entries that can be waiting on the queue. type: integer maximum: 1000000 minimum: 1 max_retry_delay: description: 'Maximum time in seconds between retries, caps exponential backoff.' type: number maximum: 1000000 minimum: 0.001 max_retry_time: description: Time in seconds before the queue gives up calling a failed handler for a batch. type: number service_identifier_default: description: 'The default service identifier for metrics. This will take effect when a metric''s service identifier is omitted. Allowed values are `service_name_or_host`, `service_id`, `service_name`, `service_host`.' type: string enum: - service_host - service_id - service_name - service_name_or_host udp_packet_size: description: 'Combine UDP packet up to the size configured. If zero (0), don''t combine the UDP packet. Must be a number between 0 and 65507 (inclusive).' type: number maximum: 65507 minimum: 0 use_tcp: description: Use TCP instead of UDP. type: boolean workspace_identifier_default: description: 'The default workspace identifier for metrics. This will take effect when a metric''s workspace identifier is omitted. Allowed values are `workspace_id`, `workspace_name`. ' type: string enum: - workspace_id - workspace_name 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: statsd-advanced protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false StatsdPlugin: x-speakeasy-entity: GatewayPluginStatsd allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/StatsdPluginConfig' StatsdPluginConfig: properties: config: type: object properties: allow_status_codes: description: List of status code ranges that are allowed to be logged in metrics. type: array items: pattern: '^[0-9]+-[0-9]+$' type: string consumer_identifier_default: type: string enum: - consumer_id - custom_id - username flush_timeout: type: number host: description: The IP address or hostname of StatsD server to send data to. type: string hostname_in_prefix: type: boolean metrics: description: List of metrics to be logged. type: array items: properties: consumer_identifier: description: Authenticated user detail. type: string enum: - consumer_id - custom_id - username name: description: StatsD metric’s name. type: string enum: - cache_datastore_hits_total - cache_datastore_misses_total - kong_latency - latency - request_count - request_per_user - request_size - response_size - shdict_usage - status_count - status_count_per_user - status_count_per_user_per_route - status_count_per_workspace - unique_users - upstream_latency sample_rate: description: Sampling rate type: number minimum: 0 service_identifier: description: Service detail. type: string enum: - service_host - service_id - service_name - service_name_or_host stat_type: description: Determines what sort of event a metric represents. type: string enum: - counter - gauge - histogram - meter - set - timer workspace_identifier: description: Workspace detail. type: string enum: - workspace_id - workspace_name required: - name - stat_type type: object port: description: The port of StatsD server to send data to. type: integer maximum: 65535 minimum: 0 prefix: description: String to prefix to each metric's name. type: string queue: type: object properties: concurrency_limit: description: The number of of queue delivery timers. -1 indicates unlimited. type: integer enum: - -1 - 1 initial_retry_delay: description: Time in seconds before the initial retry is made for a failing batch. type: number maximum: 1000000 minimum: 0.001 max_batch_size: description: Maximum number of entries that can be processed at a time. type: integer maximum: 1000000 minimum: 1 max_bytes: description: 'Maximum number of bytes that can be waiting on a queue, requires string content.' type: integer max_coalescing_delay: description: Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler. type: number maximum: 3600 minimum: 0 max_entries: description: Maximum number of entries that can be waiting on the queue. type: integer maximum: 1000000 minimum: 1 max_retry_delay: description: 'Maximum time in seconds between retries, caps exponential backoff.' type: number maximum: 1000000 minimum: 0.001 max_retry_time: description: Time in seconds before the queue gives up calling a failed handler for a batch. type: number queue_size: type: integer retry_count: type: integer service_identifier_default: type: string enum: - service_host - service_id - service_name - service_name_or_host tag_style: type: string enum: - dogstatsd - influxdb - librato - signalfx udp_packet_size: type: number maximum: 65507 minimum: 0 use_tcp: type: boolean workspace_identifier_default: type: string enum: - workspace_id - workspace_name 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: statsd protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false SyslogPlugin: x-speakeasy-entity: GatewayPluginSyslog allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/SyslogPluginConfig' SyslogPluginConfig: properties: config: type: object properties: client_errors_severity: type: string enum: - alert - crit - debug - emerg - err - info - notice - warning custom_fields_by_lua: description: Lua code as a key-value map type: object additionalProperties: true facility: description: The facility is used by the operating system to decide how to handle each log message. type: string enum: - auth - authpriv - cron - daemon - ftp - kern - local0 - local1 - local2 - local3 - local4 - local5 - local6 - local7 - lpr - mail - news - syslog - user - uucp log_level: type: string enum: - alert - crit - debug - emerg - err - info - notice - warning server_errors_severity: type: string enum: - alert - crit - debug - emerg - err - info - notice - warning successful_severity: type: string enum: - alert - crit - debug - emerg - err - info - notice - warning 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: syslog protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false Target: x-speakeasy-entity: GatewayTarget 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 nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true tags: description: An optional set of strings associated with the Target for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true 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 nullable: true updated_at: description: Unix epoch when the resource was last updated. type: number nullable: true upstream: description: The unique identifier or the name of the upstream for which to update the target. type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false 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 nullable: true example: id: 089292a7-ba3d-4d88-acf0-97b4b2e2621a target: 203.0.113.42 upstream: id: 5f1d7e76-2fed-4806-a6af-869984f025cb weight: 100 additionalProperties: false TargetWithoutParents: x-speakeasy-entity: GatewayTarget 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 nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true tags: description: An optional set of strings associated with the Target for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true 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 nullable: true updated_at: description: Unix epoch when the resource was last updated. type: number nullable: true upstream: description: The unique identifier or the name of the upstream for which to update the target. type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false 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 nullable: true example: id: 089292a7-ba3d-4d88-acf0-97b4b2e2621a target: 203.0.113.42 weight: 100 additionalProperties: false TcpLogPlugin: x-speakeasy-entity: GatewayPluginTcpLog allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/TcpLogPluginConfig' TcpLogPluginConfig: properties: config: type: object properties: custom_fields_by_lua: description: 'A list of key-value pairs, where the key is the name of a log field and the value is a chunk of Lua code, whose return value sets or replaces the log field value.' type: object additionalProperties: true host: description: The IP address or host name to send data to. type: string keepalive: description: An optional value in milliseconds that defines how long an idle connection lives before being closed. type: number port: description: The port to send data to on the upstream server. type: integer maximum: 65535 minimum: 0 timeout: description: An optional timeout in milliseconds when sending data to the upstream server. type: number tls: description: Indicates whether to perform a TLS handshake against the remote server. type: boolean tls_sni: description: An optional string that defines the SNI (Server Name Indication) hostname to send in the TLS handshake. type: string required: - host - port 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: tcp-log protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config TlsHandshakeModifierPlugin: x-speakeasy-entity: GatewayPluginTlsHandshakeModifier allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/TlsHandshakeModifierPluginConfig' TlsHandshakeModifierPluginConfig: properties: config: type: object properties: tls_client_certificate: description: TLS Client Certificate type: string enum: - REQUEST name: type: string const: tls-handshake-modifier 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: enum: - grpcs - https - tls type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false TlsMetadataHeadersPlugin: x-speakeasy-entity: GatewayPluginTlsMetadataHeaders allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/TlsMetadataHeadersPluginConfig' TlsMetadataHeadersPluginConfig: properties: config: type: object properties: client_cert_fingerprint_header_name: description: Define the HTTP header name used for the SHA1 fingerprint of the client certificate. type: string client_cert_header_name: description: Define the HTTP header name used for the PEM format URL encoded client certificate. type: string client_cert_issuer_dn_header_name: description: Define the HTTP header name used for the issuer DN of the client certificate. type: string client_cert_subject_dn_header_name: description: Define the HTTP header name used for the subject DN of the client certificate. type: string client_serial_header_name: description: Define the HTTP header name used for the serial number of the client certificate. type: string inject_client_cert_details: description: Enables TLS client certificate metadata values to be injected into HTTP headers. type: boolean name: type: string const: tls-metadata-headers 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: enum: - grpcs - https - tls type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false UdpLogPlugin: x-speakeasy-entity: GatewayPluginUdpLog allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/UdpLogPluginConfig' UdpLogPluginConfig: properties: config: type: object properties: custom_fields_by_lua: description: Lua code as a key-value map type: object additionalProperties: true host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 timeout: description: An optional timeout in milliseconds when sending data to the upstream server. type: number required: - host - port 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: udp-log protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config Upstream: x-speakeasy-entity: GatewayUpstream 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 enum: - consistent-hashing - least-connections - round-robin - latency - sticky-sessions nullable: true client_certificate: description: 'If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.' type: object default: null nullable: true properties: id: type: string x-foreign: true x-speakeasy-param-computed: false created_at: description: Unix epoch when the resource was created. type: integer nullable: true 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 enum: - none - consumer - ip - header - cookie - path - query_arg - uri_capture nullable: true 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 nullable: true 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 nullable: true 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 nullable: true hash_on: description: What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing. type: string enum: - none - consumer - ip - header - cookie - path - query_arg - uri_capture nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true healthchecks: type: object nullable: true properties: active: type: object properties: concurrency: type: integer headers: description: A map of header names to arrays of header values. type: object additionalProperties: items: type: string type: array healthy: type: object properties: http_statuses: type: array items: type: integer interval: type: number successes: type: integer http_path: description: 'A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).' type: string https_sni: description: A string representing an SNI (server name indication) value for TLS. type: string https_verify_certificate: type: boolean timeout: type: number type: type: string enum: - tcp - http - https - grpc - grpcs unhealthy: type: object properties: http_failures: type: integer http_statuses: type: array items: type: integer interval: type: number tcp_failures: type: integer timeouts: type: integer passive: type: object properties: healthy: type: object properties: http_statuses: type: array items: type: integer successes: type: integer type: type: string enum: - tcp - http - https - grpc - grpcs unhealthy: type: object properties: http_failures: type: integer http_statuses: type: array items: type: integer tcp_failures: type: integer timeouts: type: integer threshold: type: number host_header: description: The hostname to be used as `Host` header when proxying requests through Kong. type: string nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true 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 nullable: true sticky_sessions_cookie: description: The cookie name to keep sticky sessions. type: string nullable: true sticky_sessions_cookie_path: description: 'A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).' type: string nullable: true tags: description: An optional set of strings associated with the Upstream for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true 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 nullable: true 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 additionalProperties: false required: - name UpstreamOauthPlugin: x-speakeasy-entity: GatewayPluginUpstreamOauth allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/UpstreamOauthPluginConfig' UpstreamOauthPluginConfig: properties: config: type: object properties: behavior: type: object properties: idp_error_response_body_template: description: The template to use to create the body of the response to return to the consumer if Kong fails to obtain a token from the IdP. type: string idp_error_response_content_type: description: The Content-Type of the response to return to the consumer if Kong fails to obtain a token from the IdP. type: string idp_error_response_message: description: The message to embed in the body of the response to return to the consumer if Kong fails to obtain a token from the IdP. type: string idp_error_response_status_code: description: The response code to return to the consumer if Kong fails to obtain a token from the IdP. type: integer maximum: 599 minimum: 500 purge_token_on_upstream_status_codes: description: An array of status codes which will force an access token to be purged when returned by the upstream. An empty array will disable this functionality. type: array items: maximum: 599 minimum: 100 type: integer upstream_access_token_header_name: description: The name of the header used to send the access token (obtained from the IdP) to the upstream service. type: string cache: type: object properties: default_ttl: description: The lifetime of a token without an explicit `expires_in` value. type: number minimum: 0 eagerly_expire: description: 'The number of seconds to eagerly expire a cached token. By default, a cached token expires 5 seconds before its lifetime as defined in `expires_in`.' type: integer minimum: -1 memory: type: object properties: dictionary_name: description: The shared dictionary used by the plugin to cache tokens if `config.cache.strategy` is set to `memory`. type: string redis: type: object properties: cluster_max_redirections: description: Maximum retry attempts for redirection. type: integer cluster_nodes: description: Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. type: array items: properties: ip: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 connection_is_proxied: description: 'If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.' type: boolean database: description: Database to use for the Redis connection when using the `redis` strategy type: integer host: description: 'A string representing a host name, such as example.com.' type: string keepalive_backlog: description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.' type: integer maximum: 2147483646 minimum: 0 keepalive_pool_size: description: 'The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn''t specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.' type: integer maximum: 2147483646 minimum: 1 password: description: 'Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sentinel_master: description: Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel. type: string sentinel_nodes: description: Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. type: array items: properties: host: description: 'A string representing a host name, such as example.com.' type: string port: description: 'An integer representing a port number between 0 and 65535, inclusive.' type: integer maximum: 65535 minimum: 0 type: object minLength: 1 sentinel_password: description: 'Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.' type: string sentinel_role: description: Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel. type: string enum: - any - master - slave sentinel_username: description: 'Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won''t be performed. This requires Redis v6.2.0+.' type: string server_name: description: A string representing an SNI (server name indication) value for TLS. type: string ssl: description: 'If set to true, uses SSL to connect to Redis.' type: boolean ssl_verify: description: 'If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.' type: boolean username: description: 'Username to use for Redis connections. If undefined, ACL authentication won''t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.' type: string shorthand_fields: cluster_addresses: items: type: string minLength: 1 type: array sentinel_addresses: items: type: string minLength: 1 type: array timeout: type: integer strategy: description: The method Kong should use to cache tokens issued by the IdP. type: string enum: - memory - redis client: type: object properties: auth_method: description: 'The authentication method used in client requests to the IdP. Supported values are: `client_secret_basic` to send `client_id` and `client_secret` in the `Authorization: Basic` header, `client_secret_post` to send `client_id` and `client_secret` as part of the request body, or `client_secret_jwt` to send a JWT signed with the `client_secret` using the client assertion as part of the body.' type: string enum: - client_secret_basic - client_secret_jwt - client_secret_post - none client_secret_jwt_alg: description: The algorithm to use with JWT when using `client_secret_jwt` authentication. type: string enum: - HS256 - HS512 http_proxy: description: The proxy to use when making HTTP requests to the IdP. type: string http_proxy_authorization: description: The `Proxy-Authorization` header value to be used with `http_proxy`. type: string http_version: description: 'The HTTP version used for requests made by this plugin. Supported values: `1.1` for HTTP 1.1 and `1.0` for HTTP 1.0.' type: number https_proxy: description: The proxy to use when making HTTPS requests to the IdP. type: string https_proxy_authorization: description: The `Proxy-Authorization` header value to be used with `https_proxy`. type: string keep_alive: description: Whether to use keepalive connections to the IdP. type: boolean no_proxy: description: A comma-separated list of hosts that should not be proxied. type: string ssl_verify: description: Whether to verify the certificate presented by the IdP when using HTTPS. type: boolean timeout: description: Network I/O timeout for requests to the IdP in milliseconds. type: integer maximum: 2147483646 minimum: 0 oauth: type: object properties: audience: description: List of audiences passed to the IdP when obtaining a new token. type: array items: type: string client_id: description: The client ID for the application registration in the IdP. type: string client_secret: description: The client secret for the application registration in the IdP. type: string grant_type: description: The OAuth grant type to be used. type: string enum: - client_credentials - password password: description: The password to use if `config.oauth.grant_type` is set to `password`. type: string scopes: description: List of scopes to request from the IdP when obtaining a new token. type: array items: type: string default: [] nullable: true token_endpoint: description: The token endpoint URI. type: string token_headers: description: Extra headers to be passed in the token endpoint request. type: object additionalProperties: true token_post_args: description: Extra post arguments to be passed in the token endpoint request. type: object additionalProperties: true username: description: The username to use if `config.oauth.grant_type` is set to `password`. type: string required: - token_endpoint required: - oauth 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false consumer_group: description: 'If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups' type: object default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: upstream-oauth protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config UpstreamTimeoutPlugin: x-speakeasy-entity: GatewayPluginUpstreamTimeout allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/UpstreamTimeoutPluginConfig' UpstreamTimeoutPluginConfig: properties: config: type: object properties: connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 1 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 read_timeout: description: An integer representing a timeout in milliseconds. Must be between 1 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 1 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: upstream-timeout protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false Vault: x-speakeasy-entity: GatewayVault 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 additionalProperties: true nullable: true x-speakeasy-type-override: any created_at: description: Unix epoch when the resource was created. type: integer nullable: true description: description: The description of the Vault entity. type: string nullable: true id: description: A string representing a UUID (universally unique identifier). type: string nullable: true 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 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 tags: description: An optional set of strings associated with the Vault for grouping and filtering. type: array items: description: A string representing a tag. type: string nullable: true updated_at: description: Unix epoch when the resource was last updated. type: integer nullable: true example: config: prefix: ENV_PREFIX description: environment variable based vault id: 2747d1e5-8246-4f65-a939-b392f1ee17f8 name: env prefix: env tags: - foo - bar additionalProperties: false required: - name - prefix VaultAuthPlugin: x-speakeasy-entity: GatewayPluginVaultAuth allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/VaultAuthPluginConfig' VaultAuthPluginConfig: properties: config: type: object properties: access_token_name: description: 'Describes an array of comma-separated parameter names where the plugin looks for an access token. The client must send the access token in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].' type: string items: description: A string representing an HTTP header name. type: string anonymous: description: 'An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure `4xx`. Note that this value must refer to the consumer `id` or `username` attribute, and **not** its `custom_id`.' type: string hide_credentials: description: 'An optional boolean value telling the plugin to show or hide the credential from the upstream service. If `true`, the plugin will strip the credential from the request (i.e. the header or querystring containing the key) before proxying it.' type: boolean run_on_preflight: description: 'A boolean value that indicates whether the plugin should run (and try to authenticate) on `OPTIONS` preflight requests. If set to `false`, then `OPTIONS` requests will always be allowed.' type: boolean secret_token_name: description: 'Describes an array of comma-separated parameter names where the plugin looks for a secret token. The client must send the secret in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].' type: string items: description: A string representing an HTTP header name. type: string tokens_in_body: description: 'If enabled, the plugin will read the request body (if said request has one and its MIME type is supported) and try to find the key in it. Supported MIME types are `application/www-form-urlencoded`, `application/json`, and `multipart/form-data`.' type: boolean vault: description: A reference to an existing `vault` object within the database. `vault` entities define the connection and authentication parameters used to connect to a Vault HTTP(S) API. type: string required: - vault name: type: string const: vault-auth protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false required: - config WebsocketSizeLimitPlugin: x-speakeasy-entity: GatewayPluginWebsocketSizeLimit allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/WebsocketSizeLimitPluginConfig' WebsocketSizeLimitPluginConfig: properties: config: type: object properties: client_max_payload: type: integer maximum: 33554432 minimum: 1 upstream_max_payload: type: integer maximum: 33554432 minimum: 1 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: websocket-size-limit 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: enum: - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false WebsocketValidatorPlugin: x-speakeasy-entity: GatewayPluginWebsocketValidator allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/WebsocketValidatorPluginConfig' WebsocketValidatorPluginConfig: properties: config: type: object properties: client: type: object properties: binary: type: object properties: schema: description: Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by `config.upstream.binary.type`. type: string type: description: 'The corresponding validation library for `config.upstream.binary.schema`. Currently, only `draft4` is supported.' type: string enum: - draft4 required: - schema - type text: type: object properties: schema: description: Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by `config.upstream.binary.type`. type: string type: description: 'The corresponding validation library for `config.upstream.binary.schema`. Currently, only `draft4` is supported.' type: string enum: - draft4 required: - schema - type upstream: type: object properties: binary: type: object properties: schema: description: Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by `config.upstream.binary.type`. type: string type: description: 'The corresponding validation library for `config.upstream.binary.schema`. Currently, only `draft4` is supported.' type: string enum: - draft4 required: - schema - type text: type: object properties: schema: description: Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by `config.upstream.binary.type`. type: string type: description: 'The corresponding validation library for `config.upstream.binary.schema`. Currently, only `draft4` is supported.' type: string enum: - draft4 required: - schema - type 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: websocket-validator 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: enum: - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false XmlThreatProtectionPlugin: x-speakeasy-entity: GatewayPluginXmlThreatProtection allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/XmlThreatProtectionPluginConfig' XmlThreatProtectionPluginConfig: properties: config: type: object properties: allow_dtd: description: Indicates whether an XML Document Type Definition (DTD) section is allowed. type: boolean allowed_content_types: description: 'A list of Content-Type values with payloads that are allowed, but aren''t validated.' type: array items: pattern: '^[^\t\n\v\f\r ]+\/[^ ;]+$' type: string attribute: description: Maximum size of the attribute value. type: integer minimum: 0 bla_max_amplification: description: Sets the maximum allowed amplification. This protects against the Billion Laughs Attack. type: number minimum: 1 bla_threshold: description: Sets the threshold after which the protection starts. This protects against the Billion Laughs Attack. type: integer minimum: 1024 buffer: description: Maximum size of the unparsed buffer (see below). type: integer minimum: 0 checked_content_types: description: A list of Content-Type values with payloads that must be validated. type: array items: pattern: '^[^\t\n\v\f\r ]+\/[^ ;]+$' type: string comment: description: Maximum size of comments. type: integer minimum: 0 document: description: Maximum size of the entire document. type: integer minimum: 0 entity: description: Maximum size of entity values in EntityDecl. type: integer minimum: 0 entityname: description: Maximum size of entity names in EntityDecl. type: integer minimum: 0 entityproperty: description: 'Maximum size of systemId, publicId, or notationName in EntityDecl.' type: integer minimum: 0 localname: description: Maximum size of the localname. This applies to tags and attributes. type: integer minimum: 0 max_attributes: description: 'Maximum number of attributes allowed on a tag, including default ones. Note: If namespace-aware parsing is disabled, then the namespaces definitions are counted as attributes.' type: integer minimum: 0 max_children: description: 'Maximum number of children allowed (Element, Text, Comment, ProcessingInstruction, CDATASection). Note: Adjacent text and CDATA sections are counted as one. For example, text-cdata-text-cdata is one child.' type: integer minimum: 0 max_depth: description: Maximum depth of tags. Child elements such as Text or Comments are not counted as another level. type: integer minimum: 0 max_namespaces: description: Maximum number of namespaces defined on a tag. This value is required if parsing is namespace-aware. type: integer minimum: 0 namespace_aware: description: 'If not parsing namespace aware, all prefixes and namespace attributes will be counted as regular attributes and element names, and validated as such.' type: boolean namespaceuri: description: Maximum size of the namespace URI. This value is required if parsing is namespace-aware. type: integer minimum: 0 pidata: description: Maximum size of processing instruction data. type: integer minimum: 0 pitarget: description: Maximum size of processing instruction targets. type: integer minimum: 0 prefix: description: Maximum size of the prefix. This applies to tags and attributes. This value is required if parsing is namespace-aware. type: integer minimum: 0 text: description: Maximum text inside tags (counted over all adjacent text/CDATA elements combined). type: integer minimum: 0 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: xml-threat-protection protocols: description: A set of strings representing HTTP protocols. type: array items: enum: - grpc - grpcs - http - https type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false ZipkinPlugin: x-speakeasy-entity: GatewayPluginZipkin allOf: - $ref: '#/components/schemas/PluginBase' - $ref: '#/components/schemas/ZipkinPluginConfig' ZipkinPluginConfig: properties: config: type: object properties: connect_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 default_header_type: description: 'Allows specifying the type of header to be added to requests with no pre-existing tracing headers and when `config.header_type` is set to `"preserve"`. When `header_type` is set to any other value, `default_header_type` is ignored.' type: string enum: - aws - b3 - b3-single - datadog - gcp - instana - jaeger - ot - w3c default_service_name: description: Set a default service name to override `unknown-service-name` in the Zipkin spans. type: string header_type: description: All HTTP requests going through the plugin are tagged with a tracing HTTP request. This property codifies what kind of tracing header the plugin expects on incoming requests type: string enum: - aws - b3 - b3-single - datadog - gcp - ignore - instana - jaeger - ot - preserve - w3c http_endpoint: description: 'A string representing a URL, such as https://example.com/path/to/resource?q=search.' type: string http_response_header_for_traceid: type: string http_span_name: description: Specify whether to include the HTTP path in the span name. type: string enum: - method - method_path include_credential: description: Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server. type: boolean local_service_name: description: The name of the service as displayed in Zipkin. type: string phase_duration_flavor: description: Specify whether to include the duration of each phase as an annotation or a tag. type: string enum: - annotations - tags propagation: type: object properties: clear: description: 'Header names to clear after context extraction. This allows to extract the context from a certain header and then remove it from the request, useful when extraction and injection are performed on different header formats and the original header should not be sent to the upstream. If left empty, no headers are cleared.' type: array items: type: string default_format: description: 'The default header format to use when extractors did not match any format in the incoming headers and `inject` is configured with the value: `preserve`. This can happen when no tracing header was found in the request, or the incoming tracing header formats were not included in `extract`.' type: string enum: - aws - b3 - b3-single - datadog - gcp - instana - jaeger - ot - w3c extract: description: 'Header formats used to extract tracing context from incoming requests. If multiple values are specified, the first one found will be used for extraction. If left empty, Kong will not extract any tracing context information from incoming requests and generate a trace with no parent and a new trace ID.' type: array items: enum: - aws - b3 - datadog - gcp - instana - jaeger - ot - w3c type: string inject: description: 'Header formats used to inject tracing context. The value `preserve` will use the same header format as the incoming request. If multiple values are specified, all of them will be used during injection. If left empty, Kong will not inject any tracing context information in outgoing requests.' type: array items: enum: - aws - b3 - b3-single - datadog - gcp - instana - jaeger - ot - preserve - w3c type: string queue: type: object properties: concurrency_limit: description: The number of of queue delivery timers. -1 indicates unlimited. type: integer enum: - -1 - 1 initial_retry_delay: description: Time in seconds before the initial retry is made for a failing batch. type: number maximum: 1000000 minimum: 0.001 max_batch_size: description: Maximum number of entries that can be processed at a time. type: integer maximum: 1000000 minimum: 1 max_bytes: description: 'Maximum number of bytes that can be waiting on a queue, requires string content.' type: integer max_coalescing_delay: description: Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler. type: number maximum: 3600 minimum: 0 max_entries: description: Maximum number of entries that can be waiting on the queue. type: integer maximum: 1000000 minimum: 1 max_retry_delay: description: 'Maximum time in seconds between retries, caps exponential backoff.' type: number maximum: 1000000 minimum: 0.001 max_retry_time: description: Time in seconds before the queue gives up calling a failed handler for a batch. type: number read_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 sample_ratio: description: 'How often to sample requests that do not contain trace IDs. Set to `0` to turn sampling off, or to `1` to sample **all** requests. ' type: number maximum: 1 minimum: 0 send_timeout: description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. type: integer maximum: 2147483646 minimum: 0 static_tags: description: The tags specified on this property will be added to the generated request traces. type: array items: properties: name: type: string not_one_of: - error - http.method - http.path - http.status_code - kong.balancer.state - kong.balancer.try - kong.consumer - kong.credential - kong.node.id - kong.route - kong.service - lc - peer.hostname value: type: string required: - name - value type: object tags_header: description: The Zipkin plugin will add extra headers to the tags associated with any HTTP requests that come with a header named as configured by this property. type: string traceid_byte_count: description: The length in bytes of each request's Trace ID. type: integer enum: - 8 - 16 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false name: type: string const: zipkin protocols: description: A set of strings representing protocols. type: array items: description: 'A string representing a protocol, such as HTTP or HTTPS.' enum: - grpc - grpcs - http - https - tcp - tls - tls_passthrough - udp - ws - wss type: string format: set 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false 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 default: null additionalProperties: false nullable: true properties: id: type: string x-speakeasy-param-computed: false KonnectCPLegacyBaseError: description: standard error type: object properties: message: description: | A short summary of the problem. type: string readOnly: true title: Error KonnectCPLegacyUnauthorizedError: allOf: - $ref: '#/components/schemas/KonnectCPLegacyBaseError' - type: object properties: message: example: Unauthorized KonnectCPLegacyForbiddenError: allOf: - $ref: '#/components/schemas/KonnectCPLegacyBaseError' - type: object properties: message: example: Forbidden KonnectCPLegacyNotFoundError: allOf: - $ref: '#/components/schemas/KonnectCPLegacyBaseError' - type: object properties: message: example: Not Found KonnectCPLegacyBadRequestError: allOf: - $ref: '#/components/schemas/KonnectCPLegacyBaseError' - type: object properties: message: example: Bad Request KonnectCPLegacyConflictError: allOf: - $ref: '#/components/schemas/KonnectCPLegacyBaseError' - type: object properties: message: example: Conflict CreateApiKeyPayload: type: object properties: type: type: string enum: - new - legacy secret: description: secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. type: string x-speakeasy-plan-validators: CentralizedConsumerKeyValidator tags: type: array items: type: string uniqueItems: true example: type: new consumer_id: ...consumer_id... realm_id: ...realm_id... additionalProperties: false required: - type requestBodies: GroupMembershipAdd: content: application/json: schema: $ref: '#/components/schemas/GroupMembership' description: Request body for adding a list of child control planes to a control plane group membership. GroupMembershipRemove: content: application/json: schema: $ref: '#/components/schemas/GroupMembership' description: Request body for removing a list of child control planes from a control plane group membership. CreateAPIProductRequest: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAPIProductDTO' UpdateAPIProductRequest: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAPIProductDTO' CreateAPIProductVersionRequest: x-speakeasy-entity: APIProductVersion required: true content: application/json: schema: $ref: '#/components/schemas/CreateAPIProductVersionDTO' CreateAPIProductVersionSpecRequest: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAPIProductVersionSpecDTO' CreateAPIProductDocumentRequest: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAPIProductDocumentDTO' UpdateAPIProductVersionRequest: x-speakeasy-entity: APIProductVersion required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAPIProductVersionDTO' UpdateAPIProductDocumentRequest: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAPIProductDocumentDTO' UpdateAPIProductVersionSpecRequest: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAPIProductVersionSpecDTO' PortalUpdateTeam: description: Update a team in a portal. content: application/json: schema: $ref: '#/components/schemas/PortalUpdateTeamRequest' PortalCreateTeam: description: Create a team in a portal. content: application/json: schema: $ref: '#/components/schemas/PortalCreateTeamRequest' UpdatePortalAuthenticationSettings: description: Update a portal's developer authentication settings. content: application/json: schema: $ref: '#/components/schemas/PortalAuthenticationSettingsUpdateRequest' CreatePortal: description: Create a portal. required: true content: application/json: schema: $ref: '#/components/schemas/CreatePortalRequest' UpdatePortal: description: Update a portal's settings. required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePortalRequest' ReplacePortalProductVersion: required: true content: application/json: schema: $ref: '#/components/schemas/ReplacePortalProductVersionPayload' UpdatePortalAppearance: description: Update a portal's appearance settings required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePortalAppearanceRequest' CreateAppAuthStrategy: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAppAuthStrategyRequest' UpdateAppAuthStrategy: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAppAuthStrategyRequest' CreateTeam: description: |- The request schema for the create team request. If you pass the same `name` and `description` of an existing team in the request, a team with the same `name` and `description` will be created. The two teams will have different `team_id` values to differentiate them. content: application/json: schema: x-speakeasy-entity: Team type: object properties: name: description: A name for the team being created. type: string example: IDM - Developers pattern: '^[\w \W]+$' writeOnly: true description: description: The description of the new team. type: string example: The Identity Management (IDM) team. maxLength: 250 writeOnly: true labels: $ref: '#/components/schemas/Labels' required: - name UpdateTeam: description: The request schema for the update team request. content: application/json: schema: x-speakeasy-entity: Team type: object properties: name: description: The name of the team. type: string example: IDM - Developers pattern: '^[\w \W]+$' writeOnly: true description: description: The description of the team. type: string example: The Identity Management (IDM) API team. maxLength: 250 writeOnly: true labels: $ref: '#/components/schemas/LabelsUpdate' AddUserToTeam: description: The request schema for adding a user to a team. content: application/json: schema: type: object properties: id: description: The user ID for the user being added to a team. type: string format: uuid example: df120cb4-f60b-47bc-a2f8-6a28e6a3c63b writeOnly: true x-speakeasy-name-override: user_id required: - id AssignRole: content: application/json: schema: description: An assigned role is a role that has been assigned to a user or team. type: object properties: role_name: description: The desired role. type: string example: Viewer enum: - Admin - Appearance Maintainer - Application Registration - Certificate Admin - Cloud Gateway Cluster Admin - Cloud Gateway Cluster Viewer - Consumer Admin - Connector - Creator - Deployer - Discovery Admin - Discovery Viewer - Gateway Service Admin - Integration Admin - Integration Viewer - Key Admin - Maintainer - Network Admin - Network Creator - Network Viewer - Plugin Admin - Plugins Admin - Product Publisher - Publisher - Route Admin - SNI Admin - Scorecard Admin - Scorecard Viewer - Service Admin - Service Creator - Service Viewer - Upstream Admin - Vault Admin - Viewer entity_id: description: The ID of the entity. type: string format: uuid example: e67490ce-44dc-4cbd-b65e-b52c746fc26a entity_type_name: description: The type of entity. type: string example: Control Planes enum: - APIs - API Products - Application Auth Strategies - Audit Logs - Control Planes - Dashboards - DCR Providers - Identity - Mesh Control Planes - Networks - Portals - Service Hub entity_region: description: Region of the team. type: string example: eu enum: - us - eu - au - me - in - '*' description: The request schema for assigning a role. CreateSystemAccount: content: application/json: schema: x-speakeasy-entity: SystemAccount type: object properties: name: description: Name of the system account. type: string description: description: Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another. type: string konnect_managed: description: The system account is managed by Konnect (true/false). type: boolean required: - name - description description: The request schema to create a system account. UpdateSystemAccount: content: application/json: schema: x-speakeasy-entity: SystemAccount type: object properties: name: description: Name of the system account. type: string description: description: Description of the system account. type: string description: The request schema for the update system account request. UpdateSystemAccountAccessToken: content: application/json: schema: x-speakeasy-entity: SystemAccountAccessToken type: object properties: name: description: Name of the system account access token. type: string CreateSystemAccountAccessToken: content: application/json: schema: x-speakeasy-entity: SystemAccountAccessToken type: object properties: name: type: string expires_at: type: string format: date-time description: The request body to create a system account access token. AddSystemAccountToTeam: content: application/json: schema: x-speakeasy-entity: SystemAccountTeam type: object properties: id: description: ID of the system account. type: string format: uuid x-speakeasy-name-override: account_id default: null nullable: true x-speakeasy-param-computed: false description: The request schema for adding a system account to a team. UpdateAuditLogWebhook: description: The request schema to modify an audit log webhook. content: application/json: schema: x-speakeasy-entity: AuditLog type: object properties: endpoint: description: The endpoint that will receive audit log messages. type: string example: 'https://example.com/audit-logs' authorization: description: The value to include in the `Authorization` header when sending audit logs to the webhook. type: string example: Bearer sometoken enabled: description: Indicates if the data should be sent to the webhook. type: boolean example: true log_format: $ref: '#/components/schemas/LogFormat' skip_ssl_verification: description: |- Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads. We strongly recommend not setting this to 'true' as you are subject to man-in-the-middle and other attacks. This option should be considered only for self-signed SSL certificates used in a non-production environment. type: boolean example: false CreateAuditLogDestination: description: The request schema to create an audit log destination. content: application/json: schema: x-speakeasy-entity: AuditLogDestination type: object properties: name: description: The name of the audit log destination. type: string example: My Destination endpoint: description: The endpoint that will receive audit log messages. type: string example: 'https://example.com/audit-logs' authorization: description: The value to include in the `Authorization` header when sending audit logs to the webhook. type: string example: Bearer sometoken writeOnly: true log_format: $ref: '#/components/schemas/LogFormat' skip_ssl_verification: description: |- Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads. We strongly recommend not setting this to 'true' as you are subject to man-in-the-middle and other attacks. This option should be considered only for self-signed SSL certificates used in a non-production environment. type: boolean example: false required: - name - endpoint - log_format UpdateAuditLogDestination: description: The request schema to modify an audit log destination. content: application/json: schema: type: object properties: name: description: The name of the audit log destination. type: string example: My Destination endpoint: description: The endpoint that will receive audit log messages. type: string example: 'https://example.com/audit-logs' authorization: description: The value to include in the `Authorization` header when sending audit logs to the webhook. type: string example: Bearer sometoken writeOnly: true log_format: $ref: '#/components/schemas/LogFormat' skip_ssl_verification: description: |- Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads. We strongly recommend not setting this to 'true' as you are subject to man-in-the-middle and other attacks. This option should be considered only for self-signed SSL certificates used in a non-production environment. type: boolean example: false UpdateConsumer: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateConsumerPayload' CreateApiKey: required: true content: application/json: schema: $ref: '#/components/schemas/CreateApiKeyPayload' UpdateConsumerRealm: required: true content: application/json: schema: $ref: '#/components/schemas/ConsumerRealmUpdateRequest' CreateConsumerRealm: required: true content: application/json: schema: $ref: '#/components/schemas/ConsumerRealmCreateRequest' CreateConsumer: required: true content: application/json: schema: $ref: '#/components/schemas/ConsumerCreateRequest' ReplaceCMEK: description: CMEK to be replaced required: true content: application/json: schema: type: object properties: key_arn: $ref: '#/components/schemas/KMSARN' name: $ref: '#/components/schemas/CMEKName' description: $ref: '#/components/schemas/CMEKDescription' required: - key_arn - name CreateCatalogServiceRequest: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCatalogService' UpdateCatalogServiceRequest: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateCatalogService' CreateIntegrationInstanceRequest: required: true content: application/json: schema: $ref: '#/components/schemas/CreateIntegrationInstance' UpdateIntegrationInstanceRequest: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateIntegrationInstance' CreateIntegrationInstanceAuthCredentialRequest: required: true content: application/json: schema: $ref: '#/components/schemas/CreateIntegrationInstanceAuthCredential' UpsertIntegrationInstanceAuthConfigRequest: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertIntegrationInstanceAuthConfig' DataPlaneClientCertificateRequest: content: application/json: schema: type: object properties: cert: description: JSON escaped string of the certificate. type: string required: - cert description: Request body for creating a dp-client-certificate. create-plugin-schemas: content: application/json: schema: x-speakeasy-entity: GatewayCustomPluginSchema 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 = { } } } } }' required: - lua_schema CreateConfigStoreRequest: required: true content: application/json: schema: $ref: '#/components/schemas/CreateConfigStore' UpdateConfigStoreRequest: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateConfigStore' responses: RetrieveControlPlaneResponse: description: A response to retrieving a single control plane. content: application/json: schema: $ref: '#/components/schemas/ControlPlane' CreateControlPlaneResponse: description: A response to creating a control plane. content: application/json: schema: $ref: '#/components/schemas/ControlPlane' UpdateControlPlaneResponse: description: A response to updating a control plane. content: application/json: schema: $ref: '#/components/schemas/ControlPlane' ListControlPlanesResponse: description: A paginated list response for a collection of control planes. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/PaginatedMeta' data: type: array items: $ref: '#/components/schemas/ControlPlane' additionalProperties: false required: - meta - data title: ListControlPlanesResponse ControlPlanesBadRequest: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' ControlPlanePermissionDenied: description: Permission denied content: application/problem+json: schema: $ref: '#/components/schemas/ForbiddenError' ControlPlaneUnauthenticated: description: Unauthenticated content: application/problem+json: schema: $ref: '#/components/schemas/UnauthorizedError' ControlPlaneNotFound: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/NotFoundError' ControlPlaneConflict: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/ConflictError' InternalServerError: description: Internal Server Error content: application/problem+json: schema: description: The error response object. type: object properties: status: description: The HTTP status code. type: integer format: int32 example: 500 enum: - 500 x-go-type: int32 title: description: The error response code. type: string example: Internal Server Error instance: description: The Konnect traceback code type: string example: 'konnect:trace:2287285207635123011' detail: description: Details about the error. type: string example: Could not propagate control plane changes to control plane cluster service. required: - status - title - instance title: InternalServerError ServiceUnavailable: description: Service Unavailable content: application/problem+json: schema: description: Error response for temporary service unavailability. type: object properties: status: description: The HTTP status code. type: integer format: int32 example: 503 enum: - 503 x-go-type: int32 title: description: The error response code. type: string example: Service Unavailable instance: description: The Konnect traceback code type: string example: 'konnect:trace:2287285207635123011' detail: description: Details about the error. type: string example: Could not retrieve permissions to check resource accessibility. required: - status - title - instance title: ServiceUnavailableError Internal: description: Internal content: application/problem+json: schema: $ref: '#/components/schemas/BaseError' BadRequest: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' Unauthorized: description: Unauthorized content: application/problem+json: schema: description: The error response object. type: object properties: status: description: The HTTP status code. type: integer example: 403 title: description: The Error Response. type: string example: Unauthorized instance: description: The Konnect traceback code. type: string example: 'konnect:trace:952172606039454040' detail: description: Details about the error response. type: string example: You do not have permission to perform this action $ref: '#/components/schemas/UnauthorizedError' title: Unauthorized Response Forbidden: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/ForbiddenError' NotFound: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/NotFoundError' RetrieveConfigurationResponse: description: Response format for retrieving a configuration by ID. content: application/json: schema: $ref: '#/components/schemas/ConfigurationManifest' CreateConfigurationResponse: description: Response format for creating a configuration. content: application/json: schema: $ref: '#/components/schemas/ConfigurationManifest' RetrieveNetworkResponse: description: Response format for retrieving a network. content: application/json: schema: $ref: '#/components/schemas/Network' CreateNetworkResponse: description: Response format for creating a network. content: application/json: schema: $ref: '#/components/schemas/Network' PatchNetworkResponse: description: Response format for patching a network. content: application/json: schema: $ref: '#/components/schemas/Network' CreatePrivateDnsResponse: description: Response format for creating a Private DNS. content: application/json: schema: $ref: '#/components/schemas/PrivateDnsResponse' PatchPrivateDnsResponse: description: Response format for updating a Private DNS. content: application/json: schema: $ref: '#/components/schemas/PrivateDnsResponse' RetrievePrivateDnsResponse: description: Response format for retrieving a Private DNS. content: application/json: schema: $ref: '#/components/schemas/PrivateDnsResponse' CreateTransitGatewayResponse: description: Response format for creating a transit gateway. content: application/json: schema: $ref: '#/components/schemas/TransitGatewayResponse' RetrieveTransitGatewayResponse: description: Response format for retrieving a transit gateway. content: application/json: schema: $ref: '#/components/schemas/TransitGatewayResponse' ListProviderAccountsResponse: description: A paginated list for a collection of provider accounts. content: application/json: schema: x-speakeasy-entity: CloudGatewayProviderAccountList type: object properties: meta: $ref: '#/components/schemas/PaginatedMeta' data: type: array items: $ref: '#/components/schemas/ProviderAccount' required: - meta - data title: ListCloudGatewayProviderAccountsResponse CreateCustomDomainResponse: description: Response format for creating a custom domain for a control-plane in the global API. content: application/json: schema: $ref: '#/components/schemas/CustomDomain' RetrieveCustomDomainResponse: description: Response format for retrieving a custom domain for a control-plane. content: application/json: schema: $ref: '#/components/schemas/CustomDomain' CloudGatewaysBadRequest: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' CloudGatewaysForbidden: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/ForbiddenError' CloudGatewaysConflict: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/ConflictError' Conflict: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/ConflictError' RetrieveMeshControlPlaneResponse: description: A response to creating a control plane. content: application/json: schema: $ref: '#/components/schemas/MeshControlPlane' CreateMeshControlPlaneResponse: description: A response to creating a control plane. content: application/json: schema: $ref: '#/components/schemas/MeshControlPlane' CreateMeshControlPlaneValidationError: description: Validation Error content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' PutMeshControlPlaneValidationError: description: Validation Error content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' DeleteMeshControlPlaneValidationError: description: Validation Error content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' MeshControlPlaneForbiddenError: description: Permission denied content: application/problem+json: schema: $ref: '#/components/schemas/ForbiddenError' MeshControlPlaneUnauthorizedError: description: Unauthorized Error content: application/problem+json: schema: $ref: '#/components/schemas/UnauthorizedError' MeshControlPlaneNotFoundError: description: Not found content: application/problem+json: schema: $ref: '#/components/schemas/NotFoundError' PutMeshControlPlaneResponse: description: A response to updating a control plane. content: application/json: schema: $ref: '#/components/schemas/MeshControlPlane' ListMeshControlPlanesResponse: description: A paginated list response for a collection of control planes. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/PaginatedMeta' data: type: array items: $ref: '#/components/schemas/MeshControlPlane' title: ListMeshControlPlanesResponse SlugConflict: description: Conflict - `slug` property must be unique content: application/problem+json: schema: type: object properties: status: type: number title: type: string type: type: string instance: type: string required: - status - title - instance VersionSpecConflict: description: Conflict - only one version specification can exist content: application/problem+json: schema: $ref: '#/components/schemas/ConflictError' VersionSpecHiddenConflict: description: Conflict - name attribute must be unique accross legacy version specifications content: application/problem+json: schema: $ref: '#/components/schemas/ConflictError' ApiProductImplementationConflict: description: Conflict - V3 API is currently linked to the target gateway service content: application/problem+json: schema: $ref: '#/components/schemas/ConflictError' ApiProductUnauthorized: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/UnauthorizedError' ApiProductNotFound: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/NotFoundError' APIProductResponse: description: API product content: application/json: schema: $ref: '#/components/schemas/APIProduct' APIProductVersionResponse: description: API product content: application/json: schema: $ref: '#/components/schemas/APIProductVersion' APIProductDocumentResponse: description: API product document content: application/json: schema: $ref: '#/components/schemas/APIProductDocument' APIProductVersionSpecResponse: description: API product version specification content: application/json: schema: $ref: '#/components/schemas/APIProductVersionSpec' UnsupportedMediaType: description: Unsupported Media Type content: application/problem+json: schema: $ref: '#/components/schemas/UnsupportedMediaTypeError' PortalAuthenticationSettings: description: Details about a portal's authentication settings. content: application/json: schema: $ref: '#/components/schemas/PortalAuthenticationSettingsResponse' PortalTeam: description: Details about a team of developers in a portal. content: application/json: schema: $ref: '#/components/schemas/PortalTeamResponse' ListPortals: description: A paginated list of portals in the current region of an organization. content: application/json: schema: $ref: '#/components/schemas/ListPortalsResponse' PortalProductVersion: description: A response containing a portal product version content: application/json: schema: $ref: '#/components/schemas/PortalProductVersion' GetPortal: description: Details about a portal and its current settings. content: application/json: schema: $ref: '#/components/schemas/GetPortalResponse' UpdatePortal: description: Details about the portal being updated. content: application/json: schema: $ref: '#/components/schemas/UpdatePortalResponse' CreatePortal: description: Details about the portal that was created. content: application/json: schema: $ref: '#/components/schemas/CreatePortalResponse' GetPortalAppearance: description: Details about a portal's current appearance settings. content: application/json: schema: $ref: '#/components/schemas/GetPortalAppearanceResponse' UpdatePortalAppearance: description: Details about the appearance settings being updated. content: application/json: schema: $ref: '#/components/schemas/UpdatePortalAppearanceResponse' CreateAppAuthStrategy: description: A response containing the newly created application auth strategy object. content: application/json: schema: $ref: '#/components/schemas/CreateAppAuthStrategyResponse' GetAppAuthStrategy: description: A response containing a single application auth strategy object. content: application/json: schema: $ref: '#/components/schemas/GetAppAuthStrategyResponse' UpdateAppAuthStrategy: description: A response containing a single updated application auth strategy object. content: application/json: schema: $ref: '#/components/schemas/UpdateAppAuthStrategyResponse' TeamSingle: description: A response including a single team. content: application/json: schema: $ref: '#/components/schemas/Team' AssignedRoleSingle: description: A get action response of a single assigned role. content: application/json: schema: $ref: '#/components/schemas/AssignedRole' IdentityBadRequest: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' IdentityConflict: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/ConflictError' IdentityPermissionDenied: description: Permission denied content: application/problem+json: schema: $ref: '#/components/schemas/ForbiddenError' IdentityUnauthenticated: description: Unauthenticated content: application/problem+json: schema: $ref: '#/components/schemas/UnauthorizedError' IdentityNotFound: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/NotFoundError' SystemAccountSingle: description: A response including a single system account. content: application/json: schema: $ref: '#/components/schemas/SystemAccount' SystemAccountAccessTokenSingle: description: A response including a single system account access token. content: application/json: schema: $ref: '#/components/schemas/SystemAccountAccessToken' SystemAccountAccessTokenCreated: description: A response including a single system account access token with the token. content: application/json: schema: x-speakeasy-entity: SystemAccountAccessToken type: object properties: id: description: ID of the system account access token. type: string format: uuid readOnly: true name: description: Name of the system account access token. type: string created_at: description: Timestamp of when the system account access token was created. type: string format: date-time readOnly: true updated_at: description: Timestamp of when the system account access token was last updated. type: string format: date-time readOnly: true expires_at: description: Timestamp of when the system account access token will expire. type: string format: date-time readOnly: true last_used_at: description: Timestamp of when the system account access token was last used. type: string format: date-time readOnly: true token: description: The token of the system account access token. type: string readOnly: true x-speakeasy-param-sensitive: true example: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08 name: Sample Access Token created_at: '2022-08-01T14:16:09Z' updated_at: '2022-08-02T08:35:49Z' expires_at: '2022-12-31T12:52:23Z' last_used_at: '2022-10-24T13:05:42Z' title: System Account Access Token Created Response RetrieveServerlessCloudGatewayResponse: description: A response to retrieving a serverless cloud gateway. content: application/json: schema: $ref: '#/components/schemas/ServerlessCloudGateway' CreateServerlessCloudGatewayResponse: description: A response to creating a serverless cloud gateway. content: application/json: schema: $ref: '#/components/schemas/ServerlessCloudGateway' AuditLogWebhook: description: Get response for audit log webhook content: application/json: schema: type: object properties: endpoint: description: The endpoint that will receive audit log messages. type: string example: 'https://example.com/audit-logs' enabled: description: Indicates whether audit data should be sent to the webhook. type: boolean example: true log_format: $ref: '#/components/schemas/LogFormat' skip_ssl_verification: description: Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads. type: boolean example: false updated_at: description: 'Timestamp when this webhook was last updated. Initial value is 0001-01-01T00:00:0Z.' type: string format: date-time readOnly: true AuditLogDestinationSingle: description: Audit log destination response content: application/json: schema: $ref: '#/components/schemas/AuditLogDestination' WebhookBadRequest: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' AuditLogDestinationBadRequest: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' CreateConsumerResponse: description: success content: application/json: schema: $ref: '#/components/schemas/CentralizedConsumer' CreateConsumerRealmResponse: description: success content: application/json: schema: $ref: '#/components/schemas/ConsumerRealm' CMEK: description: A CMEK content: application/json: schema: $ref: '#/components/schemas/CMEK' CatalogServiceResponse: description: A response containing a single service object. content: application/json: schema: $ref: '#/components/schemas/CatalogService' IntegrationInstanceResponse: description: A response containing a single integration instance object. content: application/json: schema: $ref: '#/components/schemas/IntegrationInstance' IntegrationInstanceAuthCredentialResponse: description: A response containing an integration instance auth credential. content: application/json: schema: $ref: '#/components/schemas/IntegrationInstanceAuthCredential' IntegrationInstanceAuthConfigResponse: description: A response containing integration instance auth config. content: application/json: schema: $ref: '#/components/schemas/IntegrationInstanceAuthConfig' DataPlaneClientCertificateResponse: description: Response body for retrieving a dp-client-certificate. content: application/json: schema: type: object properties: item: $ref: '#/components/schemas/DataPlaneClientCertificate' plugin-schemas: description: A response for a single custom plugin schema. content: application/json: schema: type: object properties: item: x-speakeasy-entity: GatewayCustomPluginSchema 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 ConfigStoreResponse: description: Config Store content: application/json: schema: $ref: '#/components/schemas/ConfigStore' ConfigStoreUnauthorized: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/UnauthorizedError' ConfigStoreNotFound: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/NotFoundError' GetPluginSchemaResponse: description: The schema for the plugin content: application/json: schema: type: object properties: fields: type: array items: additionalProperties: true type: object HTTP401Error: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/GatewayUnauthorizedError' KonnectCPLegacyUnauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/KonnectCPLegacyUnauthorizedError' KonnectCPLegacyForbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/KonnectCPLegacyForbiddenError' KonnectCPLegacyNotFound: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/KonnectCPLegacyNotFoundError' KonnectCPLegacyBadRequest: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/KonnectCPLegacyBadRequestError' KonnectCPLegacyConflict: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/KonnectCPLegacyConflictError' securitySchemes: personalAccessToken: type: http scheme: bearer bearerFormat: Token description: The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard. systemAccountAccessToken: type: http scheme: bearer bearerFormat: Token description: | The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account. The access token must be passed in the header of a request, for example: `curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'` konnectAccessToken: type: http scheme: bearer bearerFormat: JWT description: The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with. serviceAccessToken: type: http scheme: bearer bearerFormat: JWT description: | The Service access token is meant to be used between internal services. tags: - name: Control Planes - name: Control Plane Groups - name: Data-Plane Group Configurations - name: Networks - name: Transit Gateways - name: Private DNS - name: Provider Accounts - name: Custom Domains - name: Mesh - name: API Products - name: API Product Documentation - name: API Product Versions - name: API Product Version Specification - name: Portals description: APIs related to Configuration of Konnect Developer Portals. - name: Portal Teams description: APIs related to Konnect Developer Portal Developer Teams. - name: Portal Auth Settings description: APIs related to Konnect Developer Portal Authentication Settings. - name: Portal Appearance description: APIs related to Konnect Developer Portal Appearance Settings. - name: Portal Product Versions description: | Portal Product Versions hold metadata that describes how a Product Version is configured for a specific portal. They contain: - Lifecyle and deprecation statuses - Application registration settings like auto approve or whether application registration is enabled - The authentication strategy that is enabled for Application Registration - name: App Auth Strategies description: | Application Auth Strategies are sets of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version. Called “Auth Strategy” for short in the context of portals/applications. The plugins are synced to any Gateway Service that is currently linked or becomes linked to the Product Version. - name: Roles - name: Team Membership - name: Teams - name: System Accounts - name: System Accounts - Access Tokens - name: System Accounts - Roles - name: System Accounts - Team Membership - name: Serverless Cloud Gateways - name: Audit Logs - name: Realms description: | Use a realm to group consumers around an identity, defined by organizational boundaries, such as a production realm or a development realm. Realms are connected to a [geographic region](https://docs.konghq.com/konnect/geo/) in Konnect. Centrally managed consumers defined in realms can be used across multiple control planes. - name: Centrally Managed Consumers description: | Consumers can be scoped to a Konnect region and managed centrally, or be scoped to a control plane in Gateway Manager. Use centrally managed consumers to set up identity of the consumer once, and share it across multiple control planes. Consumers that are managed centrally aren’t part of the configuration that is pushed down from the control plane to the data planes, so it reduces config size and latency. - name: Centrally Managed Keys description: | Centrally managed consumers use key-auth mechanism to authenticate consumers. Keys refer to the API key credential used by the consumer to authenticate to your services. - name: CMEK description: 'Customer Managed Encryption Keys (CMEK) are used to encrypt and decrypt sensitive data in Konnect. They allow you to manage your own encryption keys using AWS Key Management Service (KMS). CMEKs provide an additional layer of security and compliance for your Konnect deployments, ensuring that your data is encrypted with keys that you control. Avoid revoking or deleting a KMS key and CMEK that is actively used by Konnect, as this can lead to data loss or service disruptions.' - name: Catalog Services description: | Create and maintain a centralized catalog of all services running in your organization. Add custom fields and map resources from across your organization to provide a 360-degree overview of your services. Custom fields allow you to surface key information such as: - `Owner`: The person or team responsible for the service - `Product Manager`: The person assigned to guide the service's direction for customer success - `Jira Project`: The Jira project which represents past, present and future work for the service Resources are discovered from the integrations you use within your organization to create, operate and manage your services. Mapping the resources relevant to your service will provide a rich view of the service's communication channels, dependencies and more. Types of resources which you can map to a service include: - `Code Repositories:` The software project(s) that make up the service - `Monitors and Dashboards:` Tools providing visibility into the health and performance of the service - `Communication Channels`: Virtual spaces where questions and concerns can be raised about the service - `Incident Management Resources`: Alerts setup within your incident management platform to notify individuals regarding issues with the service - name: Integration Instances description: | An integration instance represents a specific account of the integration which contains the resources used to manage and support your services. Some integrations provide configuration options to customize how it should behave once authorized (see the integration's manifest for details). Konnect-internal integrations are built-in and do not need to be installed. Once an integration instance is created, authorize the instance to allow the Service Catalog to discover its resources. Note that deleting an integration instance is a **destructive** operation. When an integration instance is deleted, all its resources and mappings will be deleted from the service catalog. In cases where the integration instance's credentials need to be updated, you may re-authorize the instance to retain all currently discovered resources and mappings. To set up and view a list of all the integrations we support, please view our [documentation](https://developer.konghq.com/service-catalog/integrations/). - name: Integration Instance Auth Credentials description: | Represents the credentials use to authorize an integration instance. You will want to configure the integration instance settings and authorization configuration before authorizing the instance. This will inform the authorization process on how to reach and authorize the account. Once the integration instance is authorized, the system will automatically discover all the relevant resources from the account. The integration instance's auth credentials can be removed or updated while retaining all resources which have already been discovered. - name: Integration Instance Auth Config description: | A integration instance may need to be provided with an auth config before authorizing the instance. Typically an auth config will be required when authorizing against a integration which is hosted within your organization. The integration instance's auth config will inform how the Service Catalog will authorize the integration instance. Note that updating the auth config for an instance which is already authorized will **remove the existing credential**, requiring you to re-authorize the instance. - description: DP Certificates name: DP Certificates - description: Custom Plugin Schemas name: Custom Plugin Schemas - description: Config Stores name: Config Stores - name: ACLs - name: API-keys - name: Basic-auth credentials - description: |- A CA certificate object represents a trusted certificate authority. These objects are used by Kong Gateway to verify the validity of a client or server certificate. name: CA Certificates - description: | A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong Gateway to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service.

Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames.

If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string. name: Certificates - description: |- Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem. By grouping consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations. name: Consumer Groups - description: | The consumer object represents a consumer - or a user - of a service. You can either rely on Kong Gateway as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong Gateway and your existing primary datastore. name: Consumers - name: CustomPlugins - name: HMAC-auth credentials - name: JWTs - description: | A JSON Web key set. Key sets are the preferred way to expose keys to plugins because they tell the plugin where to look for keys or have a scoping mechanism to restrict plugins to specific keys. name: KeySets - description: | A key object holds a representation of asymmetric keys in various formats. When Kong Gateway or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity. name: Keys - name: MTLS-auth credentials - description: 'Some entities in Kong Gateway share common configuration settings that often need to be repeated. For example, multiple plugins that connect to Redis may require the same connection settings. Without Partials, you would need to replicate this configuration across all plugins. If the settings change, you would need to update each plugin individually.' name: Partials - description: |- A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. Plugins let you add functionality to services that run behind a Kong Gateway instance, like authentication or rate limiting. You can find more information about available plugins and which values each plugin accepts at the [Plugin Hub](https://developer.konghq.com/plugins/).

When adding a plugin configuration to a service, the plugin will run on every request made by a client to that service. If a plugin needs to be tuned to different values for some specific consumers, you can do so by creating a separate plugin instance that specifies both the service and the consumer, through the service and consumer fields. name: Plugins - description: | Route 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 the associated service. You need at least one matching rule that applies to the protocol being matched by the route.

The combination of routes and services, and the separation of concerns between them, offers a powerful routing mechanism with which it is possible to define fine-grained entrypoints in Kong Gateway leading to different upstream services of your infrastructure.

Depending on the protocol, one of the following attributes must be set:
- `http`: At least one of `methods`, `hosts`, `headers`, or `paths` - `https`: At least one of `methods`, `hosts`, `headers`, `paths`, or `snis` - `tcp`: At least one of `sources` or `destinations` - `tls`: at least one of `sources`, `destinations`, or `snis` - `tls_passthrough`: set `snis` - `grpc`: At least one of `hosts`, `headers`, or `paths` - `grpcs`: At least one of `hosts`, `headers`, `paths`, or `snis` - `ws`: At least one of `hosts`, `headers`, or `paths` - `wss`: At least one of `hosts`, `headers`, `paths`, or `snis`
A route can't have both `tls` and `tls_passthrough` protocols at same time.

Learn more about the router: - [Configure routes using expressions](https://developer.konghq.com/gateway/routing/expressions/) name: Routes - description: |- An SNI object represents a many-to-one mapping of hostnames to a certificate.

A certificate object can have many hostnames associated with it. When Kong Gateway receives an SSL request, it uses the SNI field in the Client Hello to look up the certificate object based on the SNI associated with the certificate. name: SNIs - description: | Service entities are abstractions of your microservice interfaces or formal APIs. For example, a service could be a data transformation microservice or a billing API.

The main attribute of a service is the destination URL for proxying traffic. This URL can be set as a single string or by specifying its protocol, host, port and path individually.

Services are associated to routes, and a single service can have many routes associated with it. Routes are entrypoints in Kong Gateway which define rules to match client requests. Once a route is matched, Kong Gateway proxies the request to its associated service. See the [Route documentation](https://developer.konghq.com/gateway/entities/route/) for a detailed explanation of how Kong proxies traffic.

Services can be both [tagged and filtered by tags](https://developer.konghq.com/admin-api/). name: Services - description: | A target is an IP address or 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`, or use the `DELETE` method to accomplish the same. name: Targets - description: |- The upstream object represents a virtual hostname and can be used to load balance incoming requests over multiple services (targets).

An upstream also includes a [health checker](https://developer.konghq.com/gateway/traffic-control/health-checks-circuit-breakers/), which can 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. name: Upstreams - description: | Vault objects are used to configure different vault connectors for [managing secrets](https://developer.konghq.com/gateway/secrets-management/). Configuring a vault lets you reference secrets from other entities. This allows for a proper separation of secrets and configuration and prevents secret sprawl.

For example, you could store a certificate and a key in a vault, then reference them from a certificate entity. This way, the certificate and key are not stored in the entity directly and are more secure.

Secrets rotation can be managed using [TTLs](https://developer.konghq.com/gateway/entities/vault/). name: Vaults externalDocs: description: Documentation for Kong Gateway and its APIs url: 'https://developer.konghq.com' security: - personalAccessToken: [] - systemAccountAccessToken: [] - konnectAccessToken: [] - serviceAccessToken: []