openapi: 3.1.0 info: title: Konnect API (BETA) version: 2.0.0 description: > This is a BETA specification. Endpoints in this specification may change with zero notice contact: name: Kong url: https://cloud.konghq.com 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 security: - personalAccessToken: [] - systemAccountAccessToken: [] - konnectAccessToken: [] tags: - name: Portals description: APIs related to configuration of Konnect Developer Portals. - name: Portal Custom Domains description: APIs related to configuration of Konnect Developer Portals custom domains. - name: Portal Customization description: APIs related to customization of Konnect Developer Portals. - name: Portal Auth Settings description: APIs related to configuration of Konnect Developer Portal auth settings. - name: Portal Teams description: APIs related to configuration of Konnect Developer Portal developer teams. - name: Pages description: APIs related to Konnect Developer Portal Custom Pages. - name: Snippets description: APIs related to Konnect Developer Portal Custom Snippets. - name: API - name: API Documentation - name: API Specification - name: API Publication - name: API Implementation - name: Mesh paths: /v3/portals: post: x-speakeasy-entity-operation: Portal#create x-unstable: true summary: Create Portal description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Creates a new developer portal scoped in this region for this organization. operationId: create-portal tags: - Portals requestBody: $ref: '#/components/requestBodies/CreatePortal' responses: '201': $ref: '#/components/responses/PortalResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /v3/portals/{portalId}: parameters: - schema: type: string format: uuid name: portalId in: path required: true description: ID of the portal. x-speakeasy-match: id get: x-speakeasy-entity-operation: Portal#read x-unstable: true summary: Fetch Portal description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Returns the configuration for a single developer portal, including the current visibility, access, and domain settings. operationId: get-portal tags: - Portals responses: '200': $ref: '#/components/responses/PortalResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' patch: x-speakeasy-entity-operation: Portal#update x-unstable: true summary: Update Portal description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Updates the configuration for a single portal including the visibility, access, and custom domain settings. operationId: update-portal requestBody: $ref: '#/components/requestBodies/UpdatePortal' tags: - Portals responses: '200': $ref: '#/components/responses/PortalResponse' '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' delete: x-speakeasy-entity-operation: Portal#delete x-unstable: true summary: Delete Portal parameters: - name: force in: query description: >- [Overlay change] Always cascade delete when being managed with declarative configuation schema: type: string const: 'true' required: true description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Deletes a single portal, along with all related entities. operationId: delete-portal tags: - Portals responses: '204': description: No Content '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /v3/portals/{portalId}/custom-domain: parameters: - $ref: '#/components/parameters/PortalId' get: x-speakeasy-entity-operation: PortalCustomDomain#read x-unstable: true summary: Get Custom Domain description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Get the custom domain associated to the portal. operationId: get-portal-custom-domain tags: - Portal Custom Domains responses: '200': $ref: '#/components/responses/PortalCustomDomain' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' post: x-speakeasy-entity-operation: PortalCustomDomain#create x-unstable: true summary: Create Custom Domain description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Creates the custom domain associated with the portal. Only one custom domain can be associated with a portal at a time. operationId: create-portal-custom-domain requestBody: $ref: '#/components/requestBodies/CreatePortalCustomDomain' tags: - Portal Custom Domains responses: '201': $ref: '#/components/responses/PortalCustomDomain' '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' patch: x-speakeasy-entity-operation: PortalCustomDomain#update x-unstable: true summary: Enable or Disable Domain description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Updates the portal domain associated with the portal. operationId: update-portal-custom-domain requestBody: $ref: '#/components/requestBodies/UpdatePortalCustomDomain' tags: - Portal Custom Domains responses: '200': $ref: '#/components/responses/PortalCustomDomain' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' delete: x-speakeasy-entity-operation: PortalCustomDomain#delete x-unstable: true operationId: delete-portal-custom-domain summary: Remove Domain description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Deletes the custom domain associated with the portal. tags: - Portal Custom Domains responses: '204': description: No Content '404': $ref: '#/components/responses/NotFound' /v3/portals/{portalId}/customization: get: x-speakeasy-entity-operation: PortalCustomization#read x-unstable: true summary: Get Customization description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Returns the portal customization options. operationId: get-portal-customization parameters: - $ref: '#/components/parameters/PortalId' tags: - Portal Customization responses: '200': $ref: '#/components/responses/PortalCustomizationResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' put: x-speakeasy-entity-operation: PortalCustomization#create,update x-unstable: true summary: Replace Customization description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Replace the portal customization options. operationId: replace-portal-customization parameters: - $ref: '#/components/parameters/PortalId' tags: - Portal Customization requestBody: $ref: '#/components/requestBodies/ReplacePortalCustomization' responses: '200': $ref: '#/components/responses/PortalCustomizationResponse' '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' /v3/portals/{portalId}/pages: post: x-speakeasy-entity-operation: PortalPage#create x-unstable: true summary: Create Page description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Creates a new custom page for this portal. Custom pages can be used to display static content, documentation, or other information to developers. Title and Description properties may be provided in the frontmatter section of `content`. If you set values in both the `POST` request _and_ in the frontmatter, the values in frontmatter will take precedence. operationId: create-portal-page requestBody: $ref: '#/components/requestBodies/CreatePortalPage' parameters: - $ref: '#/components/parameters/PortalId' tags: - Pages responses: '201': $ref: '#/components/responses/PortalPage' '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' /v3/portals/{portalId}/pages/{pageId}: get: x-speakeasy-entity-operation: PortalPage#read x-unstable: true summary: Fetch Page description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Returns the configuration of a single custom page for this portal. Custom pages can be used to display static content, documentation, or other information to developers. operationId: get-portal-page parameters: - $ref: '#/components/parameters/PortalId' - $ref: '#/components/parameters/PageId' tags: - Pages responses: '200': $ref: '#/components/responses/PortalPage' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' patch: x-speakeasy-entity-operation: PortalPage#update x-unstable: true summary: Update Page description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Updates the configuration of a single custom page for this portal. operationId: update-portal-page requestBody: $ref: '#/components/requestBodies/UpdatePortalPage' parameters: - $ref: '#/components/parameters/PortalId' - $ref: '#/components/parameters/PageId' tags: - Pages responses: '200': $ref: '#/components/responses/PortalPage' '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' delete: x-speakeasy-entity-operation: PortalPage#delete x-unstable: true summary: Delete Page description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Deletes a single custom page for this portal. operationId: delete-portal-page parameters: - $ref: '#/components/parameters/PortalId' - $ref: '#/components/parameters/PageId' tags: - Pages responses: '204': description: No Content '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /v3/portals/{portalId}/snippets: post: x-speakeasy-entity-operation: PortalSnippet#create x-unstable: true summary: Create Snippet description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Creates a new custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers. Title and Description properties may be provided in the frontmatter section of `content`. If you set values in both the `POST` request _and_ in the frontmatter, the values in the frontmatter will take precedence. operationId: create-portal-snippet requestBody: $ref: '#/components/requestBodies/CreatePortalSnippet' parameters: - $ref: '#/components/parameters/PortalId' tags: - Snippets responses: '201': $ref: '#/components/responses/PortalSnippet' '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' /v3/portals/{portalId}/snippets/{snippetId}: get: x-speakeasy-entity-operation: PortalSnippet#read x-unstable: true summary: Fetch Snippet description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Returns the configuration of a single custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers. operationId: get-portal-snippet parameters: - $ref: '#/components/parameters/PortalId' - $ref: '#/components/parameters/SnippetId' tags: - Snippets responses: '200': $ref: '#/components/responses/PortalSnippet' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' patch: x-speakeasy-entity-operation: PortalSnippet#update x-unstable: true summary: Update Snippet description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Updates the configuration of a single custom snippet for this portal. operationId: update-portal-snippet requestBody: $ref: '#/components/requestBodies/UpdatePortalSnippet' parameters: - $ref: '#/components/parameters/PortalId' - $ref: '#/components/parameters/SnippetId' tags: - Snippets responses: '200': $ref: '#/components/responses/PortalSnippet' '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' delete: x-speakeasy-entity-operation: PortalSnippet#delete x-unstable: true summary: Delete Snippet description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Deletes a single custom snippet for this portal. operationId: delete-portal-snippet parameters: - $ref: '#/components/parameters/PortalId' - $ref: '#/components/parameters/SnippetId' tags: - Snippets responses: '204': description: No Content '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' /v3/portals/{portalId}/authentication-settings: parameters: - $ref: '#/components/parameters/PortalId' get: x-unstable: true x-speakeasy-entity-operation: PortalAuth#read summary: Get Auth Settings description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Returns the developer authentication configuration for a portal, which determines how developers can log in and how they are assigned to teams. operationId: get-portal-authentication-settings tags: - Portal Auth Settings responses: '200': $ref: '#/components/responses/PortalAuthenticationSettings' '401': $ref: '#/components/responses/Unauthorized' patch: x-unstable: true x-speakeasy-entity-operation: PortalAuth#create,update summary: Update Auth Settings description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. 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. operationId: update-portal-authentication-settings requestBody: $ref: '#/components/requestBodies/UpdatePortalAuthenticationSettings' tags: - Portal Auth Settings 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' /v3/portals/{portalId}/teams: parameters: - $ref: '#/components/parameters/PortalId' post: x-unstable: true x-speakeasy-entity-operation: PortalTeam#create summary: Create Team operationId: create-portal-team 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 requestBody: $ref: '#/components/requestBodies/PortalCreateTeam' description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. 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. /v3/portals/{portalId}/teams/{teamId}: parameters: - $ref: '#/components/parameters/TeamId' - $ref: '#/components/parameters/PortalId' get: x-unstable: true x-speakeasy-entity-operation: PortalTeam#read summary: Get Team responses: '200': $ref: '#/components/responses/PortalTeam' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' operationId: get-portal-team description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Get an individual team. tags: - Portal Teams patch: x-unstable: true x-speakeasy-entity-operation: PortalTeam#update description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Updates an individual developer team for a portal. summary: Update Team operationId: update-portal-team responses: '200': $ref: '#/components/responses/PortalTeam' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' requestBody: $ref: '#/components/requestBodies/PortalUpdateTeam' tags: - Portal Teams delete: x-unstable: true x-speakeasy-entity-operation: PortalTeam#delete summary: Delete Team operationId: delete-portal-team description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. 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/apis: post: x-speakeasy-entity-operation: Api#create x-unstable: true summary: Create API description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Creates an API. operationId: create-api responses: '201': $ref: '#/components/responses/ApiResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API requestBody: $ref: '#/components/requestBodies/CreateApiRequest' /v3/apis/{apiId}: parameters: - schema: type: string format: uuid example: 9f5061ce-78f6-4452-9108-ad7c02821fd5 name: apiId in: path required: true description: The UUID API identifier x-speakeasy-match: id get: x-speakeasy-entity-operation: Api#read x-unstable: true summary: Fetch API description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Fetches an API. operationId: fetch-api responses: '200': $ref: '#/components/responses/ApiResponse' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' tags: - API patch: x-speakeasy-entity-operation: Api#update x-unstable: true summary: Update API description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Updates an API. operationId: update-api responses: '200': $ref: '#/components/responses/ApiResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API requestBody: $ref: '#/components/requestBodies/UpdateApiRequest' delete: x-speakeasy-entity-operation: Api#delete x-unstable: true summary: Delete API description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Deletes an API. operationId: delete-api responses: '204': description: API was deleted successfully. '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' tags: - API /v3/apis/{apiId}/documents: parameters: - $ref: '#/components/parameters/ApiId' post: x-speakeasy-entity-operation: ApiDocument#create x-unstable: true summary: Create API Document description: >- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Publish a new document attached to an API. All configuration options may be provided in the frontmatter section of `content`. If you set values in both the `POST` request _and_ in the frontmatter, the values in the `POST` request will take precedence. operationId: create-api-document responses: '201': $ref: '#/components/responses/ApiDocumentResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' '409': $ref: '#/components/responses/ApiSlugConflict' '415': $ref: '#/components/responses/UnsupportedMediaType' requestBody: $ref: '#/components/requestBodies/CreateApiDocumentRequest' tags: - API Documentation /v3/apis/{apiId}/documents/{documentId}: parameters: - $ref: '#/components/parameters/ApiId' - $ref: '#/components/parameters/DocumentId' get: x-speakeasy-entity-operation: ApiDocument#read x-unstable: true summary: Fetch API Document description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Returns a document for the API. operationId: fetch-api-document responses: '200': $ref: '#/components/responses/ApiDocumentResponse' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' tags: - API Documentation patch: x-speakeasy-entity-operation: ApiDocument#update x-unstable: true summary: Update API Document description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Updates a document for an API. operationId: update-api-document responses: '200': $ref: '#/components/responses/ApiDocumentResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' '409': $ref: '#/components/responses/ApiSlugConflict' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API Documentation requestBody: $ref: '#/components/requestBodies/UpdateApiDocumentRequest' delete: x-speakeasy-entity-operation: ApiDocument#delete x-unstable: true summary: Delete API Documentation description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Removes a document from an API. operationId: delete-api-document responses: '204': description: Document for the API was deleted successfully. '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' tags: - API Documentation /v3/apis/{apiId}/specifications: parameters: - $ref: '#/components/parameters/ApiId' post: x-speakeasy-entity-operation: ApiSpecification#create x-unstable: true summary: Create API Specification description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Creates a specification for an API. **Note:** You can only have one specification for an API. operationId: create-api-spec responses: '201': $ref: '#/components/responses/ApiSpecResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' '409': $ref: '#/components/responses/ApiSpecConflict' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API Specification requestBody: $ref: '#/components/requestBodies/CreateApiSpecRequest' /v3/apis/{apiId}/specifications/{specId}: parameters: - $ref: '#/components/parameters/ApiId' - $ref: '#/components/parameters/SpecId' get: x-speakeasy-entity-operation: ApiSpecification#read x-unstable: true summary: Fetch API Specification description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Fetches the specification of an API. operationId: fetch-api-spec responses: '200': $ref: '#/components/responses/ApiSpecResponse' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' tags: - API Specification patch: x-speakeasy-entity-operation: ApiSpecification#update x-unstable: true summary: Update API Specification description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Updates the specification of an API. operationId: update-api-spec responses: '200': $ref: '#/components/responses/ApiSpecResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' '409': $ref: '#/components/responses/ApiSpecHiddenConflict' '415': $ref: '#/components/responses/UnsupportedMediaType' tags: - API Specification requestBody: $ref: '#/components/requestBodies/UpdateApiSpecRequest' delete: x-speakeasy-entity-operation: ApiSpecification#delete x-unstable: true summary: Delete API Specification description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Deletes the specification of an API. operationId: delete-api-spec responses: '204': description: API Specification was deleted successfully. '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' tags: - API Specification /v3/apis/{apiId}/publications/{portalId}: parameters: - $ref: '#/components/parameters/ApiId' - $ref: '#/components/parameters/PortalId' put: x-speakeasy-entity-operation: ApiPublication#create,update x-unstable: true summary: Publish API description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Publish an API to a portal. operationId: publish-api-to-portal responses: '200': $ref: '#/components/responses/ApiPublicationResponse' '400': $ref: '#/components/responses/ApiPublicationBadRequest' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' tags: - API Publication requestBody: $ref: '#/components/requestBodies/PutApiPublicationRequest' get: x-speakeasy-entity-operation: ApiPublication#read x-unstable: true summary: Fetch Publication description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Retrieve an API's publication in a portal. If the API is not published to the portal, a 404 response is returned. operationId: fetch-publication responses: '200': $ref: '#/components/responses/ApiPublicationResponse' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' tags: - API Publication delete: x-speakeasy-entity-operation: ApiPublication#delete x-unstable: true summary: Delete Publication description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Unpublish an API from a portal. operationId: delete-publication responses: '204': description: API was successfully unpublished from portal. '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' tags: - API Publication /v3/apis/{apiId}/implementations: parameters: - $ref: '#/components/parameters/ApiId' post: x-speakeasy-entity-operation: ApiImplementation#create x-unstable: true summary: Create API Implementation description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Creates an implementation for an API. An API can be implemented by a single Gateway Service. operationId: create-api-implementation responses: '201': $ref: '#/components/responses/ApiImplementationResponse' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' '409': $ref: '#/components/responses/ApiImplementationConflict' tags: - API Implementation requestBody: $ref: '#/components/requestBodies/CreateApiImplementationRequest' /v3/apis/{apiId}/implementations/{implementationId}: parameters: - $ref: '#/components/parameters/ApiId' - $ref: '#/components/parameters/ImplementationId' get: x-speakeasy-entity-operation: ApiImplementation#read x-unstable: true summary: Fetch API Implementation description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Retrieve a gateway implementation for this API operationId: fetch-api-implementation responses: '200': $ref: '#/components/responses/ApiImplementationResponse' '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' tags: - API Implementation delete: x-speakeasy-entity-operation: ApiImplementation#delete x-unstable: true summary: Delete API Implementation description: |- **Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Unlink a gateway implementation from this API operationId: delete-api-implementation responses: '204': description: API implementation was unlinked successfully. '401': $ref: '#/components/responses/ApiUnauthorized' '403': $ref: '#/components/responses/ApiForbidden' '404': $ref: '#/components/responses/ApiNotFound' tags: - API Implementation /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshaccesslogs/{name}#create: get: operationId: getMeshAccessLog summary: Returns MeshAccessLog entity tags: - MeshAccessLog parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshAccessLog responses: '200': $ref: '#/components/responses/MeshAccessLogItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshAccessLog#get delete: operationId: deleteMeshAccessLog summary: Deletes MeshAccessLog entity tags: - MeshAccessLog parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshAccessLog responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshAccessLogDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshAccessLog#delete put: operationId: createMeshAccessLog summary: Creates or Updates MeshAccessLog entity tags: - MeshAccessLog parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshAccessLog requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshAccessLogItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshAccessLogCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshAccessLog#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshaccesslogs/{name}#update: put: operationId: updateMeshAccessLog summary: Creates or Updates MeshAccessLog entity tags: - MeshAccessLog parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshAccessLog requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshAccessLogItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshAccessLogCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshAccessLog#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshaccesslogs: get: operationId: getMeshAccessLogList summary: Returns a list of MeshAccessLog in the mesh. tags: - MeshAccessLog parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshAccessLogList' x-speakeasy-entity-operation: MeshAccessLogList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshcircuitbreakers/{name}#create: get: operationId: getMeshCircuitBreaker summary: Returns MeshCircuitBreaker entity tags: - MeshCircuitBreaker parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshCircuitBreaker responses: '200': $ref: '#/components/responses/MeshCircuitBreakerItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshCircuitBreaker#get delete: operationId: deleteMeshCircuitBreaker summary: Deletes MeshCircuitBreaker entity tags: - MeshCircuitBreaker parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshCircuitBreaker responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshCircuitBreakerDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshCircuitBreaker#delete put: operationId: createMeshCircuitBreaker summary: Creates or Updates MeshCircuitBreaker entity tags: - MeshCircuitBreaker parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshCircuitBreaker requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshCircuitBreakerItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshCircuitBreakerCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshCircuitBreaker#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshcircuitbreakers/{name}#update: put: operationId: updateMeshCircuitBreaker summary: Creates or Updates MeshCircuitBreaker entity tags: - MeshCircuitBreaker parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshCircuitBreaker requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshCircuitBreakerItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshCircuitBreakerCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshCircuitBreaker#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshcircuitbreakers: get: operationId: getMeshCircuitBreakerList summary: Returns a list of MeshCircuitBreaker in the mesh. tags: - MeshCircuitBreaker parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshCircuitBreakerList' x-speakeasy-entity-operation: MeshCircuitBreakerList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshfaultinjections/{name}#create: get: operationId: getMeshFaultInjection summary: Returns MeshFaultInjection entity tags: - MeshFaultInjection parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshFaultInjection responses: '200': $ref: '#/components/responses/MeshFaultInjectionItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshFaultInjection#get delete: operationId: deleteMeshFaultInjection summary: Deletes MeshFaultInjection entity tags: - MeshFaultInjection parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshFaultInjection responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshFaultInjectionDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshFaultInjection#delete put: operationId: createMeshFaultInjection summary: Creates or Updates MeshFaultInjection entity tags: - MeshFaultInjection parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshFaultInjection requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshFaultInjectionItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshFaultInjectionCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshFaultInjection#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshfaultinjections/{name}#update: put: operationId: updateMeshFaultInjection summary: Creates or Updates MeshFaultInjection entity tags: - MeshFaultInjection parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshFaultInjection requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshFaultInjectionItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshFaultInjectionCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshFaultInjection#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshfaultinjections: get: operationId: getMeshFaultInjectionList summary: Returns a list of MeshFaultInjection in the mesh. tags: - MeshFaultInjection parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshFaultInjectionList' x-speakeasy-entity-operation: MeshFaultInjectionList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshhealthchecks/{name}#create: get: operationId: getMeshHealthCheck summary: Returns MeshHealthCheck entity tags: - MeshHealthCheck parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshHealthCheck responses: '200': $ref: '#/components/responses/MeshHealthCheckItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshHealthCheck#get delete: operationId: deleteMeshHealthCheck summary: Deletes MeshHealthCheck entity tags: - MeshHealthCheck parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshHealthCheck responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshHealthCheckDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshHealthCheck#delete put: operationId: createMeshHealthCheck summary: Creates or Updates MeshHealthCheck entity tags: - MeshHealthCheck parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshHealthCheck requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshHealthCheckItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshHealthCheckCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshHealthCheck#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshhealthchecks/{name}#update: put: operationId: updateMeshHealthCheck summary: Creates or Updates MeshHealthCheck entity tags: - MeshHealthCheck parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshHealthCheck requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshHealthCheckItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshHealthCheckCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshHealthCheck#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshhealthchecks: get: operationId: getMeshHealthCheckList summary: Returns a list of MeshHealthCheck in the mesh. tags: - MeshHealthCheck parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshHealthCheckList' x-speakeasy-entity-operation: MeshHealthCheckList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshhttproutes/{name}#create: get: operationId: getMeshHTTPRoute summary: Returns MeshHTTPRoute entity tags: - MeshHTTPRoute parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshHTTPRoute responses: '200': $ref: '#/components/responses/MeshHTTPRouteItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshHTTPRoute#get delete: operationId: deleteMeshHTTPRoute summary: Deletes MeshHTTPRoute entity tags: - MeshHTTPRoute parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshHTTPRoute responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshHTTPRouteDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshHTTPRoute#delete put: operationId: createMeshHTTPRoute summary: Creates or Updates MeshHTTPRoute entity tags: - MeshHTTPRoute parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshHTTPRoute requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshHTTPRouteItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshHTTPRouteCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshHTTPRoute#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshhttproutes/{name}#update: put: operationId: updateMeshHTTPRoute summary: Creates or Updates MeshHTTPRoute entity tags: - MeshHTTPRoute parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshHTTPRoute requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshHTTPRouteItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshHTTPRouteCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshHTTPRoute#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshhttproutes: get: operationId: getMeshHTTPRouteList summary: Returns a list of MeshHTTPRoute in the mesh. tags: - MeshHTTPRoute parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshHTTPRouteList' x-speakeasy-entity-operation: MeshHTTPRouteList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshloadbalancingstrategies/{name}#create: get: operationId: getMeshLoadBalancingStrategy summary: Returns MeshLoadBalancingStrategy entity tags: - MeshLoadBalancingStrategy parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshLoadBalancingStrategy responses: '200': $ref: '#/components/responses/MeshLoadBalancingStrategyItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshLoadBalancingStrategy#get delete: operationId: deleteMeshLoadBalancingStrategy summary: Deletes MeshLoadBalancingStrategy entity tags: - MeshLoadBalancingStrategy parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshLoadBalancingStrategy responses: '200': content: application/json: schema: $ref: >- #/components/schemas/MeshLoadBalancingStrategyDeleteSuccessResponse description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshLoadBalancingStrategy#delete put: operationId: createMeshLoadBalancingStrategy summary: Creates or Updates MeshLoadBalancingStrategy entity tags: - MeshLoadBalancingStrategy parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshLoadBalancingStrategy requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshLoadBalancingStrategyItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshLoadBalancingStrategyCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshLoadBalancingStrategy#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshloadbalancingstrategies/{name}#update: put: operationId: updateMeshLoadBalancingStrategy summary: Creates or Updates MeshLoadBalancingStrategy entity tags: - MeshLoadBalancingStrategy parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshLoadBalancingStrategy requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshLoadBalancingStrategyItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshLoadBalancingStrategyCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshLoadBalancingStrategy#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshloadbalancingstrategies: get: operationId: getMeshLoadBalancingStrategyList summary: Returns a list of MeshLoadBalancingStrategy in the mesh. tags: - MeshLoadBalancingStrategy parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshLoadBalancingStrategyList' x-speakeasy-entity-operation: MeshLoadBalancingStrategyList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshmetrics/{name}#create: get: operationId: getMeshMetric summary: Returns MeshMetric entity tags: - MeshMetric parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshMetric responses: '200': $ref: '#/components/responses/MeshMetricItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshMetric#get delete: operationId: deleteMeshMetric summary: Deletes MeshMetric entity tags: - MeshMetric parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshMetric responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshMetricDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshMetric#delete put: operationId: createMeshMetric summary: Creates or Updates MeshMetric entity tags: - MeshMetric parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshMetric requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshMetricItem' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/MeshMetricCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshMetric#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshmetrics/{name}#update: put: operationId: updateMeshMetric summary: Creates or Updates MeshMetric entity tags: - MeshMetric parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshMetric requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshMetricItem' responses: '200': description: Updated content: application/json: schema: $ref: '#/components/schemas/MeshMetricCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshMetric#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshmetrics: get: operationId: getMeshMetricList summary: Returns a list of MeshMetric in the mesh. tags: - MeshMetric parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshMetricList' x-speakeasy-entity-operation: MeshMetricList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshpassthroughs/{name}#create: get: operationId: getMeshPassthrough summary: Returns MeshPassthrough entity tags: - MeshPassthrough parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshPassthrough responses: '200': $ref: '#/components/responses/MeshPassthroughItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshPassthrough#get delete: operationId: deleteMeshPassthrough summary: Deletes MeshPassthrough entity tags: - MeshPassthrough parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshPassthrough responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshPassthroughDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshPassthrough#delete put: operationId: createMeshPassthrough summary: Creates or Updates MeshPassthrough entity tags: - MeshPassthrough parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshPassthrough requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshPassthroughItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshPassthroughCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshPassthrough#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshpassthroughs/{name}#update: put: operationId: updateMeshPassthrough summary: Creates or Updates MeshPassthrough entity tags: - MeshPassthrough parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshPassthrough requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshPassthroughItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshPassthroughCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshPassthrough#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshpassthroughs: get: operationId: getMeshPassthroughList summary: Returns a list of MeshPassthrough in the mesh. tags: - MeshPassthrough parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshPassthroughList' x-speakeasy-entity-operation: MeshPassthroughList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshproxypatches/{name}#create: get: operationId: getMeshProxyPatch summary: Returns MeshProxyPatch entity tags: - MeshProxyPatch parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshProxyPatch responses: '200': $ref: '#/components/responses/MeshProxyPatchItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshProxyPatch#get delete: operationId: deleteMeshProxyPatch summary: Deletes MeshProxyPatch entity tags: - MeshProxyPatch parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshProxyPatch responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshProxyPatchDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshProxyPatch#delete put: operationId: createMeshProxyPatch summary: Creates or Updates MeshProxyPatch entity tags: - MeshProxyPatch parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshProxyPatch requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshProxyPatchItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshProxyPatchCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshProxyPatch#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshproxypatches/{name}#update: put: operationId: updateMeshProxyPatch summary: Creates or Updates MeshProxyPatch entity tags: - MeshProxyPatch parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshProxyPatch requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshProxyPatchItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshProxyPatchCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshProxyPatch#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshproxypatches: get: operationId: getMeshProxyPatchList summary: Returns a list of MeshProxyPatch in the mesh. tags: - MeshProxyPatch parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshProxyPatchList' x-speakeasy-entity-operation: MeshProxyPatchList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshratelimits/{name}#create: get: operationId: getMeshRateLimit summary: Returns MeshRateLimit entity tags: - MeshRateLimit parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshRateLimit responses: '200': $ref: '#/components/responses/MeshRateLimitItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshRateLimit#get delete: operationId: deleteMeshRateLimit summary: Deletes MeshRateLimit entity tags: - MeshRateLimit parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshRateLimit responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshRateLimitDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshRateLimit#delete put: operationId: createMeshRateLimit summary: Creates or Updates MeshRateLimit entity tags: - MeshRateLimit parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshRateLimit requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshRateLimitItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshRateLimitCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshRateLimit#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshratelimits/{name}#update: put: operationId: updateMeshRateLimit summary: Creates or Updates MeshRateLimit entity tags: - MeshRateLimit parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshRateLimit requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshRateLimitItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshRateLimitCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshRateLimit#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshratelimits: get: operationId: getMeshRateLimitList summary: Returns a list of MeshRateLimit in the mesh. tags: - MeshRateLimit parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshRateLimitList' x-speakeasy-entity-operation: MeshRateLimitList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshretries/{name}#create: get: operationId: getMeshRetry summary: Returns MeshRetry entity tags: - MeshRetry parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshRetry responses: '200': $ref: '#/components/responses/MeshRetryItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshRetry#get delete: operationId: deleteMeshRetry summary: Deletes MeshRetry entity tags: - MeshRetry parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshRetry responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshRetryDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshRetry#delete put: operationId: createMeshRetry summary: Creates or Updates MeshRetry entity tags: - MeshRetry parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshRetry requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshRetryItem' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/MeshRetryCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshRetry#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshretries/{name}#update: put: operationId: updateMeshRetry summary: Creates or Updates MeshRetry entity tags: - MeshRetry parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshRetry requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshRetryItem' responses: '200': description: Updated content: application/json: schema: $ref: '#/components/schemas/MeshRetryCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshRetry#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshretries: get: operationId: getMeshRetryList summary: Returns a list of MeshRetry in the mesh. tags: - MeshRetry parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshRetryList' x-speakeasy-entity-operation: MeshRetryList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtcproutes/{name}#create: get: operationId: getMeshTCPRoute summary: Returns MeshTCPRoute entity tags: - MeshTCPRoute parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTCPRoute responses: '200': $ref: '#/components/responses/MeshTCPRouteItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshTCPRoute#get delete: operationId: deleteMeshTCPRoute summary: Deletes MeshTCPRoute entity tags: - MeshTCPRoute parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTCPRoute responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshTCPRouteDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshTCPRoute#delete put: operationId: createMeshTCPRoute summary: Creates or Updates MeshTCPRoute entity tags: - MeshTCPRoute parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTCPRoute requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshTCPRouteItem' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/MeshTCPRouteCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshTCPRoute#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtcproutes/{name}#update: put: operationId: updateMeshTCPRoute summary: Creates or Updates MeshTCPRoute entity tags: - MeshTCPRoute parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTCPRoute requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshTCPRouteItem' responses: '200': description: Updated content: application/json: schema: $ref: '#/components/schemas/MeshTCPRouteCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshTCPRoute#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtcproutes: get: operationId: getMeshTCPRouteList summary: Returns a list of MeshTCPRoute in the mesh. tags: - MeshTCPRoute parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshTCPRouteList' x-speakeasy-entity-operation: MeshTCPRouteList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtimeouts/{name}#create: get: operationId: getMeshTimeout summary: Returns MeshTimeout entity tags: - MeshTimeout parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTimeout responses: '200': $ref: '#/components/responses/MeshTimeoutItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshTimeout#get delete: operationId: deleteMeshTimeout summary: Deletes MeshTimeout entity tags: - MeshTimeout parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTimeout responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshTimeoutDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshTimeout#delete put: operationId: createMeshTimeout summary: Creates or Updates MeshTimeout entity tags: - MeshTimeout parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTimeout requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshTimeoutItem' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/MeshTimeoutCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshTimeout#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtimeouts/{name}#update: put: operationId: updateMeshTimeout summary: Creates or Updates MeshTimeout entity tags: - MeshTimeout parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTimeout requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshTimeoutItem' responses: '200': description: Updated content: application/json: schema: $ref: '#/components/schemas/MeshTimeoutCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshTimeout#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtimeouts: get: operationId: getMeshTimeoutList summary: Returns a list of MeshTimeout in the mesh. tags: - MeshTimeout parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshTimeoutList' x-speakeasy-entity-operation: MeshTimeoutList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtlses/{name}#create: get: operationId: getMeshTLS summary: Returns MeshTLS entity tags: - MeshTLS parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTLS responses: '200': $ref: '#/components/responses/MeshTLSItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshTLS#get delete: operationId: deleteMeshTLS summary: Deletes MeshTLS entity tags: - MeshTLS parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTLS responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshTLSDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshTLS#delete put: operationId: createMeshTLS summary: Creates or Updates MeshTLS entity tags: - MeshTLS parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTLS requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshTLSItem' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/MeshTLSCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshTLS#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtlses/{name}#update: put: operationId: updateMeshTLS summary: Creates or Updates MeshTLS entity tags: - MeshTLS parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTLS requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshTLSItem' responses: '200': description: Updated content: application/json: schema: $ref: '#/components/schemas/MeshTLSCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshTLS#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtlses: get: operationId: getMeshTLSList summary: Returns a list of MeshTLS in the mesh. tags: - MeshTLS parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshTLSList' x-speakeasy-entity-operation: MeshTLSList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtraces/{name}#create: get: operationId: getMeshTrace summary: Returns MeshTrace entity tags: - MeshTrace parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTrace responses: '200': $ref: '#/components/responses/MeshTraceItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshTrace#get delete: operationId: deleteMeshTrace summary: Deletes MeshTrace entity tags: - MeshTrace parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTrace responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshTraceDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshTrace#delete put: operationId: createMeshTrace summary: Creates or Updates MeshTrace entity tags: - MeshTrace parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTrace requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshTraceItem' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/MeshTraceCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshTrace#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtraces/{name}#update: put: operationId: updateMeshTrace summary: Creates or Updates MeshTrace entity tags: - MeshTrace parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTrace requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshTraceItem' responses: '200': description: Updated content: application/json: schema: $ref: '#/components/schemas/MeshTraceCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshTrace#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtraces: get: operationId: getMeshTraceList summary: Returns a list of MeshTrace in the mesh. tags: - MeshTrace parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshTraceList' x-speakeasy-entity-operation: MeshTraceList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtrafficpermissions/{name}#create: get: operationId: getMeshTrafficPermission summary: Returns MeshTrafficPermission entity tags: - MeshTrafficPermission parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTrafficPermission responses: '200': $ref: '#/components/responses/MeshTrafficPermissionItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshTrafficPermission#get delete: operationId: deleteMeshTrafficPermission summary: Deletes MeshTrafficPermission entity tags: - MeshTrafficPermission parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTrafficPermission responses: '200': content: application/json: schema: $ref: >- #/components/schemas/MeshTrafficPermissionDeleteSuccessResponse description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshTrafficPermission#delete put: operationId: createMeshTrafficPermission summary: Creates or Updates MeshTrafficPermission entity tags: - MeshTrafficPermission parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTrafficPermission requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshTrafficPermissionItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshTrafficPermissionCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshTrafficPermission#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtrafficpermissions/{name}#update: put: operationId: updateMeshTrafficPermission summary: Creates or Updates MeshTrafficPermission entity tags: - MeshTrafficPermission parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshTrafficPermission requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshTrafficPermissionItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshTrafficPermissionCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshTrafficPermission#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshtrafficpermissions: get: operationId: getMeshTrafficPermissionList summary: Returns a list of MeshTrafficPermission in the mesh. tags: - MeshTrafficPermission parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshTrafficPermissionList' x-speakeasy-entity-operation: MeshTrafficPermissionList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{name}: get: operationId: getMesh summary: Returns Mesh entity tags: - Mesh parameters: - in: path name: name schema: type: string required: true description: name of the Mesh responses: '200': $ref: '#/components/responses/MeshItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: Mesh#get put: operationId: putMesh summary: Creates or Updates Mesh entity tags: - Mesh parameters: - in: path name: name schema: type: string required: true description: name of the Mesh requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshItem' responses: '200': description: Updated content: application/json: schema: $ref: '#/components/schemas/MeshCreateOrUpdateSuccessResponse' '201': description: Created content: application/json: schema: $ref: '#/components/schemas/MeshCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: Mesh#create,update delete: operationId: deleteMesh summary: Deletes Mesh entity tags: - Mesh parameters: - in: path name: name schema: type: string required: true description: name of the Mesh responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: Mesh#delete parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes: get: operationId: getMeshList summary: Returns a list of Mesh in the mesh. tags: - Mesh parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns responses: '200': $ref: '#/components/responses/MeshList' x-speakeasy-entity-operation: MeshList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshgateways/{name}#create: get: operationId: getMeshGateway summary: Returns MeshGateway entity tags: - MeshGateway parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshGateway responses: '200': $ref: '#/components/responses/MeshGatewayItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshGateway#get delete: operationId: deleteMeshGateway summary: Deletes MeshGateway entity tags: - MeshGateway parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshGateway responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshGatewayDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshGateway#delete put: operationId: createMeshGateway summary: Creates or Updates MeshGateway entity tags: - MeshGateway parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshGateway requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshGatewayItem' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/MeshGatewayCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshGateway#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshgateways/{name}#update: put: operationId: updateMeshGateway summary: Creates or Updates MeshGateway entity tags: - MeshGateway parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshGateway requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshGatewayItem' responses: '200': description: Updated content: application/json: schema: $ref: '#/components/schemas/MeshGatewayCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshGateway#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshgateways: get: operationId: getMeshGatewayList summary: Returns a list of MeshGateway in the mesh. tags: - MeshGateway parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshGatewayList' x-speakeasy-entity-operation: MeshGatewayList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/hostnamegenerators/{name}#create: get: operationId: getHostnameGenerator summary: Returns HostnameGenerator entity tags: - HostnameGenerator parameters: - in: path name: name schema: type: string required: true description: name of the HostnameGenerator responses: '200': $ref: '#/components/responses/HostnameGeneratorItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshHostnameGenerator#get delete: operationId: deleteHostnameGenerator summary: Deletes HostnameGenerator entity tags: - HostnameGenerator parameters: - in: path name: name schema: type: string required: true description: name of the HostnameGenerator responses: '200': content: application/json: schema: $ref: '#/components/schemas/HostnameGeneratorDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshHostnameGenerator#delete put: operationId: createHostnameGenerator summary: Creates or Updates HostnameGenerator entity tags: - HostnameGenerator parameters: - in: path name: name schema: type: string required: true description: name of the HostnameGenerator requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/HostnameGeneratorItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/HostnameGeneratorCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshHostnameGenerator#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/hostnamegenerators/{name}#update: put: operationId: updateHostnameGenerator summary: Creates or Updates HostnameGenerator entity tags: - HostnameGenerator parameters: - in: path name: name schema: type: string required: true description: name of the HostnameGenerator requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/HostnameGeneratorItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/HostnameGeneratorCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshHostnameGenerator#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/hostnamegenerators: get: operationId: getHostnameGeneratorList summary: Returns a list of HostnameGenerator in the mesh. tags: - HostnameGenerator parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns responses: '200': $ref: '#/components/responses/HostnameGeneratorList' x-speakeasy-entity-operation: HostnameGeneratorList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshexternalservices/{name}#create: get: operationId: getMeshExternalService summary: Returns MeshExternalService entity tags: - MeshExternalService parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshExternalService responses: '200': $ref: '#/components/responses/MeshExternalServiceItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshExternalService#get delete: operationId: deleteMeshExternalService summary: Deletes MeshExternalService entity tags: - MeshExternalService parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshExternalService responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshExternalServiceDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshExternalService#delete put: operationId: createMeshExternalService summary: Creates or Updates MeshExternalService entity tags: - MeshExternalService parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshExternalService requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshExternalServiceItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshExternalServiceCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshExternalService#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshexternalservices/{name}#update: put: operationId: updateMeshExternalService summary: Creates or Updates MeshExternalService entity tags: - MeshExternalService parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshExternalService requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshExternalServiceItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshExternalServiceCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshExternalService#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshexternalservices: get: operationId: getMeshExternalServiceList summary: Returns a list of MeshExternalService in the mesh. tags: - MeshExternalService parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshExternalServiceList' x-speakeasy-entity-operation: MeshExternalServiceList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshmultizoneservices/{name}#create: get: operationId: getMeshMultiZoneService summary: Returns MeshMultiZoneService entity tags: - MeshMultiZoneService parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshMultiZoneService responses: '200': $ref: '#/components/responses/MeshMultiZoneServiceItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshMultiZoneService#get delete: operationId: deleteMeshMultiZoneService summary: Deletes MeshMultiZoneService entity tags: - MeshMultiZoneService parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshMultiZoneService responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshMultiZoneServiceDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshMultiZoneService#delete put: operationId: createMeshMultiZoneService summary: Creates or Updates MeshMultiZoneService entity tags: - MeshMultiZoneService parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshMultiZoneService requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshMultiZoneServiceItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshMultiZoneServiceCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshMultiZoneService#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshmultizoneservices/{name}#update: put: operationId: updateMeshMultiZoneService summary: Creates or Updates MeshMultiZoneService entity tags: - MeshMultiZoneService parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshMultiZoneService requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshMultiZoneServiceItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshMultiZoneServiceCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshMultiZoneService#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshmultizoneservices: get: operationId: getMeshMultiZoneServiceList summary: Returns a list of MeshMultiZoneService in the mesh. tags: - MeshMultiZoneService parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshMultiZoneServiceList' x-speakeasy-entity-operation: MeshMultiZoneServiceList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshservices/{name}#create: get: operationId: getMeshService summary: Returns MeshService entity tags: - MeshService parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshService responses: '200': $ref: '#/components/responses/MeshServiceItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshService#get delete: operationId: deleteMeshService summary: Deletes MeshService entity tags: - MeshService parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshService responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshServiceDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshService#delete put: operationId: createMeshService summary: Creates or Updates MeshService entity tags: - MeshService parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshService requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshServiceItem' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/MeshServiceCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshService#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshservices/{name}#update: put: operationId: updateMeshService summary: Creates or Updates MeshService entity tags: - MeshService parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshService requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshServiceItem' responses: '200': description: Updated content: application/json: schema: $ref: '#/components/schemas/MeshServiceCreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshService#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshservices: get: operationId: getMeshServiceList summary: Returns a list of MeshService in the mesh. tags: - MeshService parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshServiceList' x-speakeasy-entity-operation: MeshServiceList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshglobalratelimits/{name}#create: get: operationId: getMeshGlobalRateLimit summary: Returns MeshGlobalRateLimit entity tags: - MeshGlobalRateLimit parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshGlobalRateLimit responses: '200': $ref: '#/components/responses/MeshGlobalRateLimitItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshGlobalRateLimit#get delete: operationId: deleteMeshGlobalRateLimit summary: Deletes MeshGlobalRateLimit entity tags: - MeshGlobalRateLimit parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshGlobalRateLimit responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshGlobalRateLimitDeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshGlobalRateLimit#delete put: operationId: createMeshGlobalRateLimit summary: Creates or Updates MeshGlobalRateLimit entity tags: - MeshGlobalRateLimit parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshGlobalRateLimit requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshGlobalRateLimitItem' responses: '201': description: Created content: application/json: schema: $ref: >- #/components/schemas/MeshGlobalRateLimitCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshGlobalRateLimit#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshglobalratelimits/{name}#update: put: operationId: updateMeshGlobalRateLimit summary: Creates or Updates MeshGlobalRateLimit entity tags: - MeshGlobalRateLimit parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshGlobalRateLimit requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshGlobalRateLimitItem' responses: '200': description: Updated content: application/json: schema: $ref: >- #/components/schemas/MeshGlobalRateLimitCreateOrUpdateSuccessResponse x-speakeasy-entity-operation: MeshGlobalRateLimit#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshglobalratelimits: get: operationId: getMeshGlobalRateLimitList summary: Returns a list of MeshGlobalRateLimit in the mesh. tags: - MeshGlobalRateLimit parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshGlobalRateLimitList' x-speakeasy-entity-operation: MeshGlobalRateLimitList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshopas/{name}#create: get: operationId: getMeshOPA summary: Returns MeshOPA entity tags: - MeshOPA parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshOPA responses: '200': $ref: '#/components/responses/MeshOPAItem' '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshOPA#get delete: operationId: deleteMeshOPA summary: Deletes MeshOPA entity tags: - MeshOPA parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshOPA responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeshOPADeleteSuccessResponse' description: Successful response '404': $ref: '#/components/responses/NotFound' x-speakeasy-entity-operation: MeshOPA#delete put: operationId: createMeshOPA summary: Creates or Updates MeshOPA entity tags: - MeshOPA parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshOPA requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshOPAItem' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/MeshOPACreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshOPA#create parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshopas/{name}#update: put: operationId: updateMeshOPA summary: Creates or Updates MeshOPA entity tags: - MeshOPA parameters: - in: path name: mesh schema: type: string required: true description: name of the mesh - in: path name: name schema: type: string required: true description: name of the MeshOPA requestBody: description: Put request required: true content: application/json: schema: $ref: '#/components/schemas/MeshOPAItem' responses: '200': description: Updated content: application/json: schema: $ref: '#/components/schemas/MeshOPACreateOrUpdateSuccessResponse' x-speakeasy-entity-operation: MeshOPA#update parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshopas: get: operationId: getMeshOPAList summary: Returns a list of MeshOPA in the mesh. tags: - MeshOPA parameters: - in: query name: offset description: offset in the list of entities required: false schema: type: integer example: 0 - in: query name: size description: the number of items per page required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 - in: query name: filter description: filter by labels when multiple filters are present, they are ANDed required: false schema: type: object properties: key: type: string value: type: string example: label.k8s.kuma.io/namespace: my-ns - in: path name: mesh schema: type: string required: true description: name of the mesh responses: '200': $ref: '#/components/responses/MeshOPAList' x-speakeasy-entity-operation: MeshOPAList#get parameters: - $ref: '#/components/parameters/cpId' /v1/mesh/control-planes: post: x-speakeasy-entity-operation: MeshControlPlane#create summary: Create a new control plane description: Create a new control plane operationId: create-cp tags: - Mesh 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' /v1/mesh/control-planes/{cpId}: parameters: - name: cpId in: path required: true description: Id of the Konnect resource example: bf138ba2-c9b1-4229-b268-04d9d8a6410b schema: type: string format: uuid x-speakeasy-match: id x-speakeasy-param-suppress-computed-diff: true get: x-speakeasy-entity-operation: MeshControlPlane#read summary: Get the control plane description: Get the control plane operationId: get-mesh-control-plane tags: - Mesh responses: '200': $ref: '#/components/responses/RetrieveMeshControlPlaneResponse' '401': $ref: '#/components/responses/MeshControlPlaneUnauthorizedError' '403': $ref: '#/components/responses/MeshControlPlaneForbiddenError' '404': $ref: '#/components/responses/MeshControlPlaneNotFoundError' delete: x-speakeasy-entity-operation: MeshControlPlane#delete summary: Delete the control plane description: Delete the control plane operationId: delete-mesh-control-plane tags: - Mesh responses: '204': description: No Content '401': $ref: '#/components/responses/MeshControlPlaneUnauthorizedError' '403': $ref: '#/components/responses/MeshControlPlaneForbiddenError' '404': $ref: '#/components/responses/MeshControlPlaneNotFoundError' put: x-speakeasy-entity-operation: MeshControlPlane#update summary: Update a whole control plane description: Update a whole control plane operationId: update-cp tags: - Mesh 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' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PutMeshControlPlaneRequest' components: requestBodies: CreatePortalCustomDomain: description: Create a portal custom domain. required: true content: application/json: schema: $ref: '#/components/schemas/CreatePortalCustomDomainRequest' UpdatePortalCustomDomain: description: Create a portal custom domain. required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePortalCustomDomainRequest' CreatePortal: description: Create a portal. required: true content: application/json: schema: title: Portal type: object additionalProperties: false properties: id: $ref: '#/components/schemas/UUID' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' name: type: string maxLength: 255 minLength: 1 description: >- The name of the portal, used to distinguish it from other portals. Name must be unique. display_name: type: string maxLength: 255 minLength: 1 description: >- The display name of the portal. This value will be the portal's `name` in Portal API. description: type: string nullable: true maxLength: 512 description: A description of the portal. authentication_enabled: type: boolean description: >- Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. rbac_enabled: type: boolean description: >- Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. default_api_visibility: type: string description: >- The default visibility of APIs in the portal. If set to `public`, newly published APIs are visible to unauthenticated developers. If set to `private`, newly published APIs are hidden from unauthenticated developers. enum: - public - private default_page_visibility: type: string description: >- The default visibility of pages in the portal. If set to `public`, newly created pages are visible to unauthenticated developers. If set to `private`, newly created pages are hidden from unauthenticated developers. enum: - public - private default_application_auth_strategy_id: type: string format: uuid description: >- The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to `null`, API publications will not use an authentication strategy unless set during publication. DCR support for Auth Strategies is currently in development. nullable: true auto_approve_developers: type: boolean description: >- Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. auto_approve_applications: type: boolean description: >- Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. 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 canonical_domain: type: string format: hostname description: The canonical domain of the developer portal nullable: false readOnly: true labels: $ref: '#/components/schemas/LabelsUpdate' required: - name UpdatePortal: description: Update a portal's settings. required: true content: application/json: schema: title: Portal type: object additionalProperties: false properties: id: $ref: '#/components/schemas/UUID' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' name: type: string maxLength: 255 minLength: 1 description: >- The name of the portal, used to distinguish it from other portals. Name must be unique. display_name: type: string maxLength: 255 minLength: 1 description: >- The display name of the portal. This value will be the portal's `name` in Portal API. description: type: string nullable: true maxLength: 512 description: A description of the portal. authentication_enabled: type: boolean description: >- Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. rbac_enabled: type: boolean description: >- Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. default_api_visibility: type: string description: >- The default visibility of APIs in the portal. If set to `public`, newly published APIs are visible to unauthenticated developers. If set to `private`, newly published APIs are hidden from unauthenticated developers. enum: - public - private default_page_visibility: type: string description: >- The default visibility of pages in the portal. If set to `public`, newly created pages are visible to unauthenticated developers. If set to `private`, newly created pages are hidden from unauthenticated developers. enum: - public - private default_application_auth_strategy_id: type: string format: uuid description: >- The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to `null`, API publications will not use an authentication strategy unless set during publication. DCR support for Auth Strategies is currently in development. nullable: true auto_approve_developers: type: boolean description: >- Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. auto_approve_applications: type: boolean description: >- Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. 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 canonical_domain: type: string format: hostname description: The canonical domain of the developer portal nullable: false readOnly: true labels: $ref: '#/components/schemas/LabelsUpdate' ReplacePortalCustomization: content: application/json: schema: $ref: '#/components/schemas/PortalCustomization' CreatePortalPage: description: Create a page in a portal. required: true content: application/json: schema: $ref: '#/components/schemas/CreatePortalPageRequest' UpdatePortalPage: description: Update a page in a portal. required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePortalPageRequest' CreatePortalSnippet: description: Create a snippet in a portal. required: true content: application/json: schema: $ref: '#/components/schemas/CreatePortalSnippetRequest' UpdatePortalSnippet: description: Update a snippet in a portal. required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePortalSnippetRequest' 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' CreateApiRequest: required: true content: application/json: schema: title: API type: object additionalProperties: false properties: id: type: string format: uuid example: 9f5061ce-78f6-4452-9108-ad7c02821fd5 description: The API identifier. readOnly: true name: type: string maxLength: 255 minLength: 1 description: > The name of your API. The `name + version` combination must be unique for each API you publish. example: MyAPI description: type: string description: >- A description of your API. Will be visible on your live Portal. nullable: true version: type: string maxLength: 255 minLength: 1 description: >- An optional version for your API. Leave this empty if your API is unversioned. nullable: true deprecated: type: boolean description: Marks this API as deprecated. slug: type: string pattern: ^[\w-]+$ description: > The `slug` is used in generated URLs to provide human readable paths. Defaults to `slugify(name + version)` example: my-api-v1 nullable: true auth_strategy_sync_error: readOnly: true allOf: - $ref: '#/components/schemas/AuthStrategyApiSyncError' portals: readOnly: true type: array nullable: false uniqueItems: true description: The list of portals which this API is published to. items: type: object additionalProperties: false required: - id - name - display_name properties: id: type: string format: uuid example: 25a2624c-49fc-4764-99e1-224ed819f200 description: The portal identifier. name: type: string example: My Portal description: >- The name of the portal, used to distinguish it from other portals. display_name: type: string example: My Portal description: >- The display name of the portal. This value will be the portal's `name` in Portal API. labels: $ref: '#/components/schemas/Labels' public_labels: $ref: '#/components/schemas/PublicLabels' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - name CreateApiSpecRequest: required: true content: application/json: schema: title: API Specification type: object additionalProperties: false properties: id: type: string format: uuid example: 7710d5c4-d902-410b-992f-18b814155b53 description: The API specification identifier. readOnly: true content: type: string description: | The raw content of your API specification, in json or yaml. example: >- {"openapi":"3.0.3","info":{"title":"Example API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example endpoint","responses":{"200":{"description":"Successful response"}}}}}} validation_messages: type: array description: The errors that occurred while parsing the API specification. readOnly: true items: type: object additionalProperties: false required: - message properties: message: type: string type: $ref: '#/components/schemas/ApiSpecType' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - content CreateApiDocumentRequest: required: true content: application/json: schema: type: object title: API Document additionalProperties: false properties: id: $ref: '#/components/schemas/ApiDocumentId' content: $ref: '#/components/schemas/ApiDocumentContent' title: $ref: '#/components/schemas/ApiDocumentTitle' slug: $ref: '#/components/schemas/ApiDocumentSlug' status: $ref: '#/components/schemas/ApiDocumentStatus' parent_document_id: $ref: '#/components/schemas/ApiDocumentParentDocumentId' labels: $ref: '#/components/schemas/Labels' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - content UpdateApiRequest: required: true content: application/json: schema: title: API type: object additionalProperties: false properties: id: type: string format: uuid example: 9f5061ce-78f6-4452-9108-ad7c02821fd5 description: The API identifier. readOnly: true name: type: string maxLength: 255 minLength: 1 description: > The name of your API. The `name + version` combination must be unique for each API you publish. example: MyAPI description: type: string description: >- A description of your API. Will be visible on your live Portal. nullable: true version: type: string maxLength: 255 minLength: 1 description: >- An optional version for your API. Leave this empty if your API is unversioned. nullable: true deprecated: type: boolean description: Marks this API as deprecated. slug: type: string pattern: ^[\w-]+$ description: > The `slug` is used in generated URLs to provide human readable paths. Defaults to `slugify(name + version)` example: my-api-v1 nullable: true auth_strategy_sync_error: readOnly: true allOf: - $ref: '#/components/schemas/AuthStrategyApiSyncError' portals: readOnly: true type: array nullable: false uniqueItems: true description: The list of portals which this API is published to. items: type: object additionalProperties: false required: - id - name - display_name properties: id: type: string format: uuid example: 25a2624c-49fc-4764-99e1-224ed819f200 description: The portal identifier. name: type: string example: My Portal description: >- The name of the portal, used to distinguish it from other portals. display_name: type: string example: My Portal description: >- The display name of the portal. This value will be the portal's `name` in Portal API. labels: $ref: '#/components/schemas/LabelsUpdate' public_labels: $ref: '#/components/schemas/PublicLabelsUpdate' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' UpdateApiDocumentRequest: required: true content: application/json: schema: $ref: '#/components/schemas/ApiDocument' UpdateApiSpecRequest: required: true content: application/json: schema: $ref: '#/components/schemas/ApiSpec' PutApiPublicationRequest: required: true content: application/json: schema: $ref: '#/components/schemas/ApiPublication' CreateApiImplementationRequest: required: true content: application/json: schema: $ref: '#/components/schemas/ApiImplementation' parameters: PortalId: schema: type: string format: uuid example: f32d905a-ed33-46a3-a093-d8f536af9a8a name: portalId in: path required: true description: The Portal identifier PageId: schema: type: string format: uuid example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79 name: pageId in: path required: true description: ID of the page. x-speakeasy-match: id SnippetId: schema: type: string format: uuid example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79 name: snippetId in: path required: true description: ID of the snippet. 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. ApiId: schema: type: string format: uuid example: 9f5061ce-78f6-4452-9108-ad7c02821fd5 name: apiId in: path required: true description: The UUID API identifier DocumentId: schema: type: string format: uuid example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb name: documentId description: The document identifier related to the API in: path required: true x-speakeasy-match: id SpecId: schema: type: string format: uuid example: d32d905a-ed33-46a3-a093-d8f536af9a8a name: specId description: The API specification identifier in: path required: true x-speakeasy-match: id ImplementationId: schema: type: string format: uuid example: 032d905a-ed33-46a3-a093-d8f536af9a8a name: implementationId in: path required: true description: The Portal identifier x-speakeasy-match: id cpId: name: cpId in: path required: true description: Id of the Konnect resource example: bf138ba2-c9b1-4229-b268-04d9d8a6410b x-speakeasy-param-force-new: true schema: type: string format: uuid responses: 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' PortalCustomDomain: description: Portal custom domain content: application/json: schema: $ref: '#/components/schemas/PortalCustomDomain' PortalResponse: description: Details about a portal. content: application/json: schema: title: Portal type: object additionalProperties: false properties: id: $ref: '#/components/schemas/UUID' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' name: type: string maxLength: 255 minLength: 1 description: >- The name of the portal, used to distinguish it from other portals. Name must be unique. display_name: type: string maxLength: 255 minLength: 1 description: >- The display name of the portal. This value will be the portal's `name` in Portal API. description: type: string nullable: true maxLength: 512 description: A description of the portal. authentication_enabled: type: boolean description: >- Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. rbac_enabled: type: boolean description: >- Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. default_api_visibility: type: string description: >- The default visibility of APIs in the portal. If set to `public`, newly published APIs are visible to unauthenticated developers. If set to `private`, newly published APIs are hidden from unauthenticated developers. enum: - public - private default_page_visibility: type: string description: >- The default visibility of pages in the portal. If set to `public`, newly created pages are visible to unauthenticated developers. If set to `private`, newly created pages are hidden from unauthenticated developers. enum: - public - private default_application_auth_strategy_id: type: string format: uuid description: >- The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to `null`, API publications will not use an authentication strategy unless set during publication. DCR support for Auth Strategies is currently in development. nullable: true auto_approve_developers: type: boolean description: >- Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. auto_approve_applications: type: boolean description: >- Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. 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 canonical_domain: type: string format: hostname description: The canonical domain of the developer portal nullable: false readOnly: true labels: $ref: '#/components/schemas/Labels' required: - id - name - display_name - description - authentication_enabled - rbac_enabled - default_api_visibility - default_page_visibility - default_application_auth_strategy_id - auto_approve_applications - auto_approve_developers - default_domain - canonical_domain - updated_at - created_at PortalCustomizationResponse: description: The current customization options for a portal. content: application/json: schema: $ref: '#/components/schemas/PortalCustomization' PortalPage: description: Details about a page in a portal. content: application/json: schema: $ref: '#/components/schemas/PortalPageResponse' PortalSnippet: description: Details about a snippet in a portal. content: application/json: schema: $ref: '#/components/schemas/PortalSnippetResponse' Unauthorized: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/UnauthorizedError' 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' Conflict: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/ConflictError' ApiSlugConflict: description: Conflict - `slug` property must be unique content: application/problem+json: schema: type: object required: - status - title - instance properties: status: type: number title: type: string type: type: string instance: type: string ApiSpecConflict: description: Conflict - An API may only have one specification content: application/problem+json: schema: $ref: '#/components/schemas/ConflictError' ApiSpecHiddenConflict: description: Conflict - name attribute must be unique across specifications content: application/problem+json: schema: $ref: '#/components/schemas/ConflictError' ApiImplementationConflict: description: Conflict - A gateway service can only be linked to a single API content: application/problem+json: schema: $ref: '#/components/schemas/ConflictError' ApiUnauthorized: description: ApiUnauthorized content: application/problem+json: schema: $ref: '#/components/schemas/UnauthorizedError' ApiNotFound: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/NotFoundError' ApiForbidden: description: ApiForbidden content: application/problem+json: schema: $ref: '#/components/schemas/ForbiddenError' ApiPublicationBadRequest: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestError' ApiResponse: description: API content: application/json: schema: $ref: '#/components/schemas/ApiResponseSchema' ApiDocumentResponse: description: API document content: application/json: schema: type: object title: API Document additionalProperties: false properties: id: $ref: '#/components/schemas/ApiDocumentId' content: $ref: '#/components/schemas/ApiDocumentContent' title: $ref: '#/components/schemas/ApiDocumentTitle' slug: $ref: '#/components/schemas/ApiDocumentSlug' status: $ref: '#/components/schemas/ApiDocumentStatus' parent_document_id: $ref: '#/components/schemas/ApiDocumentParentDocumentId' labels: $ref: '#/components/schemas/Labels' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - id - parent_document_id - title - slug - status - content - labels - updated_at - created_at ApiSpecResponse: description: API specification content: application/json: schema: title: API Specification type: object additionalProperties: false properties: id: type: string format: uuid example: 7710d5c4-d902-410b-992f-18b814155b53 description: The API specification identifier. readOnly: true content: type: string description: | The raw content of your API specification, in json or yaml. example: >- {"openapi":"3.0.3","info":{"title":"Example API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example endpoint","responses":{"200":{"description":"Successful response"}}}}}} validation_messages: type: array description: The errors that occurred while parsing the API specification. readOnly: true items: type: object additionalProperties: false required: - message properties: message: type: string type: $ref: '#/components/schemas/ApiSpecType' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - id - content - type - created_at - updated_at - validation_messages ApiPublicationResponse: description: An API publication in a portal content: application/json: schema: title: API Publication type: object description: An API publication in a portal additionalProperties: false properties: auto_approve_registrations: $ref: '#/components/schemas/AutoApproveRegistrations' auth_strategy_ids: $ref: '#/components/schemas/ApiPublicationAuthStrategyIds' visibility: $ref: '#/components/schemas/ApiPublicationVisibility' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - visibility - created_at - updated_at - auth_strategy_ids ApiImplementationResponse: description: An API implementation content: application/json: schema: title: API Implementation type: object description: An entity that implements an API additionalProperties: false required: - service - id - created_at - updated_at properties: id: $ref: '#/components/schemas/UUID' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' service: $ref: '#/components/schemas/ApiImplementationService' UnsupportedMediaType: description: Unsupported Media Type content: application/problem+json: schema: $ref: '#/components/schemas/UnsupportedMediaTypeError' MeshAccessLogItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshAccessLogItem' MeshAccessLogList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshAccessLogItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshCircuitBreakerItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshCircuitBreakerItem' MeshCircuitBreakerList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshCircuitBreakerItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshFaultInjectionItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshFaultInjectionItem' MeshFaultInjectionList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshFaultInjectionItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshHealthCheckItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshHealthCheckItem' MeshHealthCheckList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshHealthCheckItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshHTTPRouteItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshHTTPRouteItem' MeshHTTPRouteList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshHTTPRouteItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshLoadBalancingStrategyItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshLoadBalancingStrategyItem' MeshLoadBalancingStrategyList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshLoadBalancingStrategyItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshMetricItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshMetricItem' MeshMetricList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshMetricItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshPassthroughItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshPassthroughItem' MeshPassthroughList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshPassthroughItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshProxyPatchItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshProxyPatchItem' MeshProxyPatchList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshProxyPatchItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshRateLimitItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshRateLimitItem' MeshRateLimitList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshRateLimitItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshRetryItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshRetryItem' MeshRetryList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshRetryItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshTCPRouteItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshTCPRouteItem' MeshTCPRouteList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshTCPRouteItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshTimeoutItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshTimeoutItem' MeshTimeoutList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshTimeoutItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshTLSItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshTLSItem' MeshTLSList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshTLSItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshTraceItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshTraceItem' MeshTraceList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshTraceItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshTrafficPermissionItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshTrafficPermissionItem' MeshTrafficPermissionList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshTrafficPermissionItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshItem' MeshList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshGatewayItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshGatewayItem' MeshGatewayList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshGatewayItem' total: type: number description: The total number of entities next: type: string description: URL to the next page HostnameGeneratorItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/HostnameGeneratorItem' HostnameGeneratorList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/HostnameGeneratorItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshExternalServiceItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshExternalServiceItem' MeshExternalServiceList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshExternalServiceItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshMultiZoneServiceItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshMultiZoneServiceItem' MeshMultiZoneServiceList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshMultiZoneServiceItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshServiceItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshServiceItem' MeshServiceList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshServiceItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshGlobalRateLimitItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshGlobalRateLimitItem' MeshGlobalRateLimitList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshGlobalRateLimitItem' total: type: number description: The total number of entities next: type: string description: URL to the next page MeshOPAItem: description: Successful response content: application/json: schema: $ref: '#/components/schemas/MeshOPAItem' MeshOPAList: description: List content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeshOPAItem' total: type: number description: The total number of entities next: type: string description: URL to the next page 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' 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' schemas: PageSlug: title: PageSlug description: >- The slug of a page in a portal. Is used to compute the full path /slug1/slug2/slug3. type: string maxLength: 512 example: /my-page ParentPageId: type: string format: uuid nullable: true description: > Pages may be rendered as a tree of files. Specify the `id` of another page as the `parent_page_id` to add some hierarchy to your pages. example: null PageTitle: title: PageTitle description: The title of a page in a portal. type: string maxLength: 512 example: My Page PageContent: title: PageContent description: The renderable markdown content of a page in a portal. type: string maxLength: 1000000 example: '# Welcome to My Page' SnippetName: title: SnippetName description: The unique name of a snippet in a portal. type: string maxLength: 512 example: my-snippet SnippetTitle: title: SnippetTitle description: The display title of a snippet in a portal. type: string maxLength: 512 example: My Snippet SnippetContent: title: SnippetContent description: The renderable markdown content of a page in a portal. type: string maxLength: 1000000 example: '# Welcome to My Snippet' VisibilityStatus: title: VisibilityStatus description: >- Whether the resource is publicly accessible to non-authenticated users. Defaults to private. type: string example: public enum: - public - private PublishedStatus: title: PublishedStatus description: Whether the resource is visible on a given portal. Defaults to false. type: string example: published enum: - published - unpublished Description: title: ResourceDescription type: string maxLength: 160 example: A custom page about developer portals PageVisibilityStatusWithDefault: title: PageVisibilityStatusWithDefault description: Whether a page is publicly accessible to non-authenticated users. type: string default: private example: public SnippetVisibilityStatusWithDefault: title: PageVisibilityStatusWithDefault description: Whether a page is publicly accessible to non-authenticated users. type: string default: private example: public UpdatePortalPageRequest: title: UpdatePortalPageRequest description: Update a page in a portal. type: object additionalProperties: false properties: slug: $ref: '#/components/schemas/PageSlug' title: $ref: '#/components/schemas/PageTitle' content: $ref: '#/components/schemas/PageContent' visibility: $ref: '#/components/schemas/VisibilityStatus' status: $ref: '#/components/schemas/PublishedStatus' description: $ref: '#/components/schemas/Description' parent_page_id: $ref: '#/components/schemas/ParentPageId' CreatePortalPageRequest: title: CreatePortalPageRequest description: Create a page in a portal. type: object additionalProperties: false required: - slug - content properties: slug: $ref: '#/components/schemas/PageSlug' title: $ref: '#/components/schemas/PageTitle' content: $ref: '#/components/schemas/PageContent' visibility: $ref: '#/components/schemas/PageVisibilityStatusWithDefault' status: $ref: '#/components/schemas/PublishedStatus' description: $ref: '#/components/schemas/Description' parent_page_id: $ref: '#/components/schemas/ParentPageId' PortalPageResponse: title: PortalPageResponse description: Details about a page in a portal. additionalProperties: false type: object required: - id - slug - title - content - visibility - status - created_at - updated_at - parent_page_id properties: id: $ref: '#/components/schemas/UUID' slug: $ref: '#/components/schemas/PageSlug' title: $ref: '#/components/schemas/PageTitle' content: $ref: '#/components/schemas/PageContent' visibility: $ref: '#/components/schemas/VisibilityStatus' status: $ref: '#/components/schemas/PublishedStatus' description: $ref: '#/components/schemas/Description' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' parent_page_id: $ref: '#/components/schemas/ParentPageId' PortalSnippetResponse: title: PortalSnippetResponse description: Details about a page in a portal. additionalProperties: false type: object required: - id - name - content - visibility - status - created_at - updated_at properties: id: $ref: '#/components/schemas/UUID' name: $ref: '#/components/schemas/SnippetName' title: $ref: '#/components/schemas/SnippetTitle' content: $ref: '#/components/schemas/SnippetContent' visibility: $ref: '#/components/schemas/VisibilityStatus' status: $ref: '#/components/schemas/PublishedStatus' description: $ref: '#/components/schemas/Description' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' UpdatePortalSnippetRequest: title: UpdatePortalSnippetRequest description: Update a snippet in a portal. type: object additionalProperties: false properties: name: $ref: '#/components/schemas/SnippetName' title: $ref: '#/components/schemas/SnippetTitle' content: $ref: '#/components/schemas/SnippetContent' visibility: $ref: '#/components/schemas/VisibilityStatus' status: $ref: '#/components/schemas/PublishedStatus' description: $ref: '#/components/schemas/Description' CreatePortalSnippetRequest: title: CreatePortalSnippetRequest description: Create a snippet in a portal. type: object additionalProperties: false required: - name - content properties: name: $ref: '#/components/schemas/SnippetName' title: $ref: '#/components/schemas/SnippetTitle' content: $ref: '#/components/schemas/SnippetContent' visibility: $ref: '#/components/schemas/SnippetVisibilityStatusWithDefault' status: $ref: '#/components/schemas/PublishedStatus' description: $ref: '#/components/schemas/Description' PortalCustomDomain: title: PortalCustomDomain type: object additionalProperties: false properties: hostname: type: string enabled: type: boolean ssl: $ref: '#/components/schemas/PortalCustomDomainSSL' cname_status: $ref: '#/components/schemas/PortalCustomDomainCnameStatus' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - hostname - enabled - ssl - cname_status - created_at - updated_at PortalCustomDomainSSL: type: object title: PortalCustomDomainSSL additionalProperties: false x-property-annotations: uploaded_at: - x-unstable - x-internal expires_at: - x-unstable - x-internal properties: domain_verification_method: $ref: '#/components/schemas/PortalCustomDomainVerificationMethod' verification_status: $ref: '#/components/schemas/PortalCustomDomainVerificationStatus' validation_errors: $ref: '#/components/schemas/PortalCustomDomainValidationErrors' uploaded_at: type: string format: date-time example: '2022-11-04T20:10:06.927Z' description: >- An ISO-8601 timestamp representation of the ssl certificate upload date. readOnly: true expires_at: type: string format: date-time example: '2022-11-04T20:10:06.927Z' description: >- An ISO-8601 timestamp representation of the ssl certificate expiration date. readOnly: true required: - domain_verification_method - verification_status CreatePortalCustomDomainSSL: type: object title: CreatePortalCustomDomainSSL additionalProperties: false x-property-annotations: custom_certificate: - x-unstable - x-internal custom_private_key: - x-unstable - x-internal properties: domain_verification_method: $ref: '#/components/schemas/PortalCustomDomainVerificationMethod' custom_certificate: type: string description: Custom certificate to be used for the SSL termination. custom_private_key: type: string description: Custom certificate private key to be used for the SSL termination. required: - domain_verification_method PortalCustomDomainVerificationMethod: title: PortalCustomDomainVerificationMethod type: string enum: - http - custom_certificate x-enum-dev: - custom_certificate PortalCustomDomainVerificationStatus: title: PortalCustomDomainVerificationStatus type: string readOnly: true enum: - verified - pending - error PortalCustomDomainCnameStatus: title: PortalCustomDomainCnameStatus type: string readOnly: true enum: - verified - pending PortalCustomDomainValidationErrors: title: PortalCustomDomainValidationErrors type: array readOnly: true items: type: string CreatePortalCustomDomainRequest: title: CreatePortalCustomDomainRequest type: object additionalProperties: false properties: hostname: type: string enabled: type: boolean ssl: $ref: '#/components/schemas/CreatePortalCustomDomainSSL' required: - hostname - enabled - ssl UpdatePortalCustomDomainRequest: title: UpdatePortalCustomDomainRequest type: object additionalProperties: false x-property-annotations: custom_certificate: - x-unstable - x-internal custom_private_key: - x-unstable - x-internal properties: enabled: type: boolean custom_certificate: type: string description: Custom certificate to be used for the SSL termination. custom_private_key: type: string description: Custom certificate private key to be used for the SSL termination. PortalClaimMappings: title: PortalClaimMappings description: Mappings from a portal developer atribute to an Identity Provider claim. type: object minProperties: 0 maxProperties: 3 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 PortalOIDCConfig: title: 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' required: - issuer - client_id example: issuer: https://identity.example.com/v2 client_id: x7id0o42lklas0blidl2 scopes: - email - openid - profile claim_mappings: name: name email: email groups: custom-group-claim PortalAuthenticationSettingsResponse: x-speakeasy-entity: PortalAuth title: PortalAuthenticationSettingsResponse description: The developer authentication settings for a portal. type: object properties: basic_auth_enabled: type: boolean example: true description: The portal has basic auth enabled or disabled. oidc_auth_enabled: type: boolean example: false description: The portal has OIDC enabled or disabled. saml_auth_enabled: type: boolean example: false description: The portal has SAML enabled or disabled. oidc_team_mapping_enabled: type: boolean example: true description: IdP groups determine the Portal Teams a developer has. idp_mapping_enabled: type: boolean example: true description: >- IdP groups determine the Portal Teams a developer has. This will soon replace oidc_team_mapping_enabled. konnect_mapping_enabled: type: boolean example: false description: A Konnect Identity Admin assigns teams to a developer. oidc_config: $ref: '#/components/schemas/PortalOIDCConfig' required: - basic_auth_enabled - konnect_mapping_enabled - oidc_auth_enabled - oidc_team_mapping_enabled 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 PortalAuthenticationSettingsUpdateRequest: x-speakeasy-entity: PortalAuth title: PortalAuthenticationSettingsUpdateRequest description: Properties to update a portal's developer auth settings. type: object properties: basic_auth_enabled: type: boolean example: true description: The organization has basic auth enabled. oidc_auth_enabled: type: boolean example: false description: The organization has OIDC disabled. saml_auth_enabled: type: boolean example: false description: The portal has SAML enabled or disabled. oidc_team_mapping_enabled: type: boolean example: true description: >- Whether IdP groups determine the Konnect Portal teams a developer has. konnect_mapping_enabled: type: boolean example: false description: Whether a Konnect Identity Admin assigns teams to a developer. idp_mapping_enabled: type: boolean example: true description: >- Whether IdP groups determine the Konnect Portal teams a developer has. This will soon replace oidc_team_mapping_enabled. 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 PortalUpdateTeamRequest: title: 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 maxLength: 250 example: The Identity Management (IDM) API team. writeOnly: true example: name: IDM - Developers description: The Identity Management (IDM) API team. PortalCreateTeamRequest: x-speakeasy-entity: PortalTeam title: PortalCreateTeamRequest description: Details about a team to create. type: object properties: name: type: string example: IDM - Developers pattern: ^[\w \W]+$ writeOnly: true description: type: string maxLength: 250 example: The Identity Management (IDM) team. writeOnly: true required: - name example: name: IDM - Developers description: The Identity Management (IDM) team. PortalTeamResponse: title: 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 pattern: ^[\w \W]+$ example: IDM - Developers maxLength: 250 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' UUID: type: string format: uuid example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7 description: Contains a unique identifier used for this resource. readOnly: true CreatedAt: type: string format: date-time example: '2022-11-04T20:10:06.927Z' description: An ISO-8601 timestamp representation of entity creation date. readOnly: true UpdatedAt: type: string format: date-time example: '2022-11-04T20:10:06.927Z' description: An ISO-8601 timestamp representation of entity update date. readOnly: true Labels: title: Labels type: object example: env: test maxProperties: 50 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 "_". additionalProperties: type: string pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$ minLength: 1 maxLength: 63 nullable: true BaseError: type: object title: Error description: standard error required: - status - title - instance - detail properties: status: type: integer 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. readOnly: true title: type: string 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. readOnly: true type: type: string description: The error type. readOnly: true instance: type: string 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. readOnly: true detail: type: string 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. readOnly: true InvalidRules: description: invalid parameters rules type: string readOnly: true nullable: true 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 InvalidParameterStandard: type: object additionalProperties: false 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 required: - field - reason InvalidParameterMinimumLength: type: object additionalProperties: false properties: field: type: string example: name readOnly: true rule: description: invalid parameters rules type: string readOnly: true nullable: false enum: - min_length - min_digits - min_lowercase - min_uppercase - min_symbols - min_items - min minimum: type: integer example: 8 source: type: string example: body reason: type: string example: must have at least 8 characters readOnly: true required: - field - reason - rule - minimum InvalidParameterMaximumLength: type: object additionalProperties: false properties: field: type: string example: name readOnly: true rule: description: invalid parameters rules type: string readOnly: true nullable: false enum: - max_length - max_items - max maximum: type: integer example: 8 source: type: string example: body reason: type: string example: must not have more than 8 characters readOnly: true required: - field - reason - rule - maximum InvalidParameterChoiceItem: type: object additionalProperties: false properties: field: type: string example: name readOnly: true rule: description: invalid parameters rules type: string readOnly: true nullable: false enum: - enum reason: type: string example: is a required field readOnly: true choices: type: array uniqueItems: true readOnly: true nullable: false minItems: 1 items: {} source: type: string example: body required: - field - reason - rule - choices InvalidParameterDependentItem: type: object additionalProperties: false properties: field: type: string example: name readOnly: true rule: description: invalid parameters rules type: string readOnly: true nullable: true enum: - dependent_fields reason: type: string example: is a required field readOnly: true dependents: type: array uniqueItems: true nullable: true items: {} readOnly: true source: type: string example: body required: - field - rule - reason - dependents InvalidParameters: type: array nullable: false uniqueItems: true minItems: 1 description: invalid parameters items: oneOf: - $ref: '#/components/schemas/InvalidParameterStandard' - $ref: '#/components/schemas/InvalidParameterMinimumLength' - $ref: '#/components/schemas/InvalidParameterMaximumLength' - $ref: '#/components/schemas/InvalidParameterChoiceItem' - $ref: '#/components/schemas/InvalidParameterDependentItem' 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 LabelsUpdate: type: object nullable: true 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 "_". example: env: test maxProperties: 50 additionalProperties: type: string pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$ minLength: 1 maxLength: 63 nullable: true writeOnly: true NotFoundError: allOf: - $ref: '#/components/schemas/BaseError' - type: object properties: status: example: 404 title: example: Not Found type: example: https://httpstatuses.com/404 instance: example: kong:trace:1234567890 detail: example: Not found ConflictError: allOf: - $ref: '#/components/schemas/BaseError' - type: object properties: status: example: 409 title: example: Conflict type: example: https://httpstatuses.com/409 instance: example: kong:trace:1234567890 detail: example: Conflict PortalMenuItem: type: object additionalProperties: false properties: path: description: The absolute path of a page in a portal with a leading slash. type: string example: /about/company maxLength: 512 title: description: The link display text type: string example: My Page visibility: description: >- Whether a menu item is public or private. Private menu items are only accessible to authenticated users. type: string example: public enum: - public - private external: description: When clicked, open the link in a new window type: boolean required: - path - title - visibility - external PortalFooterMenuSection: type: object additionalProperties: false properties: title: description: The footer menu section title type: string maxLength: 512 items: type: array items: $ref: '#/components/schemas/PortalMenuItem' required: - title - items PortalCustomization: title: PortalCustomization description: The custom settings of this portal type: object additionalProperties: false properties: theme: type: object additionalProperties: false properties: name: type: string nullable: false mode: type: string enum: - light - dark - system colors: type: object additionalProperties: false properties: primary: type: string nullable: false pattern: ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$ x-validation-message: must be a valid hex color value example: '#000000' layout: type: string nullable: false css: type: string nullable: true js: type: object additionalProperties: false properties: custom: type: string nullable: true scripts: type: array items: type: string pattern: ^https://[^:.]+\..+$ maxItems: 20 menu: type: object additionalProperties: false properties: main: type: array items: $ref: '#/components/schemas/PortalMenuItem' footer_sections: type: array items: $ref: '#/components/schemas/PortalFooterMenuSection' footer_bottom: type: array items: $ref: '#/components/schemas/PortalMenuItem' spec_renderer: type: object additionalProperties: false properties: try_it_ui: type: boolean try_it_insomnia: type: boolean infinite_scroll: type: boolean show_schemas: type: boolean robots: type: string nullable: true ApiResponseSchema: title: API type: object additionalProperties: false properties: id: type: string format: uuid example: 9f5061ce-78f6-4452-9108-ad7c02821fd5 description: The API identifier. readOnly: true name: type: string maxLength: 255 minLength: 1 description: > The name of your API. The `name + version` combination must be unique for each API you publish. example: MyAPI description: type: string description: A description of your API. Will be visible on your live Portal. nullable: true version: type: string maxLength: 255 minLength: 1 description: >- An optional version for your API. Leave this empty if your API is unversioned. nullable: true deprecated: type: boolean description: Marks this API as deprecated. slug: type: string pattern: ^[\w-]+$ description: > The `slug` is used in generated URLs to provide human readable paths. Defaults to `slugify(name + version)` example: my-api-v1 nullable: true auth_strategy_sync_error: readOnly: true allOf: - $ref: '#/components/schemas/AuthStrategyApiSyncError' portals: readOnly: true type: array nullable: false uniqueItems: true description: The list of portals which this API is published to. items: type: object additionalProperties: false required: - id - name - display_name properties: id: type: string format: uuid example: 25a2624c-49fc-4764-99e1-224ed819f200 description: The portal identifier. name: type: string example: My Portal description: >- The name of the portal, used to distinguish it from other portals. display_name: type: string example: My Portal description: >- The display name of the portal. This value will be the portal's `name` in Portal API. labels: $ref: '#/components/schemas/Labels' public_labels: $ref: '#/components/schemas/PublicLabels' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' required: - id - name - version - labels - public_labels - deprecated - created_at - updated_at - slug - portals AuthStrategyApiSyncError: type: object additionalProperties: false nullable: true required: - message properties: control_plane_error: type: string enum: - control_plane_error_no_response - control_plane_error_invalid_response - control_plane_error_unavailable - control_plane_error_internal_error - control_plane_error_bad_request - control_plane_error_plugin_conflict - control_plane_error_data_constraint_error - control_plane_error_implementation_not_found 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: control_plane_error: control_plane_error_unavailable message: Unable to connect to the control plane to update plugin ApiDocumentId: title: API Document ID type: string format: uuid example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb description: The API document identifier. readOnly: true ApiDocumentContent: title: API Document Content type: string description: Raw markdown content to display in your Portal ApiDocumentTitle: title: API Document Title type: string description: >- The title of the document. Used to populate the `` tag for the page example: API Document ApiDocumentStatus: type: string enum: - published - unpublished description: If `status=published` the document will be visible in your live portal default: unpublished ApiDocumentParentDocumentId: title: API Document Parent Document ID type: string format: uuid nullable: true description: > API Documents may be rendered as a tree of files. Specify the `id` of another API Document as the `parent_document_id` to add some heirarchy do your documents. example: null ApiDocumentSlug: title: API Document Slug type: string pattern: ^[\w-]+$ description: | The `slug` is used in generated URLs to provide human readable paths. Defaults to `slugify(title)` example: api-document ApiDocument: type: object title: API Document additionalProperties: false properties: id: $ref: '#/components/schemas/ApiDocumentId' content: $ref: '#/components/schemas/ApiDocumentContent' title: $ref: '#/components/schemas/ApiDocumentTitle' slug: $ref: '#/components/schemas/ApiDocumentSlug' status: $ref: '#/components/schemas/ApiDocumentStatus' parent_document_id: $ref: '#/components/schemas/ApiDocumentParentDocumentId' labels: $ref: '#/components/schemas/Labels' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' ApiSpec: title: API Specification type: object additionalProperties: false properties: id: type: string format: uuid example: 7710d5c4-d902-410b-992f-18b814155b53 description: The API specification identifier. readOnly: true content: type: string description: | The raw content of your API specification, in json or yaml. example: >- {"openapi":"3.0.3","info":{"title":"Example API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example endpoint","responses":{"200":{"description":"Successful response"}}}}}} validation_messages: type: array description: The errors that occurred while parsing the API specification. readOnly: true items: type: object additionalProperties: false required: - message properties: message: type: string type: $ref: '#/components/schemas/ApiSpecType' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' ApiPublicationVisibility: title: API Publication Visibility type: string enum: - public - private default: private description: > The visibility of the API in the portal. Public API publications do not require authentication to view and retrieve information about them. Private API publications require authentication to retrieve information about them. ApiPublicationAuthStrategyIds: title: API Publication Auth Strategy IDs type: array nullable: true description: > The auth strategy the API enforces for applications in the portal. Omitting this property means the portal's default application auth strategy will be used. Setting to null means the API will not require application authentication. DCR support for application registration is currently in development. maxItems: 1 minItems: 1 items: type: string format: uuid AutoApproveRegistrations: title: Auto Approve Registrations description: >- Whether the application registration auto approval on this portal for the api is enabled. If set to false, fallbacks on portal's auto_approve_applications value. type: boolean ApiPublication: title: API Publication type: object description: An API publication in a portal additionalProperties: false properties: auto_approve_registrations: $ref: '#/components/schemas/AutoApproveRegistrations' auth_strategy_ids: $ref: '#/components/schemas/ApiPublicationAuthStrategyIds' visibility: $ref: '#/components/schemas/ApiPublicationVisibility' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' ApiImplementationService: title: API Implementation Service type: object description: A Gateway service that implements an API additionalProperties: false required: - control_plane_id - id properties: control_plane_id: type: string format: uuid example: 9f5061ce-78f6-4452-9108-ad7c02821fd5 id: type: string format: uuid example: 7710d5c4-d902-410b-992f-18b814155b53 ApiImplementation: title: API Implementation type: object description: An entity that implements an API additionalProperties: false required: - service properties: id: $ref: '#/components/schemas/UUID' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' service: $ref: '#/components/schemas/ApiImplementationService' PublicLabels: title: PublicLabels type: object example: category: finance maxProperties: 50 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 "_". additionalProperties: type: string pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$ minLength: 1 maxLength: 63 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 PublicLabelsUpdate: title: PublicLabelsUpdate type: object example: category: finance maxProperties: 50 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 "_". additionalProperties: type: string pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$ minLength: 1 maxLength: 63 nullable: true writeOnly: true ApiSpecType: title: API Spec Type type: string example: oas3 description: > The type of specification being stored. This allows us to render the specification correctly. If this field is not set, it will be autodetected from `content` enum: - oas2 - oas3 - asyncapi MeshAccessLogItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshAccessLog x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshAccessLog resource. properties: from: description: >- From list makes a match between clients and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of clients referenced in 'targetRef' properties: backends: items: properties: file: description: >- FileBackend defines configuration for file based access logs properties: format: description: >- Format of access logs. Placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators properties: json: example: - key: start_time value: '%START_TIME%' - key: bytes_received value: '%BYTES_RECEIVED%' items: properties: key: type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - key - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false omitEmptyValues: default: false type: boolean x-speakeasy-param-computed: false plain: example: >- [%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST% type: string x-speakeasy-param-computed: false type: enum: - Plain - Json type: string x-speakeasy-param-computed: false required: - type type: object x-speakeasy-param-computed: false path: description: Path to a file that logs will be written to example: /tmp/access.log minLength: 1 type: string x-speakeasy-param-computed: false required: - path type: object x-speakeasy-param-computed: false openTelemetry: description: Defines an OpenTelemetry logging backend. properties: attributes: description: >- Attributes can contain placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators example: - key: mesh value: '%KUMA_MESH%' items: properties: key: type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - key - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false body: description: >- Body is a raw string or an OTLP any value as described at https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#field-body It can contain placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators example: kvlistValue: values: - key: mesh value: stringValue: '%KUMA_MESH%' x-kubernetes-preserve-unknown-fields: true x-speakeasy-plan-modifiers: ArbitraryJSONModifier endpoint: description: >- Endpoint of OpenTelemetry collector. An empty port defaults to 4317. example: otel-collector:4317 minLength: 1 type: string x-speakeasy-param-computed: false required: - endpoint type: object x-speakeasy-param-computed: false tcp: description: TCPBackend defines a TCP logging backend. properties: address: description: Address of the TCP logging backend example: 127.0.0.1:5000 minLength: 1 type: string x-speakeasy-param-computed: false format: description: >- Format of access logs. Placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators properties: json: example: - key: start_time value: '%START_TIME%' - key: bytes_received value: '%BYTES_RECEIVED%' items: properties: key: type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - key - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false omitEmptyValues: default: false type: boolean x-speakeasy-param-computed: false plain: example: >- [%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST% type: string x-speakeasy-param-computed: false type: enum: - Plain - Json type: string x-speakeasy-param-computed: false required: - type type: object x-speakeasy-param-computed: false required: - address type: object x-speakeasy-param-computed: false type: enum: - Tcp - File - OpenTelemetry type: string x-speakeasy-param-computed: false required: - type type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of clients. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - default - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false rules: description: >- Rules defines inbound access log configurations. Currently limited to selecting all inbound traffic, as L7 matching is not yet implemented. items: properties: default: description: >- Default contains configuration of the inbound access logging properties: backends: items: properties: file: description: >- FileBackend defines configuration for file based access logs properties: format: description: >- Format of access logs. Placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators properties: json: example: - key: start_time value: '%START_TIME%' - key: bytes_received value: '%BYTES_RECEIVED%' items: properties: key: type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - key - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false omitEmptyValues: default: false type: boolean x-speakeasy-param-computed: false plain: example: >- [%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST% type: string x-speakeasy-param-computed: false type: enum: - Plain - Json type: string x-speakeasy-param-computed: false required: - type type: object x-speakeasy-param-computed: false path: description: Path to a file that logs will be written to example: /tmp/access.log minLength: 1 type: string x-speakeasy-param-computed: false required: - path type: object x-speakeasy-param-computed: false openTelemetry: description: Defines an OpenTelemetry logging backend. properties: attributes: description: >- Attributes can contain placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators example: - key: mesh value: '%KUMA_MESH%' items: properties: key: type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - key - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false body: description: >- Body is a raw string or an OTLP any value as described at https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#field-body It can contain placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators example: kvlistValue: values: - key: mesh value: stringValue: '%KUMA_MESH%' x-kubernetes-preserve-unknown-fields: true endpoint: description: >- Endpoint of OpenTelemetry collector. An empty port defaults to 4317. example: otel-collector:4317 minLength: 1 type: string x-speakeasy-param-computed: false required: - endpoint type: object x-speakeasy-param-computed: false tcp: description: TCPBackend defines a TCP logging backend. properties: address: description: Address of the TCP logging backend example: 127.0.0.1:5000 minLength: 1 type: string x-speakeasy-param-computed: false format: description: >- Format of access logs. Placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators properties: json: example: - key: start_time value: '%START_TIME%' - key: bytes_received value: '%BYTES_RECEIVED%' items: properties: key: type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - key - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false omitEmptyValues: default: false type: boolean x-speakeasy-param-computed: false plain: example: >- [%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST% type: string x-speakeasy-param-computed: false type: enum: - Plain - Json type: string x-speakeasy-param-computed: false required: - type type: object x-speakeasy-param-computed: false required: - address type: object x-speakeasy-param-computed: false type: enum: - Tcp - File - OpenTelemetry type: string x-speakeasy-param-computed: false required: - type type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false required: - default type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined in-place. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false to: description: >- To list makes a match between the consumed services and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of destinations referenced in 'targetRef' properties: backends: items: properties: file: description: >- FileBackend defines configuration for file based access logs properties: format: description: >- Format of access logs. Placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators properties: json: example: - key: start_time value: '%START_TIME%' - key: bytes_received value: '%BYTES_RECEIVED%' items: properties: key: type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - key - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false omitEmptyValues: default: false type: boolean x-speakeasy-param-computed: false plain: example: >- [%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST% type: string x-speakeasy-param-computed: false type: enum: - Plain - Json type: string x-speakeasy-param-computed: false required: - type type: object x-speakeasy-param-computed: false path: description: Path to a file that logs will be written to example: /tmp/access.log minLength: 1 type: string x-speakeasy-param-computed: false required: - path type: object x-speakeasy-param-computed: false openTelemetry: description: Defines an OpenTelemetry logging backend. properties: attributes: description: >- Attributes can contain placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators example: - key: mesh value: '%KUMA_MESH%' items: properties: key: type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - key - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false body: description: >- Body is a raw string or an OTLP any value as described at https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#field-body It can contain placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators example: kvlistValue: values: - key: mesh value: stringValue: '%KUMA_MESH%' x-kubernetes-preserve-unknown-fields: true x-speakeasy-plan-modifiers: ArbitraryJSONModifier endpoint: description: >- Endpoint of OpenTelemetry collector. An empty port defaults to 4317. example: otel-collector:4317 minLength: 1 type: string x-speakeasy-param-computed: false required: - endpoint type: object x-speakeasy-param-computed: false tcp: description: TCPBackend defines a TCP logging backend. properties: address: description: Address of the TCP logging backend example: 127.0.0.1:5000 minLength: 1 type: string x-speakeasy-param-computed: false format: description: >- Format of access logs. Placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators properties: json: example: - key: start_time value: '%START_TIME%' - key: bytes_received value: '%BYTES_RECEIVED%' items: properties: key: type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - key - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false omitEmptyValues: default: false type: boolean x-speakeasy-param-computed: false plain: example: >- [%START_TIME%] %KUMA_MESH% %UPSTREAM_HOST% type: string x-speakeasy-param-computed: false type: enum: - Plain - Json type: string x-speakeasy-param-computed: false required: - type type: object x-speakeasy-param-computed: false required: - address type: object x-speakeasy-param-computed: false type: enum: - Tcp - File - OpenTelemetry type: string x-speakeasy-param-computed: false required: - type type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of destinations. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - default - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshAccessLogCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshAccessLogDeleteSuccessResponse: type: object properties: {} MeshCircuitBreakerItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshCircuitBreaker x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshCircuitBreaker resource. properties: from: description: >- From list makes a match between clients and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of destinations referenced in 'targetRef' properties: connectionLimits: description: >- ConnectionLimits contains configuration of each circuit breaking limit, which when exceeded makes the circuit breaker to become open (no traffic is allowed like no current is allowed in the circuits when physical circuit breaker ir open) properties: maxConnectionPools: description: >- The maximum number of connection pools per cluster that are concurrently supported at once. Set this for clusters which create a large number of connection pools. format: int32 type: integer x-speakeasy-param-computed: false maxConnections: description: >- The maximum number of connections allowed to be made to the upstream cluster. format: int32 type: integer x-speakeasy-param-computed: false maxPendingRequests: description: >- The maximum number of pending requests that are allowed to the upstream cluster. This limit is applied as a connection limit for non-HTTP traffic. format: int32 type: integer x-speakeasy-param-computed: false maxRequests: description: >- The maximum number of parallel requests that are allowed to be made to the upstream cluster. This limit does not apply to non-HTTP traffic. format: int32 type: integer x-speakeasy-param-computed: false maxRetries: description: >- The maximum number of parallel retries that will be allowed to the upstream cluster. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false outlierDetection: description: >- OutlierDetection contains the configuration of the process of dynamically determining whether some number of hosts in an upstream cluster are performing unlike the others and removing them from the healthy load balancing set. Performance might be along different axes such as consecutive failures, temporal success rate, temporal latency, etc. Outlier detection is a form of passive health checking. properties: baseEjectionTime: description: >- The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. type: string x-speakeasy-param-computed: false detectors: description: >- Contains configuration for supported outlier detectors properties: failurePercentage: description: >- Failure Percentage based outlier detection functions similarly to success rate detection, in that it relies on success rate data from each host in a cluster. However, rather than compare those values to the mean success rate of the cluster as a whole, they are compared to a flat user-configured threshold. This threshold is configured via the outlierDetection.failurePercentageThreshold field. The other configuration fields for failure percentage based detection are similar to the fields for success rate detection. As with success rate detection, detection will not be performed for a host if its request volume over the aggregation interval is less than the outlierDetection.detectors.failurePercentage.requestVolume value. Detection also will not be performed for a cluster if the number of hosts with the minimum required request volume in an interval is less than the outlierDetection.detectors.failurePercentage.minimumHosts value. properties: minimumHosts: description: >- The minimum number of hosts in a cluster in order to perform failure percentage-based ejection. If the total number of hosts in the cluster is less than this value, failure percentage-based ejection will not be performed. format: int32 type: integer x-speakeasy-param-computed: false requestVolume: description: >- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to perform failure percentage-based ejection for this host. If the volume is lower than this setting, failure percentage-based ejection will not be performed for this host. format: int32 type: integer x-speakeasy-param-computed: false threshold: description: >- The failure percentage to use when determining failure percentage-based outlier detection. If the failure percentage of a given host is greater than or equal to this value, it will be ejected. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false gatewayFailures: description: >- In the default mode (outlierDetection.splitExternalLocalOriginErrors is false) this detection type takes into account a subset of 5xx errors, called "gateway errors" (502, 503 or 504 status code) and local origin failures, such as timeout, TCP reset etc. In split mode (outlierDetection.splitExternalLocalOriginErrors is true) this detection type takes into account a subset of 5xx errors, called "gateway errors" (502, 503 or 504 status code) and is supported only by the http router. properties: consecutive: description: >- The number of consecutive gateway failures (502, 503, 504 status codes) before a consecutive gateway failure ejection occurs. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false localOriginFailures: description: >- This detection type is enabled only when outlierDetection.splitExternalLocalOriginErrors is true and takes into account only locally originated errors (timeout, reset, etc). If Envoy repeatedly cannot connect to an upstream host or communication with the upstream host is repeatedly interrupted, it will be ejected. Various locally originated problems are detected: timeout, TCP reset, ICMP errors, etc. This detection type is supported by http router and tcp proxy. properties: consecutive: description: >- The number of consecutive locally originated failures before ejection occurs. Parameter takes effect only when splitExternalAndLocalErrors is set to true. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false successRate: description: >- Success Rate based outlier detection aggregates success rate data from every host in a cluster. Then at given intervals ejects hosts based on statistical outlier detection. Success Rate outlier detection will not be calculated for a host if its request volume over the aggregation interval is less than the outlierDetection.detectors.successRate.requestVolume value. Moreover, detection will not be performed for a cluster if the number of hosts with the minimum required request volume in an interval is less than the outlierDetection.detectors.successRate.minimumHosts value. In the default configuration mode (outlierDetection.splitExternalLocalOriginErrors is false) this detection type takes into account all types of errors: locally and externally originated. In split mode (outlierDetection.splitExternalLocalOriginErrors is true), locally originated errors and externally originated (transaction) errors are counted and treated separately. properties: minimumHosts: description: >- The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. format: int32 type: integer x-speakeasy-param-computed: false requestVolume: description: >- The minimum number of total requests that must be collected in one interval (as defined by the interval duration configured in outlierDetection section) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. format: int32 type: integer x-speakeasy-param-computed: false standardDeviationFactor: anyOf: - type: integer - type: string description: >- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (standard_deviation * success_rate_standard_deviation_factor). Either int or decimal represented as string. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false totalFailures: description: >- In the default mode (outlierDetection.splitExternalAndLocalErrors is false) this detection type takes into account all generated errors: locally originated and externally originated (transaction) errors. In split mode (outlierDetection.splitExternalLocalOriginErrors is true) this detection type takes into account only externally originated (transaction) errors, ignoring locally originated errors. If an upstream host is an HTTP-server, only 5xx types of error are taken into account (see Consecutive Gateway Failure for exceptions). Properly formatted responses, even when they carry an operational error (like index not found, access denied) are not taken into account. properties: consecutive: description: >- The number of consecutive server-side error responses (for HTTP traffic, 5xx responses; for TCP traffic, connection failures; for Redis, failure to respond PONG; etc.) before a consecutive total failure ejection occurs. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false disabled: description: >- When set to true, outlierDetection configuration won't take any effect type: boolean x-speakeasy-param-computed: false healthyPanicThreshold: anyOf: - type: integer - type: string description: >- Allows to configure panic threshold for Envoy cluster. If not specified, the default is 50%. To disable panic mode, set to 0%. Either int or decimal represented as string. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false interval: description: >- The time interval between ejection analysis sweeps. This can result in both new ejections and hosts being returned to service. type: string x-speakeasy-param-computed: false maxEjectionPercent: description: >- The maximum % of an upstream cluster that can be ejected due to outlier detection. Defaults to 10% but will eject at least one host regardless of the value. format: int32 type: integer x-speakeasy-param-computed: false splitExternalAndLocalErrors: description: >- Determines whether to distinguish local origin failures from external errors. If set to true the following configuration parameters are taken into account: detectors.localOriginFailures.consecutive type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of destinations. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false rules: description: >- Rules defines inbound circuit breaker configurations. Currently limited to selecting all inbound traffic, as L7 matching is not yet implemented. items: properties: default: description: >- Default contains configuration of the inbound circuit breaker properties: connectionLimits: description: >- ConnectionLimits contains configuration of each circuit breaking limit, which when exceeded makes the circuit breaker to become open (no traffic is allowed like no current is allowed in the circuits when physical circuit breaker ir open) properties: maxConnectionPools: description: >- The maximum number of connection pools per cluster that are concurrently supported at once. Set this for clusters which create a large number of connection pools. format: int32 type: integer x-speakeasy-param-computed: false maxConnections: description: >- The maximum number of connections allowed to be made to the upstream cluster. format: int32 type: integer x-speakeasy-param-computed: false maxPendingRequests: description: >- The maximum number of pending requests that are allowed to the upstream cluster. This limit is applied as a connection limit for non-HTTP traffic. format: int32 type: integer x-speakeasy-param-computed: false maxRequests: description: >- The maximum number of parallel requests that are allowed to be made to the upstream cluster. This limit does not apply to non-HTTP traffic. format: int32 type: integer x-speakeasy-param-computed: false maxRetries: description: >- The maximum number of parallel retries that will be allowed to the upstream cluster. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false outlierDetection: description: >- OutlierDetection contains the configuration of the process of dynamically determining whether some number of hosts in an upstream cluster are performing unlike the others and removing them from the healthy load balancing set. Performance might be along different axes such as consecutive failures, temporal success rate, temporal latency, etc. Outlier detection is a form of passive health checking. properties: baseEjectionTime: description: >- The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. type: string x-speakeasy-param-computed: false detectors: description: >- Contains configuration for supported outlier detectors properties: failurePercentage: description: >- Failure Percentage based outlier detection functions similarly to success rate detection, in that it relies on success rate data from each host in a cluster. However, rather than compare those values to the mean success rate of the cluster as a whole, they are compared to a flat user-configured threshold. This threshold is configured via the outlierDetection.failurePercentageThreshold field. The other configuration fields for failure percentage based detection are similar to the fields for success rate detection. As with success rate detection, detection will not be performed for a host if its request volume over the aggregation interval is less than the outlierDetection.detectors.failurePercentage.requestVolume value. Detection also will not be performed for a cluster if the number of hosts with the minimum required request volume in an interval is less than the outlierDetection.detectors.failurePercentage.minimumHosts value. properties: minimumHosts: description: >- The minimum number of hosts in a cluster in order to perform failure percentage-based ejection. If the total number of hosts in the cluster is less than this value, failure percentage-based ejection will not be performed. format: int32 type: integer x-speakeasy-param-computed: false requestVolume: description: >- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to perform failure percentage-based ejection for this host. If the volume is lower than this setting, failure percentage-based ejection will not be performed for this host. format: int32 type: integer x-speakeasy-param-computed: false threshold: description: >- The failure percentage to use when determining failure percentage-based outlier detection. If the failure percentage of a given host is greater than or equal to this value, it will be ejected. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false gatewayFailures: description: >- In the default mode (outlierDetection.splitExternalLocalOriginErrors is false) this detection type takes into account a subset of 5xx errors, called "gateway errors" (502, 503 or 504 status code) and local origin failures, such as timeout, TCP reset etc. In split mode (outlierDetection.splitExternalLocalOriginErrors is true) this detection type takes into account a subset of 5xx errors, called "gateway errors" (502, 503 or 504 status code) and is supported only by the http router. properties: consecutive: description: >- The number of consecutive gateway failures (502, 503, 504 status codes) before a consecutive gateway failure ejection occurs. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false localOriginFailures: description: >- This detection type is enabled only when outlierDetection.splitExternalLocalOriginErrors is true and takes into account only locally originated errors (timeout, reset, etc). If Envoy repeatedly cannot connect to an upstream host or communication with the upstream host is repeatedly interrupted, it will be ejected. Various locally originated problems are detected: timeout, TCP reset, ICMP errors, etc. This detection type is supported by http router and tcp proxy. properties: consecutive: description: >- The number of consecutive locally originated failures before ejection occurs. Parameter takes effect only when splitExternalAndLocalErrors is set to true. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false successRate: description: >- Success Rate based outlier detection aggregates success rate data from every host in a cluster. Then at given intervals ejects hosts based on statistical outlier detection. Success Rate outlier detection will not be calculated for a host if its request volume over the aggregation interval is less than the outlierDetection.detectors.successRate.requestVolume value. Moreover, detection will not be performed for a cluster if the number of hosts with the minimum required request volume in an interval is less than the outlierDetection.detectors.successRate.minimumHosts value. In the default configuration mode (outlierDetection.splitExternalLocalOriginErrors is false) this detection type takes into account all types of errors: locally and externally originated. In split mode (outlierDetection.splitExternalLocalOriginErrors is true), locally originated errors and externally originated (transaction) errors are counted and treated separately. properties: minimumHosts: description: >- The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. format: int32 type: integer x-speakeasy-param-computed: false requestVolume: description: >- The minimum number of total requests that must be collected in one interval (as defined by the interval duration configured in outlierDetection section) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. format: int32 type: integer x-speakeasy-param-computed: false standardDeviationFactor: anyOf: - type: integer - type: string description: >- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (standard_deviation * success_rate_standard_deviation_factor). Either int or decimal represented as string. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false totalFailures: description: >- In the default mode (outlierDetection.splitExternalAndLocalErrors is false) this detection type takes into account all generated errors: locally originated and externally originated (transaction) errors. In split mode (outlierDetection.splitExternalLocalOriginErrors is true) this detection type takes into account only externally originated (transaction) errors, ignoring locally originated errors. If an upstream host is an HTTP-server, only 5xx types of error are taken into account (see Consecutive Gateway Failure for exceptions). Properly formatted responses, even when they carry an operational error (like index not found, access denied) are not taken into account. properties: consecutive: description: >- The number of consecutive server-side error responses (for HTTP traffic, 5xx responses; for TCP traffic, connection failures; for Redis, failure to respond PONG; etc.) before a consecutive total failure ejection occurs. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false disabled: description: >- When set to true, outlierDetection configuration won't take any effect type: boolean x-speakeasy-param-computed: false healthyPanicThreshold: anyOf: - type: integer - type: string description: >- Allows to configure panic threshold for Envoy cluster. If not specified, the default is 50%. To disable panic mode, set to 0%. Either int or decimal represented as string. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false interval: description: >- The time interval between ejection analysis sweeps. This can result in both new ejections and hosts being returned to service. type: string x-speakeasy-param-computed: false maxEjectionPercent: description: >- The maximum % of an upstream cluster that can be ejected due to outlier detection. Defaults to 10% but will eject at least one host regardless of the value. format: int32 type: integer x-speakeasy-param-computed: false splitExternalAndLocalErrors: description: >- Determines whether to distinguish local origin failures from external errors. If set to true the following configuration parameters are taken into account: detectors.localOriginFailures.consecutive type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined in place. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false to: description: >- To list makes a match between the consumed services and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of destinations referenced in 'targetRef' properties: connectionLimits: description: >- ConnectionLimits contains configuration of each circuit breaking limit, which when exceeded makes the circuit breaker to become open (no traffic is allowed like no current is allowed in the circuits when physical circuit breaker ir open) properties: maxConnectionPools: description: >- The maximum number of connection pools per cluster that are concurrently supported at once. Set this for clusters which create a large number of connection pools. format: int32 type: integer x-speakeasy-param-computed: false maxConnections: description: >- The maximum number of connections allowed to be made to the upstream cluster. format: int32 type: integer x-speakeasy-param-computed: false maxPendingRequests: description: >- The maximum number of pending requests that are allowed to the upstream cluster. This limit is applied as a connection limit for non-HTTP traffic. format: int32 type: integer x-speakeasy-param-computed: false maxRequests: description: >- The maximum number of parallel requests that are allowed to be made to the upstream cluster. This limit does not apply to non-HTTP traffic. format: int32 type: integer x-speakeasy-param-computed: false maxRetries: description: >- The maximum number of parallel retries that will be allowed to the upstream cluster. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false outlierDetection: description: >- OutlierDetection contains the configuration of the process of dynamically determining whether some number of hosts in an upstream cluster are performing unlike the others and removing them from the healthy load balancing set. Performance might be along different axes such as consecutive failures, temporal success rate, temporal latency, etc. Outlier detection is a form of passive health checking. properties: baseEjectionTime: description: >- The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. type: string x-speakeasy-param-computed: false detectors: description: >- Contains configuration for supported outlier detectors properties: failurePercentage: description: >- Failure Percentage based outlier detection functions similarly to success rate detection, in that it relies on success rate data from each host in a cluster. However, rather than compare those values to the mean success rate of the cluster as a whole, they are compared to a flat user-configured threshold. This threshold is configured via the outlierDetection.failurePercentageThreshold field. The other configuration fields for failure percentage based detection are similar to the fields for success rate detection. As with success rate detection, detection will not be performed for a host if its request volume over the aggregation interval is less than the outlierDetection.detectors.failurePercentage.requestVolume value. Detection also will not be performed for a cluster if the number of hosts with the minimum required request volume in an interval is less than the outlierDetection.detectors.failurePercentage.minimumHosts value. properties: minimumHosts: description: >- The minimum number of hosts in a cluster in order to perform failure percentage-based ejection. If the total number of hosts in the cluster is less than this value, failure percentage-based ejection will not be performed. format: int32 type: integer x-speakeasy-param-computed: false requestVolume: description: >- The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to perform failure percentage-based ejection for this host. If the volume is lower than this setting, failure percentage-based ejection will not be performed for this host. format: int32 type: integer x-speakeasy-param-computed: false threshold: description: >- The failure percentage to use when determining failure percentage-based outlier detection. If the failure percentage of a given host is greater than or equal to this value, it will be ejected. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false gatewayFailures: description: >- In the default mode (outlierDetection.splitExternalLocalOriginErrors is false) this detection type takes into account a subset of 5xx errors, called "gateway errors" (502, 503 or 504 status code) and local origin failures, such as timeout, TCP reset etc. In split mode (outlierDetection.splitExternalLocalOriginErrors is true) this detection type takes into account a subset of 5xx errors, called "gateway errors" (502, 503 or 504 status code) and is supported only by the http router. properties: consecutive: description: >- The number of consecutive gateway failures (502, 503, 504 status codes) before a consecutive gateway failure ejection occurs. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false localOriginFailures: description: >- This detection type is enabled only when outlierDetection.splitExternalLocalOriginErrors is true and takes into account only locally originated errors (timeout, reset, etc). If Envoy repeatedly cannot connect to an upstream host or communication with the upstream host is repeatedly interrupted, it will be ejected. Various locally originated problems are detected: timeout, TCP reset, ICMP errors, etc. This detection type is supported by http router and tcp proxy. properties: consecutive: description: >- The number of consecutive locally originated failures before ejection occurs. Parameter takes effect only when splitExternalAndLocalErrors is set to true. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false successRate: description: >- Success Rate based outlier detection aggregates success rate data from every host in a cluster. Then at given intervals ejects hosts based on statistical outlier detection. Success Rate outlier detection will not be calculated for a host if its request volume over the aggregation interval is less than the outlierDetection.detectors.successRate.requestVolume value. Moreover, detection will not be performed for a cluster if the number of hosts with the minimum required request volume in an interval is less than the outlierDetection.detectors.successRate.minimumHosts value. In the default configuration mode (outlierDetection.splitExternalLocalOriginErrors is false) this detection type takes into account all types of errors: locally and externally originated. In split mode (outlierDetection.splitExternalLocalOriginErrors is true), locally originated errors and externally originated (transaction) errors are counted and treated separately. properties: minimumHosts: description: >- The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. format: int32 type: integer x-speakeasy-param-computed: false requestVolume: description: >- The minimum number of total requests that must be collected in one interval (as defined by the interval duration configured in outlierDetection section) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. format: int32 type: integer x-speakeasy-param-computed: false standardDeviationFactor: anyOf: - type: integer - type: string description: >- This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (standard_deviation * success_rate_standard_deviation_factor). Either int or decimal represented as string. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false totalFailures: description: >- In the default mode (outlierDetection.splitExternalAndLocalErrors is false) this detection type takes into account all generated errors: locally originated and externally originated (transaction) errors. In split mode (outlierDetection.splitExternalLocalOriginErrors is true) this detection type takes into account only externally originated (transaction) errors, ignoring locally originated errors. If an upstream host is an HTTP-server, only 5xx types of error are taken into account (see Consecutive Gateway Failure for exceptions). Properly formatted responses, even when they carry an operational error (like index not found, access denied) are not taken into account. properties: consecutive: description: >- The number of consecutive server-side error responses (for HTTP traffic, 5xx responses; for TCP traffic, connection failures; for Redis, failure to respond PONG; etc.) before a consecutive total failure ejection occurs. format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false disabled: description: >- When set to true, outlierDetection configuration won't take any effect type: boolean x-speakeasy-param-computed: false healthyPanicThreshold: anyOf: - type: integer - type: string description: >- Allows to configure panic threshold for Envoy cluster. If not specified, the default is 50%. To disable panic mode, set to 0%. Either int or decimal represented as string. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false interval: description: >- The time interval between ejection analysis sweeps. This can result in both new ejections and hosts being returned to service. type: string x-speakeasy-param-computed: false maxEjectionPercent: description: >- The maximum % of an upstream cluster that can be ejected due to outlier detection. Defaults to 10% but will eject at least one host regardless of the value. format: int32 type: integer x-speakeasy-param-computed: false splitExternalAndLocalErrors: description: >- Determines whether to distinguish local origin failures from external errors. If set to true the following configuration parameters are taken into account: detectors.localOriginFailures.consecutive type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of destinations. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshCircuitBreakerCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshCircuitBreakerDeleteSuccessResponse: type: object properties: {} MeshFaultInjectionItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshFaultInjection x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshFaultInjection resource. properties: from: description: >- From list makes a match between clients and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of destinations referenced in 'targetRef' properties: http: description: >- Http allows to define list of Http faults between dataplanes. items: description: >- FaultInjection defines the configuration of faults between dataplanes. properties: abort: description: >- Abort defines a configuration of not delivering requests to destination service and replacing the responses from destination dataplane by predefined status code properties: httpStatus: description: >- HTTP status code which will be returned to source side format: int32 type: integer x-speakeasy-param-computed: false percentage: anyOf: - type: integer - type: string description: >- Percentage of requests on which abort will be injected, has to be either int or decimal represented as string. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false required: - httpStatus - percentage type: object x-speakeasy-param-computed: false delay: description: >- Delay defines configuration of delaying a response from a destination properties: percentage: anyOf: - type: integer - type: string description: >- Percentage of requests on which delay will be injected, has to be either int or decimal represented as string. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false value: description: >- The duration during which the response will be delayed type: string x-speakeasy-param-computed: false required: - percentage - value type: object x-speakeasy-param-computed: false responseBandwidth: description: >- ResponseBandwidth defines a configuration to limit the speed of responding to the requests properties: limit: description: >- Limit is represented by value measure in Gbps, Mbps, kbps, e.g. 10kbps type: string x-speakeasy-param-computed: false percentage: anyOf: - type: integer - type: string description: >- Percentage of requests on which response bandwidth limit will be either int or decimal represented as string. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false required: - limit - percentage type: object x-speakeasy-param-computed: false type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of destinations. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined inplace. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false to: description: >- To list makes a match between clients and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of destinations referenced in 'targetRef' properties: http: description: >- Http allows to define list of Http faults between dataplanes. items: description: >- FaultInjection defines the configuration of faults between dataplanes. properties: abort: description: >- Abort defines a configuration of not delivering requests to destination service and replacing the responses from destination dataplane by predefined status code properties: httpStatus: description: >- HTTP status code which will be returned to source side format: int32 type: integer x-speakeasy-param-computed: false percentage: anyOf: - type: integer - type: string description: >- Percentage of requests on which abort will be injected, has to be either int or decimal represented as string. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false required: - httpStatus - percentage type: object x-speakeasy-param-computed: false delay: description: >- Delay defines configuration of delaying a response from a destination properties: percentage: anyOf: - type: integer - type: string description: >- Percentage of requests on which delay will be injected, has to be either int or decimal represented as string. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false value: description: >- The duration during which the response will be delayed type: string x-speakeasy-param-computed: false required: - percentage - value type: object x-speakeasy-param-computed: false responseBandwidth: description: >- ResponseBandwidth defines a configuration to limit the speed of responding to the requests properties: limit: description: >- Limit is represented by value measure in Gbps, Mbps, kbps, e.g. 10kbps type: string x-speakeasy-param-computed: false percentage: anyOf: - type: integer - type: string description: >- Percentage of requests on which response bandwidth limit will be either int or decimal represented as string. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false required: - limit - percentage type: object x-speakeasy-param-computed: false type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of destinations. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshFaultInjectionCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshFaultInjectionDeleteSuccessResponse: type: object properties: {} MeshHealthCheckItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshHealthCheck x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshHealthCheck resource. properties: targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined inplace. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false to: description: >- To list makes a match between the consumed services and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of destinations referenced in 'targetRef' properties: alwaysLogHealthCheckFailures: description: >- If set to true, health check failure events will always be logged. If set to false, only the initial health check failure event will be logged. The default value is false. type: boolean x-speakeasy-param-computed: false eventLogPath: description: >- Specifies the path to the file where Envoy can log health check events. If empty, no event log will be written. type: string x-speakeasy-param-computed: false failTrafficOnPanic: description: >- If set to true, Envoy will not consider any hosts when the cluster is in 'panic mode'. Instead, the cluster will fail all requests as if all hosts are unhealthy. This can help avoid potentially overwhelming a failing service. type: boolean x-speakeasy-param-computed: false grpc: description: >- GrpcHealthCheck defines gRPC configuration which will instruct the service the health check will be made for is a gRPC service. properties: authority: description: >- The value of the :authority header in the gRPC health check request, by default name of the cluster this health check is associated with type: string x-speakeasy-param-computed: false disabled: description: If true the GrpcHealthCheck is disabled type: boolean x-speakeasy-param-computed: false serviceName: description: >- Service name parameter which will be sent to gRPC service type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false healthyPanicThreshold: anyOf: - type: integer - type: string description: >- Allows to configure panic threshold for Envoy cluster. If not specified, the default is 50%. To disable panic mode, set to 0%. Either int or decimal represented as string. Deprecated: the setting has been moved to MeshCircuitBreaker policy, please use MeshCircuitBreaker policy instead. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false healthyThreshold: description: >- Number of consecutive healthy checks before considering a host healthy. If not specified then the default value is 1 format: int32 type: integer x-speakeasy-param-computed: false http: description: >- HttpHealthCheck defines HTTP configuration which will instruct the service the health check will be made for is an HTTP service. properties: disabled: description: If true the HttpHealthCheck is disabled type: boolean x-speakeasy-param-computed: false expectedStatuses: description: >- List of HTTP response statuses which are considered healthy items: type: integer type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false path: description: >- The HTTP path which will be requested during the health check (ie. /health) If not specified then the default value is "/" type: string x-speakeasy-param-computed: false requestHeadersToAdd: description: >- The list of HTTP headers which should be added to each health check request properties: add: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false set: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false initialJitter: description: >- If specified, Envoy will start health checking after a random time in ms between 0 and initialJitter. This only applies to the first health check. type: string x-speakeasy-param-computed: false interval: description: |- Interval between consecutive health checks. If not specified then the default value is 1m type: string x-speakeasy-param-computed: false intervalJitter: description: >- If specified, during every interval Envoy will add IntervalJitter to the wait time. type: string x-speakeasy-param-computed: false intervalJitterPercent: description: >- If specified, during every interval Envoy will add IntervalJitter * IntervalJitterPercent / 100 to the wait time. If IntervalJitter and IntervalJitterPercent are both set, both of them will be used to increase the wait time. format: int32 type: integer x-speakeasy-param-computed: false noTrafficInterval: description: >- The "no traffic interval" is a special health check interval that is used when a cluster has never had traffic routed to it. This lower interval allows cluster information to be kept up to date, without sending a potentially large amount of active health checking traffic for no reason. Once a cluster has been used for traffic routing, Envoy will shift back to using the standard health check interval that is defined. Note that this interval takes precedence over any other. The default value for "no traffic interval" is 60 seconds. type: string x-speakeasy-param-computed: false reuseConnection: description: >- Reuse health check connection between health checks. Default is true. type: boolean x-speakeasy-param-computed: false tcp: description: >- TcpHealthCheck defines configuration for specifying bytes to send and expected response during the health check properties: disabled: description: If true the TcpHealthCheck is disabled type: boolean x-speakeasy-param-computed: false receive: description: >- List of Base64 encoded blocks of strings expected as a response. When checking the response, "fuzzy" matching is performed such that each block must be found, and in the order specified, but not necessarily contiguous. If not provided or empty, checks will be performed as "connect only" and be marked as successful when TCP connection is successfully established. items: type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false send: description: >- Base64 encoded content of the message which will be sent during the health check to the target type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false timeout: description: |- Maximum time to wait for a health check response. If not specified then the default value is 15s type: string x-speakeasy-param-computed: false unhealthyThreshold: description: >- Number of consecutive unhealthy checks before considering a host unhealthy. If not specified then the default value is 5 format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of destinations. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshHealthCheckCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshHealthCheckDeleteSuccessResponse: type: object properties: {} MeshHTTPRouteItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshHTTPRoute x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshHTTPRoute resource. properties: targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined inplace. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false to: description: >- To matches destination services of requests and holds configuration. items: properties: hostnames: description: >- Hostnames is only valid when targeting MeshGateway and limits the effects of the rules to requests to this hostname. Given hostnames must intersect with the hostname of the listeners the route attaches to. items: type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false rules: description: >- Rules contains the routing rules applies to a combination of top-level targetRef and the targetRef in this entry. items: properties: default: description: >- Default holds routing rules that can be merged with rules from other policies. properties: backendRefs: items: description: BackendRef defines where to forward traffic. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false port: description: >- Port is only supported when this ref refers to a real MeshService object format: int32 type: integer x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false weight: default: 1 minimum: 0 type: integer x-speakeasy-param-computed: false required: - kind type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false filters: items: properties: requestHeaderModifier: description: >- Only one action is supported per header name. Configuration to set or add multiple values for a header must use RFC 7230 header value formatting, separating each value with a comma. properties: add: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false remove: items: type: string maxItems: 16 type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false set: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false requestMirror: properties: backendRef: description: >- BackendRef defines where to forward traffic. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false port: description: >- Port is only supported when this ref refers to a real MeshService object format: int32 type: integer x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false weight: default: 1 minimum: 0 type: integer x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false percentage: anyOf: - type: integer - type: string description: >- Percentage of requests to mirror. If not specified, all requests to the target cluster will be mirrored. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false required: - backendRef type: object x-speakeasy-param-computed: false requestRedirect: properties: hostname: description: >- PreciseHostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 1 notable exception that numeric IP addresses are not allowed. Note that as per RFC1035 and RFC1123, a *label* must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. maxLength: 253 minLength: 1 pattern: >- ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ type: string x-speakeasy-param-computed: false path: description: >- Path defines parameters used to modify the path of the incoming request. The modified path is then used to construct the location header. When empty, the request path is used as-is. properties: replaceFullPath: type: string x-speakeasy-param-computed: false replacePrefixMatch: type: string x-speakeasy-param-computed: false type: enum: - ReplaceFullPath - ReplacePrefixMatch type: string x-speakeasy-param-computed: false required: - type type: object x-speakeasy-param-computed: false port: description: >- Port is the port to be used in the value of the `Location` header in the response. When empty, port (if specified) of the request is used. format: int32 maximum: 65535 minimum: 1 type: integer x-speakeasy-param-computed: false scheme: enum: - http - https type: string x-speakeasy-param-computed: false statusCode: default: 302 description: >- StatusCode is the HTTP status code to be used in response. enum: - 301 - 302 - 303 - 307 - 308 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false responseHeaderModifier: description: >- Only one action is supported per header name. Configuration to set or add multiple values for a header must use RFC 7230 header value formatting, separating each value with a comma. properties: add: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false remove: items: type: string maxItems: 16 type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false set: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: enum: - RequestHeaderModifier - ResponseHeaderModifier - RequestRedirect - URLRewrite - RequestMirror type: string x-speakeasy-param-computed: false urlRewrite: properties: hostToBackendHostname: description: >- HostToBackendHostname rewrites the hostname to the hostname of the upstream host. This option is only available when targeting MeshGateways. type: boolean x-speakeasy-param-computed: false hostname: description: >- Hostname is the value to be used to replace the host header value during forwarding. maxLength: 253 minLength: 1 pattern: >- ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ type: string x-speakeasy-param-computed: false path: description: Path defines a path rewrite. properties: replaceFullPath: type: string x-speakeasy-param-computed: false replacePrefixMatch: type: string x-speakeasy-param-computed: false type: enum: - ReplaceFullPath - ReplacePrefixMatch type: string x-speakeasy-param-computed: false required: - type type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false required: - type type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false matches: description: >- Matches describes how to match HTTP requests this rule should be applied to. items: properties: headers: items: description: >- HeaderMatch describes how to select an HTTP route by matching HTTP request headers. properties: name: description: >- Name is the name of the HTTP Header to be matched. Name MUST be lower case as they will be handled with case insensitivity (See https://tools.ietf.org/html/rfc7230#section-3.2). maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false type: default: Exact description: >- Type specifies how to match against the value of the header. enum: - Exact - Present - RegularExpression - Absent - Prefix type: string x-speakeasy-param-computed: false value: description: >- Value is the value of HTTP Header to be matched. type: string x-speakeasy-param-computed: false required: - name type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false method: enum: - CONNECT - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE type: string x-speakeasy-param-computed: false path: properties: type: enum: - Exact - PathPrefix - RegularExpression type: string x-speakeasy-param-computed: false value: description: >- Exact or prefix matches must be an absolute path. A prefix matches only if separated by a slash or the entire path. minLength: 1 type: string x-speakeasy-param-computed: false required: - type - value type: object x-speakeasy-param-computed: false queryParams: description: >- QueryParams matches based on HTTP URL query parameters. Multiple matches are ANDed together such that all listed matches must succeed. items: properties: name: minLength: 1 type: string x-speakeasy-param-computed: false type: enum: - Exact - RegularExpression type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - type - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object minItems: 1 type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false required: - default - matches type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of request destinations. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - rules - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshHTTPRouteCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshHTTPRouteDeleteSuccessResponse: type: object properties: {} MeshLoadBalancingStrategyItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshLoadBalancingStrategy x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: >- Spec is the specification of the Kuma MeshLoadBalancingStrategy resource. properties: targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined inplace. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false to: description: >- To list makes a match between the consumed services and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of destinations referenced in 'targetRef' properties: loadBalancer: description: >- LoadBalancer allows to specify load balancing algorithm. properties: leastRequest: description: >- LeastRequest selects N random available hosts as specified in 'choiceCount' (2 by default) and picks the host which has the fewest active requests properties: activeRequestBias: anyOf: - type: integer - type: string description: >- ActiveRequestBias refers to dynamic weights applied when hosts have varying load balancing weights. A higher value here aggressively reduces the weight of endpoints that are currently handling active requests. In essence, the higher the ActiveRequestBias value, the more forcefully it reduces the load balancing weight of endpoints that are actively serving requests. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false choiceCount: description: >- ChoiceCount is the number of random healthy hosts from which the host with the fewest active requests will be chosen. Defaults to 2 so that Envoy performs two-choice selection if the field is not set. format: int32 minimum: 2 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false maglev: description: >- Maglev implements consistent hashing to upstream hosts. Maglev can be used as a drop in replacement for the ring hash load balancer any place in which consistent hashing is desired. properties: hashPolicies: description: >- HashPolicies specify a list of request/connection properties that are used to calculate a hash. These hash policies are executed in the specified order. If a hash policy has the “terminal” attribute set to true, and there is already a hash generated, the hash is returned immediately, ignoring the rest of the hash policy list. items: properties: connection: properties: sourceIP: description: Hash on source IP address. type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false cookie: properties: name: description: >- The name of the cookie that will be used to obtain the hash key. minLength: 1 type: string x-speakeasy-param-computed: false path: description: The name of the path for the cookie. type: string x-speakeasy-param-computed: false ttl: description: >- If specified, a cookie with the TTL will be generated if the cookie is not present. type: string x-speakeasy-param-computed: false required: - name type: object x-speakeasy-param-computed: false filterState: properties: key: description: >- The name of the Object in the per-request filterState, which is an Envoy::Hashable object. If there is no data associated with the key, or the stored object is not Envoy::Hashable, no hash will be produced. minLength: 1 type: string x-speakeasy-param-computed: false required: - key type: object x-speakeasy-param-computed: false header: properties: name: description: >- The name of the request header that will be used to obtain the hash key. minLength: 1 type: string x-speakeasy-param-computed: false required: - name type: object x-speakeasy-param-computed: false queryParameter: properties: name: description: >- The name of the URL query parameter that will be used to obtain the hash key. If the parameter is not present, no hash will be produced. Query parameter names are case-sensitive. minLength: 1 type: string x-speakeasy-param-computed: false required: - name type: object x-speakeasy-param-computed: false terminal: description: >- Terminal is a flag that short-circuits the hash computing. This field provides a ‘fallback’ style of configuration: “if a terminal policy doesn’t work, fallback to rest of the policy list”, it saves time when the terminal policy works. If true, and there is already a hash computed, ignore rest of the list of hash polices. type: boolean x-speakeasy-param-computed: false type: enum: - Header - Cookie - Connection - SourceIP - QueryParameter - FilterState type: string x-speakeasy-param-computed: false required: - type type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false tableSize: description: >- The table size for Maglev hashing. Maglev aims for “minimal disruption” rather than an absolute guarantee. Minimal disruption means that when the set of upstream hosts change, a connection will likely be sent to the same upstream as it was before. Increasing the table size reduces the amount of disruption. The table size must be prime number limited to 5000011. If it is not specified, the default is 65537. format: int32 maximum: 5000011 minimum: 1 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false random: description: >- Random selects a random available host. The random load balancer generally performs better than round-robin if no health checking policy is configured. Random selection avoids bias towards the host in the set that comes after a failed host. type: object x-speakeasy-param-computed: false ringHash: description: >- RingHash implements consistent hashing to upstream hosts. Each host is mapped onto a circle (the “ring”) by hashing its address; each request is then routed to a host by hashing some property of the request, and finding the nearest corresponding host clockwise around the ring. properties: hashFunction: description: >- HashFunction is a function used to hash hosts onto the ketama ring. The value defaults to XX_HASH. Available values – XX_HASH, MURMUR_HASH_2. enum: - XXHash - MurmurHash2 type: string x-speakeasy-param-computed: false hashPolicies: description: >- HashPolicies specify a list of request/connection properties that are used to calculate a hash. These hash policies are executed in the specified order. If a hash policy has the “terminal” attribute set to true, and there is already a hash generated, the hash is returned immediately, ignoring the rest of the hash policy list. items: properties: connection: properties: sourceIP: description: Hash on source IP address. type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false cookie: properties: name: description: >- The name of the cookie that will be used to obtain the hash key. minLength: 1 type: string x-speakeasy-param-computed: false path: description: The name of the path for the cookie. type: string x-speakeasy-param-computed: false ttl: description: >- If specified, a cookie with the TTL will be generated if the cookie is not present. type: string x-speakeasy-param-computed: false required: - name type: object x-speakeasy-param-computed: false filterState: properties: key: description: >- The name of the Object in the per-request filterState, which is an Envoy::Hashable object. If there is no data associated with the key, or the stored object is not Envoy::Hashable, no hash will be produced. minLength: 1 type: string x-speakeasy-param-computed: false required: - key type: object x-speakeasy-param-computed: false header: properties: name: description: >- The name of the request header that will be used to obtain the hash key. minLength: 1 type: string x-speakeasy-param-computed: false required: - name type: object x-speakeasy-param-computed: false queryParameter: properties: name: description: >- The name of the URL query parameter that will be used to obtain the hash key. If the parameter is not present, no hash will be produced. Query parameter names are case-sensitive. minLength: 1 type: string x-speakeasy-param-computed: false required: - name type: object x-speakeasy-param-computed: false terminal: description: >- Terminal is a flag that short-circuits the hash computing. This field provides a ‘fallback’ style of configuration: “if a terminal policy doesn’t work, fallback to rest of the policy list”, it saves time when the terminal policy works. If true, and there is already a hash computed, ignore rest of the list of hash polices. type: boolean x-speakeasy-param-computed: false type: enum: - Header - Cookie - Connection - SourceIP - QueryParameter - FilterState type: string x-speakeasy-param-computed: false required: - type type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false maxRingSize: description: >- Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. format: int32 maximum: 8000000 minimum: 1 type: integer x-speakeasy-param-computed: false minRingSize: description: >- Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. format: int32 maximum: 8000000 minimum: 1 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false roundRobin: description: >- RoundRobin is a load balancing algorithm that distributes requests across available upstream hosts in round-robin order. type: object x-speakeasy-param-computed: false type: enum: - RoundRobin - LeastRequest - RingHash - Random - Maglev type: string x-speakeasy-param-computed: false required: - type type: object x-speakeasy-param-computed: false localityAwareness: description: >- LocalityAwareness contains configuration for locality aware load balancing. properties: crossZone: description: >- CrossZone defines locality aware load balancing priorities when dataplane proxies inside local zone are unavailable properties: failover: description: >- Failover defines list of load balancing rules in order of priority items: properties: from: description: >- From defines the list of zones to which the rule applies properties: zones: items: type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false required: - zones type: object x-speakeasy-param-computed: false to: description: >- To defines to which zones the traffic should be load balanced properties: type: description: >- Type defines how target zones will be picked from available zones enum: - None - Only - Any - AnyExcept type: string x-speakeasy-param-computed: false zones: items: type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false required: - type type: object x-speakeasy-param-computed: false required: - to type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false failoverThreshold: description: >- FailoverThreshold defines the percentage of live destination dataplane proxies below which load balancing to the next priority starts. Example: If you configure failoverThreshold to 70, and you have deployed 10 destination dataplane proxies. Load balancing to next priority will start when number of live destination dataplane proxies drops below 7. Default 50 properties: percentage: anyOf: - type: integer - type: string x-kubernetes-int-or-string: true x-speakeasy-param-computed: false required: - percentage type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false disabled: description: >- Disabled allows to disable locality-aware load balancing. When disabled requests are distributed across all endpoints regardless of locality. type: boolean x-speakeasy-param-computed: false localZone: description: >- LocalZone defines locality aware load balancing priorities between dataplane proxies inside a zone properties: affinityTags: description: >- AffinityTags list of tags for local zone load balancing. items: properties: key: description: >- Key defines tag for which affinity is configured type: string x-speakeasy-param-computed: false weight: description: >- Weight of the tag used for load balancing. The bigger the weight the bigger the priority. Percentage of local traffic load balanced to tag is computed by dividing weight by sum of weights from all tags. For example with two affinity tags first with weight 80 and second with weight 20, then 80% of traffic will be redirected to the first tag, and 20% of traffic will be redirected to second one. Setting weights is not mandatory. When weights are not set control plane will compute default weight based on list order. Default: If you do not specify weight we will adjust them so that 90% traffic goes to first tag, 9% to next, and 1% to third and so on. format: int32 type: integer x-speakeasy-param-computed: false required: - key type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of destinations. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshLoadBalancingStrategyCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshLoadBalancingStrategyDeleteSuccessResponse: type: object properties: {} MeshMetricItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshMetric x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshMetric resource. properties: default: description: MeshMetric configuration. properties: applications: description: >- Applications is a list of application that Dataplane Proxy will scrape items: properties: address: description: Address on which an application listens. type: string x-speakeasy-param-computed: false name: description: Name of the application to scrape type: string x-speakeasy-param-computed: false path: default: /metrics description: >- Path on which an application expose HTTP endpoint with metrics. type: string x-speakeasy-param-computed: false port: description: >- Port on which an application expose HTTP endpoint with metrics. format: int32 type: integer x-speakeasy-param-computed: false required: - port type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false backends: description: Backends list that will be used to collect metrics. items: properties: openTelemetry: description: OpenTelemetry backend configuration properties: endpoint: description: Endpoint for OpenTelemetry collector type: string x-speakeasy-param-computed: false refreshInterval: description: >- RefreshInterval defines how frequent metrics should be pushed to collector type: string x-speakeasy-param-computed: false required: - endpoint type: object x-speakeasy-param-computed: false prometheus: description: Prometheus backend configuration. properties: clientId: description: >- ClientId of the Prometheus backend. Needed when using MADS for DP discovery. type: string x-speakeasy-param-computed: false path: default: /metrics description: >- Path on which a dataplane should expose HTTP endpoint with Prometheus metrics. type: string x-speakeasy-param-computed: false port: default: 5670 description: >- Port on which a dataplane should expose HTTP endpoint with Prometheus metrics. format: int32 type: integer x-speakeasy-param-computed: false tls: description: Configuration of TLS for prometheus listener. properties: mode: default: Disabled description: Configuration of TLS for Prometheus listener. enum: - Disabled - ProvidedTLS - ActiveMTLSBackend type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: description: >- Type of the backend that will be used to collect metrics. At the moment only Prometheus backend is available. enum: - Prometheus - OpenTelemetry type: string x-speakeasy-param-computed: false required: - type type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sidecar: description: Sidecar metrics collection configuration properties: includeUnused: description: >- IncludeUnused if false will scrape only metrics that has been by sidecar (counters incremented at least once, gauges changed at least once, and histograms added to at least once). If true will scrape all metrics (even the ones with zeros). If not specified then the default value is false. type: boolean x-speakeasy-param-computed: false profiles: description: >- Profiles allows to customize which metrics are published. properties: appendProfiles: description: >- AppendProfiles allows to combine the metrics from multiple predefined profiles. items: properties: name: description: >- Name of the predefined profile, one of: all, basic, none enum: - All - Basic - None type: string x-speakeasy-param-computed: false required: - name type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false exclude: description: >- Exclude makes it possible to exclude groups of metrics from a resulting profile. Exclude is subordinate to Include. items: properties: match: description: >- Match is the value used to match using particular Type type: string x-speakeasy-param-computed: false type: description: >- Type defined the type of selector, one of: prefix, regex, exact enum: - Prefix - Regex - Exact - Contains type: string x-speakeasy-param-computed: false required: - match - type type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false include: description: >- Include makes it possible to include additional metrics in a selected profiles. Include takes precedence over Exclude. items: properties: match: description: >- Match is the value used to match using particular Type type: string x-speakeasy-param-computed: false type: description: >- Type defined the type of selector, one of: prefix, regex, exact enum: - Prefix - Regex - Exact - Contains type: string x-speakeasy-param-computed: false required: - match - type type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined in-place. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshMetricCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshMetricDeleteSuccessResponse: type: object properties: {} MeshPassthroughItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshPassthrough x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshPassthrough resource. properties: default: description: MeshPassthrough configuration. properties: appendMatch: description: >- AppendMatch is a list of destinations that should be allowed through the sidecar. items: properties: port: description: Port defines the port to which a user makes a request. format: int32 type: integer x-speakeasy-param-computed: false protocol: default: tcp description: >- Protocol defines the communication protocol. Possible values: `tcp`, `tls`, `grpc`, `http`, `http2`, `mysql`. enum: - tcp - tls - grpc - http - http2 - mysql type: string x-speakeasy-param-computed: false type: description: >- Type of the match, one of `Domain`, `IP` or `CIDR` is available. enum: - Domain - IP - CIDR type: string x-speakeasy-param-computed: false value: description: Value for the specified Type. type: string x-speakeasy-param-computed: false required: - type - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false passthroughMode: description: >- Defines the passthrough behavior. Possible values: `All`, `None`, `Matched` When `All` or `None` `appendMatch` has no effect. If not specified then the default value is "Matched". enum: - All - Matched - None type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined in-place. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshPassthroughCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshPassthroughDeleteSuccessResponse: type: object properties: {} MeshProxyPatchItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshProxyPatch x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshProxyPatch resource. properties: default: description: |- Default is a configuration specific to the group of destinations referenced in 'targetRef'. properties: appendModifications: description: >- AppendModifications is a list of modifications applied on the selected proxy. items: properties: cluster: description: Cluster is a modification of Envoy's Cluster resource. properties: jsonPatches: description: >- JsonPatches specifies list of jsonpatches to apply to on Envoy's Cluster resource items: description: >- JsonPatchBlock is one json patch operation block. properties: from: description: >- From is a jsonpatch from string, used by move and copy operations. type: string x-speakeasy-param-computed: false op: description: Op is a jsonpatch operation string. enum: - add - remove - replace - move - copy type: string x-speakeasy-param-computed: false path: description: Path is a jsonpatch path string. type: string x-speakeasy-param-computed: false value: description: >- Value must be a valid json value used by replace and add operations. x-kubernetes-preserve-unknown-fields: true x-speakeasy-param-computed: false required: - op - path type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false match: description: >- Match is a set of conditions that have to be matched for modification operation to happen. properties: name: description: Name of the cluster to match. type: string x-speakeasy-param-computed: false origin: description: >- Origin is the name of the component or plugin that generated the resource. Here is the list of well-known origins: inbound - resources generated for handling incoming traffic. outbound - resources generated for handling outgoing traffic. transparent - resources generated for transparent proxy functionality. prometheus - resources generated when Prometheus metrics are enabled. direct-access - resources generated for Direct Access functionality. ingress - resources generated for Zone Ingress. egress - resources generated for Zone Egress. gateway - resources generated for MeshGateway. The list is not complete, because policy plugins can introduce new resources. For example MeshTrace plugin can create Cluster with "mesh-trace" origin. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false operation: description: Operation to execute on matched cluster. enum: - Add - Remove - Patch type: string x-speakeasy-param-computed: false value: description: >- Value of xDS resource in YAML format to add or patch. type: string x-speakeasy-param-computed: false required: - operation type: object x-speakeasy-param-computed: false httpFilter: description: >- HTTPFilter is a modification of Envoy HTTP Filter available in HTTP Connection Manager in a Listener resource. properties: jsonPatches: description: >- JsonPatches specifies list of jsonpatches to apply to on Envoy's HTTP Filter available in HTTP Connection Manager in a Listener resource. items: description: >- JsonPatchBlock is one json patch operation block. properties: from: description: >- From is a jsonpatch from string, used by move and copy operations. type: string x-speakeasy-param-computed: false op: description: Op is a jsonpatch operation string. enum: - add - remove - replace - move - copy type: string x-speakeasy-param-computed: false path: description: Path is a jsonpatch path string. type: string x-speakeasy-param-computed: false value: description: >- Value must be a valid json value used by replace and add operations. x-kubernetes-preserve-unknown-fields: true x-speakeasy-param-computed: false required: - op - path type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false match: description: >- Match is a set of conditions that have to be matched for modification operation to happen. properties: listenerName: description: Name of the listener to match. type: string x-speakeasy-param-computed: false listenerTags: additionalProperties: type: string description: >- Listener tags available in Listener#Metadata#FilterMetadata[io.kuma.tags] type: object x-speakeasy-param-computed: false name: description: >- Name of the HTTP filter. For example "envoy.filters.http.local_ratelimit" type: string x-speakeasy-param-computed: false origin: description: >- Origin is the name of the component or plugin that generated the resource. Here is the list of well-known origins: inbound - resources generated for handling incoming traffic. outbound - resources generated for handling outgoing traffic. transparent - resources generated for transparent proxy functionality. prometheus - resources generated when Prometheus metrics are enabled. direct-access - resources generated for Direct Access functionality. ingress - resources generated for Zone Ingress. egress - resources generated for Zone Egress. gateway - resources generated for MeshGateway. The list is not complete, because policy plugins can introduce new resources. For example MeshTrace plugin can create Cluster with "mesh-trace" origin. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false operation: description: Operation to execute on matched listener. enum: - Remove - Patch - AddFirst - AddBefore - AddAfter - AddLast type: string x-speakeasy-param-computed: false value: description: >- Value of xDS resource in YAML format to add or patch. type: string x-speakeasy-param-computed: false required: - operation type: object x-speakeasy-param-computed: false listener: description: >- Listener is a modification of Envoy's Listener resource. properties: jsonPatches: description: >- JsonPatches specifies list of jsonpatches to apply to on Envoy's Listener resource items: description: >- JsonPatchBlock is one json patch operation block. properties: from: description: >- From is a jsonpatch from string, used by move and copy operations. type: string x-speakeasy-param-computed: false op: description: Op is a jsonpatch operation string. enum: - add - remove - replace - move - copy type: string x-speakeasy-param-computed: false path: description: Path is a jsonpatch path string. type: string x-speakeasy-param-computed: false value: description: >- Value must be a valid json value used by replace and add operations. x-kubernetes-preserve-unknown-fields: true x-speakeasy-param-computed: false required: - op - path type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false match: description: >- Match is a set of conditions that have to be matched for modification operation to happen. properties: name: description: Name of the listener to match. type: string x-speakeasy-param-computed: false origin: description: >- Origin is the name of the component or plugin that generated the resource. Here is the list of well-known origins: inbound - resources generated for handling incoming traffic. outbound - resources generated for handling outgoing traffic. transparent - resources generated for transparent proxy functionality. prometheus - resources generated when Prometheus metrics are enabled. direct-access - resources generated for Direct Access functionality. ingress - resources generated for Zone Ingress. egress - resources generated for Zone Egress. gateway - resources generated for MeshGateway. The list is not complete, because policy plugins can introduce new resources. For example MeshTrace plugin can create Cluster with "mesh-trace" origin. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags available in Listener#Metadata#FilterMetadata[io.kuma.tags] type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false operation: description: Operation to execute on matched listener. enum: - Add - Remove - Patch type: string x-speakeasy-param-computed: false value: description: >- Value of xDS resource in YAML format to add or patch. type: string x-speakeasy-param-computed: false required: - operation type: object x-speakeasy-param-computed: false networkFilter: description: >- NetworkFilter is a modification of Envoy Listener's filter. properties: jsonPatches: description: >- JsonPatches specifies list of jsonpatches to apply to on Envoy Listener's filter. items: description: >- JsonPatchBlock is one json patch operation block. properties: from: description: >- From is a jsonpatch from string, used by move and copy operations. type: string x-speakeasy-param-computed: false op: description: Op is a jsonpatch operation string. enum: - add - remove - replace - move - copy type: string x-speakeasy-param-computed: false path: description: Path is a jsonpatch path string. type: string x-speakeasy-param-computed: false value: description: >- Value must be a valid json value used by replace and add operations. x-kubernetes-preserve-unknown-fields: true x-speakeasy-param-computed: false required: - op - path type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false match: description: >- Match is a set of conditions that have to be matched for modification operation to happen. properties: listenerName: description: Name of the listener to match. type: string x-speakeasy-param-computed: false listenerTags: additionalProperties: type: string description: >- Listener tags available in Listener#Metadata#FilterMetadata[io.kuma.tags] type: object x-speakeasy-param-computed: false name: description: >- Name of the network filter. For example "envoy.filters.network.ratelimit" type: string x-speakeasy-param-computed: false origin: description: >- Origin is the name of the component or plugin that generated the resource. Here is the list of well-known origins: inbound - resources generated for handling incoming traffic. outbound - resources generated for handling outgoing traffic. transparent - resources generated for transparent proxy functionality. prometheus - resources generated when Prometheus metrics are enabled. direct-access - resources generated for Direct Access functionality. ingress - resources generated for Zone Ingress. egress - resources generated for Zone Egress. gateway - resources generated for MeshGateway. The list is not complete, because policy plugins can introduce new resources. For example MeshTrace plugin can create Cluster with "mesh-trace" origin. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false operation: description: Operation to execute on matched listener. enum: - Remove - Patch - AddFirst - AddBefore - AddAfter - AddLast type: string x-speakeasy-param-computed: false value: description: >- Value of xDS resource in YAML format to add or patch. type: string x-speakeasy-param-computed: false required: - operation type: object x-speakeasy-param-computed: false virtualHost: description: >- VirtualHost is a modification of Envoy's VirtualHost referenced in HTTP Connection Manager in a Listener resource. properties: jsonPatches: description: >- JsonPatches specifies list of jsonpatches to apply to on Envoy's VirtualHost resource items: description: >- JsonPatchBlock is one json patch operation block. properties: from: description: >- From is a jsonpatch from string, used by move and copy operations. type: string x-speakeasy-param-computed: false op: description: Op is a jsonpatch operation string. enum: - add - remove - replace - move - copy type: string x-speakeasy-param-computed: false path: description: Path is a jsonpatch path string. type: string x-speakeasy-param-computed: false value: description: >- Value must be a valid json value used by replace and add operations. x-kubernetes-preserve-unknown-fields: true x-speakeasy-param-computed: false required: - op - path type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false match: description: >- Match is a set of conditions that have to be matched for modification operation to happen. properties: name: description: Name of the VirtualHost to match. type: string x-speakeasy-param-computed: false origin: description: >- Origin is the name of the component or plugin that generated the resource. Here is the list of well-known origins: inbound - resources generated for handling incoming traffic. outbound - resources generated for handling outgoing traffic. transparent - resources generated for transparent proxy functionality. prometheus - resources generated when Prometheus metrics are enabled. direct-access - resources generated for Direct Access functionality. ingress - resources generated for Zone Ingress. egress - resources generated for Zone Egress. gateway - resources generated for MeshGateway. The list is not complete, because policy plugins can introduce new resources. For example MeshTrace plugin can create Cluster with "mesh-trace" origin. type: string x-speakeasy-param-computed: false routeConfigurationName: description: >- Name of the RouteConfiguration resource to match. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false operation: description: Operation to execute on matched listener. enum: - Add - Remove - Patch type: string x-speakeasy-param-computed: false value: description: >- Value of xDS resource in YAML format to add or patch. type: string x-speakeasy-param-computed: false required: - match - operation type: object x-speakeasy-param-computed: false type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined inplace. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - default type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshProxyPatchCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshProxyPatchDeleteSuccessResponse: type: object properties: {} MeshRateLimitItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshRateLimit x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshRateLimit resource. properties: from: description: >- From list makes a match between clients and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of clients referenced in 'targetRef' properties: local: description: >- LocalConf defines local http or/and tcp rate limit configuration properties: http: description: >- LocalHTTP defines configuration of local HTTP rate limiting https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/local_rate_limit_filter properties: disabled: description: Define if rate limiting should be disabled. type: boolean x-speakeasy-param-computed: false onRateLimit: description: >- Describes the actions to take on a rate limit event properties: headers: description: >- The Headers to be added to the HTTP response on a rate limit event properties: add: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false set: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false status: description: >- The HTTP status code to be set on a rate limit event format: int32 type: integer type: object x-speakeasy-param-computed: false requestRate: description: >- Defines how many requests are allowed per interval. properties: interval: description: >- The interval the number of units is accounted for. type: string x-speakeasy-param-computed: false num: description: >- Number of units per interval (depending on usage it can be a number of requests, or a number of connections). format: int32 type: integer x-speakeasy-param-computed: false required: - interval - num type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false tcp: description: >- LocalTCP defines confguration of local TCP rate limiting https://www.envoyproxy.io/docs/envoy/latest/configuration/listeners/network_filters/local_rate_limit_filter properties: connectionRate: description: >- Defines how many connections are allowed per interval. properties: interval: description: >- The interval the number of units is accounted for. type: string x-speakeasy-param-computed: false num: description: >- Number of units per interval (depending on usage it can be a number of requests, or a number of connections). format: int32 type: integer x-speakeasy-param-computed: false required: - interval - num type: object x-speakeasy-param-computed: false disabled: description: |- Define if rate limiting should be disabled. Default: false type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of clients. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false rules: description: >- Rules defines inbound rate limiting configurations. Currently limited to selecting all inbound traffic, as L7 matching is not yet implemented. items: properties: default: description: Default contains configuration of the inbound rate limits properties: local: description: >- LocalConf defines local http or/and tcp rate limit configuration properties: http: description: >- LocalHTTP defines configuration of local HTTP rate limiting https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/local_rate_limit_filter properties: disabled: description: Define if rate limiting should be disabled. type: boolean x-speakeasy-param-computed: false onRateLimit: description: >- Describes the actions to take on a rate limit event properties: headers: description: >- The Headers to be added to the HTTP response on a rate limit event properties: add: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false set: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false status: description: >- The HTTP status code to be set on a rate limit event format: int32 type: integer type: object x-speakeasy-param-computed: false requestRate: description: >- Defines how many requests are allowed per interval. properties: interval: description: >- The interval the number of units is accounted for. type: string x-speakeasy-param-computed: false num: description: >- Number of units per interval (depending on usage it can be a number of requests, or a number of connections). format: int32 type: integer x-speakeasy-param-computed: false required: - interval - num type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false tcp: description: >- LocalTCP defines confguration of local TCP rate limiting https://www.envoyproxy.io/docs/envoy/latest/configuration/listeners/network_filters/local_rate_limit_filter properties: connectionRate: description: >- Defines how many connections are allowed per interval. properties: interval: description: >- The interval the number of units is accounted for. type: string x-speakeasy-param-computed: false num: description: >- Number of units per interval (depending on usage it can be a number of requests, or a number of connections). format: int32 type: integer x-speakeasy-param-computed: false required: - interval - num type: object x-speakeasy-param-computed: false disabled: description: |- Define if rate limiting should be disabled. Default: false type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined inplace. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false to: description: >- To list makes a match between clients and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of clients referenced in 'targetRef' properties: local: description: >- LocalConf defines local http or/and tcp rate limit configuration properties: http: description: >- LocalHTTP defines configuration of local HTTP rate limiting https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/local_rate_limit_filter properties: disabled: description: Define if rate limiting should be disabled. type: boolean x-speakeasy-param-computed: false onRateLimit: description: >- Describes the actions to take on a rate limit event properties: headers: description: >- The Headers to be added to the HTTP response on a rate limit event properties: add: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false set: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false status: description: >- The HTTP status code to be set on a rate limit event format: int32 type: integer type: object x-speakeasy-param-computed: false requestRate: description: >- Defines how many requests are allowed per interval. properties: interval: description: >- The interval the number of units is accounted for. type: string x-speakeasy-param-computed: false num: description: >- Number of units per interval (depending on usage it can be a number of requests, or a number of connections). format: int32 type: integer x-speakeasy-param-computed: false required: - interval - num type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false tcp: description: >- LocalTCP defines confguration of local TCP rate limiting https://www.envoyproxy.io/docs/envoy/latest/configuration/listeners/network_filters/local_rate_limit_filter properties: connectionRate: description: >- Defines how many connections are allowed per interval. properties: interval: description: >- The interval the number of units is accounted for. type: string x-speakeasy-param-computed: false num: description: >- Number of units per interval (depending on usage it can be a number of requests, or a number of connections). format: int32 type: integer x-speakeasy-param-computed: false required: - interval - num type: object x-speakeasy-param-computed: false disabled: description: |- Define if rate limiting should be disabled. Default: false type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of clients. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshRateLimitCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshRateLimitDeleteSuccessResponse: type: object properties: {} MeshRetryItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshRetry x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshRetry resource. properties: targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined inplace. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false to: description: >- To list makes a match between the consumed services and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of destinations referenced in 'targetRef' properties: grpc: description: >- GRPC defines a configuration of retries for GRPC traffic properties: backOff: description: >- BackOff is a configuration of durations which will be used in an exponential backoff strategy between retries. properties: baseInterval: description: >- BaseInterval is an amount of time which should be taken between retries. Must be greater than zero. Values less than 1 ms are rounded up to 1 ms. If not specified then the default value is "25ms". type: string x-speakeasy-param-computed: false maxInterval: description: >- MaxInterval is a maximal amount of time which will be taken between retries. Default is 10 times the "BaseInterval". type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false numRetries: description: >- NumRetries is the number of attempts that will be made on failed (and retriable) requests. If not set, the default value is 1. format: int32 type: integer x-speakeasy-param-computed: false perTryTimeout: description: >- PerTryTimeout is the maximum amount of time each retry attempt can take before it times out. If not set, the global request timeout for the route will be used. Setting this value to 0 will disable the per-try timeout. type: string x-speakeasy-param-computed: false rateLimitedBackOff: description: >- RateLimitedBackOff is a configuration of backoff which will be used when the upstream returns one of the headers configured. properties: maxInterval: description: >- MaxInterval is a maximal amount of time which will be taken between retries. If not specified then the default value is "300s". type: string x-speakeasy-param-computed: false resetHeaders: description: >- ResetHeaders specifies the list of headers (like Retry-After or X-RateLimit-Reset) to match against the response. Headers are tried in order, and matched case-insensitive. The first header to be parsed successfully is used. If no headers match the default exponential BackOff is used instead. items: properties: format: description: The format of the reset header. enum: - Seconds - UnixTimestamp type: string x-speakeasy-param-computed: false name: description: The Name of the reset header. maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false required: - format - name type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false retryOn: description: >- RetryOn is a list of conditions which will cause a retry. example: - Canceled - DeadlineExceeded - Internal - ResourceExhausted - Unavailable items: enum: - Canceled - DeadlineExceeded - Internal - ResourceExhausted - Unavailable type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false http: description: >- HTTP defines a configuration of retries for HTTP traffic properties: backOff: description: >- BackOff is a configuration of durations which will be used in exponential backoff strategy between retries. properties: baseInterval: description: >- BaseInterval is an amount of time which should be taken between retries. Must be greater than zero. Values less than 1 ms are rounded up to 1 ms. If not specified then the default value is "25ms". type: string x-speakeasy-param-computed: false maxInterval: description: >- MaxInterval is a maximal amount of time which will be taken between retries. Default is 10 times the "BaseInterval". type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false hostSelection: description: >- HostSelection is a list of predicates that dictate how hosts should be selected when requests are retried. items: properties: predicate: description: Type is requested predicate mode. enum: - OmitPreviousHosts - OmitHostsWithTags - OmitPreviousPriorities type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags is a map of metadata to match against for selecting the omitted hosts. Required if Type is OmitHostsWithTags type: object x-speakeasy-param-computed: false updateFrequency: default: 2 description: >- UpdateFrequency is how often the priority load should be updated based on previously attempted priorities. Used for OmitPreviousPriorities. format: int32 type: integer x-speakeasy-param-computed: false required: - predicate type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false hostSelectionMaxAttempts: description: >- HostSelectionMaxAttempts is the maximum number of times host selection will be reattempted before giving up, at which point the host that was last selected will be routed to. If unspecified, this will default to retrying once. format: int64 type: integer x-speakeasy-param-computed: false numRetries: description: >- NumRetries is the number of attempts that will be made on failed (and retriable) requests. If not set, the default value is 1. format: int32 type: integer x-speakeasy-param-computed: false perTryTimeout: description: >- PerTryTimeout is the amount of time after which retry attempt should time out. If left unspecified, the global route timeout for the request will be used. Consequently, when using a 5xx based retry policy, a request that times out will not be retried as the total timeout budget would have been exhausted. Setting this timeout to 0 will disable it. type: string x-speakeasy-param-computed: false rateLimitedBackOff: description: >- RateLimitedBackOff is a configuration of backoff which will be used when the upstream returns one of the headers configured. properties: maxInterval: description: >- MaxInterval is a maximal amount of time which will be taken between retries. If not specified then the default value is "300s". type: string x-speakeasy-param-computed: false resetHeaders: description: >- ResetHeaders specifies the list of headers (like Retry-After or X-RateLimit-Reset) to match against the response. Headers are tried in order, and matched case-insensitive. The first header to be parsed successfully is used. If no headers match the default exponential BackOff is used instead. items: properties: format: description: The format of the reset header. enum: - Seconds - UnixTimestamp type: string x-speakeasy-param-computed: false name: description: The Name of the reset header. maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false required: - format - name type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false retriableRequestHeaders: description: >- RetriableRequestHeaders is an HTTP headers which must be present in the request for retries to be attempted. items: description: >- HeaderMatch describes how to select an HTTP route by matching HTTP request headers. properties: name: description: >- Name is the name of the HTTP Header to be matched. Name MUST be lower case as they will be handled with case insensitivity (See https://tools.ietf.org/html/rfc7230#section-3.2). maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false type: default: Exact description: >- Type specifies how to match against the value of the header. enum: - Exact - Present - RegularExpression - Absent - Prefix type: string x-speakeasy-param-computed: false value: description: >- Value is the value of HTTP Header to be matched. type: string x-speakeasy-param-computed: false required: - name type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false retriableResponseHeaders: description: >- RetriableResponseHeaders is an HTTP response headers that trigger a retry if present in the response. A retry will be triggered if any of the header matches the upstream response headers. items: description: >- HeaderMatch describes how to select an HTTP route by matching HTTP request headers. properties: name: description: >- Name is the name of the HTTP Header to be matched. Name MUST be lower case as they will be handled with case insensitivity (See https://tools.ietf.org/html/rfc7230#section-3.2). maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false type: default: Exact description: >- Type specifies how to match against the value of the header. enum: - Exact - Present - RegularExpression - Absent - Prefix type: string x-speakeasy-param-computed: false value: description: >- Value is the value of HTTP Header to be matched. type: string x-speakeasy-param-computed: false required: - name type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false retryOn: description: >- RetryOn is a list of conditions which will cause a retry. Available values are: [5XX, GatewayError, Reset, Retriable4xx, ConnectFailure, EnvoyRatelimited, RefusedStream, Http3PostConnectFailure, HttpMethodConnect, HttpMethodDelete, HttpMethodGet, HttpMethodHead, HttpMethodOptions, HttpMethodPatch, HttpMethodPost, HttpMethodPut, HttpMethodTrace]. Also, any HTTP status code (500, 503, etc.). example: - 5XX - GatewayError - Reset - Retriable4xx - ConnectFailure - EnvoyRatelimited - RefusedStream - Http3PostConnectFailure - HttpMethodConnect - HttpMethodDelete - HttpMethodGet - HttpMethodHead - HttpMethodOptions - HttpMethodPatch - HttpMethodPost - HttpMethodPut - HttpMethodTrace - '500' - '503' items: type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false tcp: description: TCP defines a configuration of retries for TCP traffic properties: maxConnectAttempt: description: >- MaxConnectAttempt is a maximal amount of TCP connection attempts which will be made before giving up format: int32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of destinations. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshRetryCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshRetryDeleteSuccessResponse: type: object properties: {} MeshTCPRouteItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshTCPRoute x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshTCPRoute resource. properties: targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined in-place. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false to: description: >- To list makes a match between the consumed services and corresponding configurations items: properties: rules: description: >- Rules contains the routing rules applies to a combination of top-level targetRef and the targetRef in this entry. items: properties: default: description: >- Default holds routing rules that can be merged with rules from other policies. properties: backendRefs: items: description: BackendRef defines where to forward traffic. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false port: description: >- Port is only supported when this ref refers to a real MeshService object format: int32 type: integer x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false weight: default: 1 minimum: 0 type: integer x-speakeasy-param-computed: false required: - kind type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false required: - default type: object maxItems: 1 type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of destinations. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - rules - targetRef type: object minItems: 1 type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshTCPRouteCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshTCPRouteDeleteSuccessResponse: type: object properties: {} MeshTimeoutItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshTimeout x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshTimeout resource. properties: from: description: >- From list makes a match between clients and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of clients referenced in 'targetRef' properties: connectionTimeout: description: >- ConnectionTimeout specifies the amount of time proxy will wait for an TCP connection to be established. Default value is 5 seconds. Cannot be set to 0. type: string x-speakeasy-param-computed: false http: description: Http provides configuration for HTTP specific timeouts properties: maxConnectionDuration: description: >- MaxConnectionDuration is the time after which a connection will be drained and/or closed, starting from when it was first established. Setting this timeout to 0 will disable it. Disabled by default. type: string x-speakeasy-param-computed: false maxStreamDuration: description: >- MaxStreamDuration is the maximum time that a stream’s lifetime will span. Setting this timeout to 0 will disable it. Disabled by default. type: string x-speakeasy-param-computed: false requestHeadersTimeout: description: >- RequestHeadersTimeout The amount of time that proxy will wait for the request headers to be received. The timer is activated when the first byte of the headers is received, and is disarmed when the last byte of the headers has been received. If not specified or set to 0, this timeout is disabled. Disabled by default. type: string x-speakeasy-param-computed: false requestTimeout: description: >- RequestTimeout The amount of time that proxy will wait for the entire request to be received. The timer is activated when the request is initiated, and is disarmed when the last byte of the request is sent, OR when the response is initiated. Setting this timeout to 0 will disable it. Default is 15s. type: string x-speakeasy-param-computed: false streamIdleTimeout: description: >- StreamIdleTimeout is the amount of time that proxy will allow a stream to exist with no activity. Setting this timeout to 0 will disable it. Default is 30m type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false idleTimeout: description: >- IdleTimeout is defined as the period in which there are no bytes sent or received on connection Setting this timeout to 0 will disable it. Be cautious when disabling it because it can lead to connection leaking. Default value is 1h. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of clients. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false rules: description: >- Rules defines inbound timeout configurations. Currently limited to exactly one rule containing default timeouts that apply to all inbound traffic, as L7 matching is not yet implemented. items: properties: default: description: Default contains configuration of the inbound timeouts properties: connectionTimeout: description: >- ConnectionTimeout specifies the amount of time proxy will wait for an TCP connection to be established. Default value is 5 seconds. Cannot be set to 0. type: string x-speakeasy-param-computed: false http: description: Http provides configuration for HTTP specific timeouts properties: maxConnectionDuration: description: >- MaxConnectionDuration is the time after which a connection will be drained and/or closed, starting from when it was first established. Setting this timeout to 0 will disable it. Disabled by default. type: string x-speakeasy-param-computed: false maxStreamDuration: description: >- MaxStreamDuration is the maximum time that a stream’s lifetime will span. Setting this timeout to 0 will disable it. Disabled by default. type: string x-speakeasy-param-computed: false requestHeadersTimeout: description: >- RequestHeadersTimeout The amount of time that proxy will wait for the request headers to be received. The timer is activated when the first byte of the headers is received, and is disarmed when the last byte of the headers has been received. If not specified or set to 0, this timeout is disabled. Disabled by default. type: string x-speakeasy-param-computed: false requestTimeout: description: >- RequestTimeout The amount of time that proxy will wait for the entire request to be received. The timer is activated when the request is initiated, and is disarmed when the last byte of the request is sent, OR when the response is initiated. Setting this timeout to 0 will disable it. Default is 15s. type: string x-speakeasy-param-computed: false streamIdleTimeout: description: >- StreamIdleTimeout is the amount of time that proxy will allow a stream to exist with no activity. Setting this timeout to 0 will disable it. Default is 30m type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false idleTimeout: description: >- IdleTimeout is defined as the period in which there are no bytes sent or received on connection Setting this timeout to 0 will disable it. Be cautious when disabling it because it can lead to connection leaking. Default value is 1h. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined inplace. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false to: description: >- To list makes a match between the consumed services and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of destinations referenced in 'targetRef' properties: connectionTimeout: description: >- ConnectionTimeout specifies the amount of time proxy will wait for an TCP connection to be established. Default value is 5 seconds. Cannot be set to 0. type: string x-speakeasy-param-computed: false http: description: Http provides configuration for HTTP specific timeouts properties: maxConnectionDuration: description: >- MaxConnectionDuration is the time after which a connection will be drained and/or closed, starting from when it was first established. Setting this timeout to 0 will disable it. Disabled by default. type: string x-speakeasy-param-computed: false maxStreamDuration: description: >- MaxStreamDuration is the maximum time that a stream’s lifetime will span. Setting this timeout to 0 will disable it. Disabled by default. type: string x-speakeasy-param-computed: false requestHeadersTimeout: description: >- RequestHeadersTimeout The amount of time that proxy will wait for the request headers to be received. The timer is activated when the first byte of the headers is received, and is disarmed when the last byte of the headers has been received. If not specified or set to 0, this timeout is disabled. Disabled by default. type: string x-speakeasy-param-computed: false requestTimeout: description: >- RequestTimeout The amount of time that proxy will wait for the entire request to be received. The timer is activated when the request is initiated, and is disarmed when the last byte of the request is sent, OR when the response is initiated. Setting this timeout to 0 will disable it. Default is 15s. type: string x-speakeasy-param-computed: false streamIdleTimeout: description: >- StreamIdleTimeout is the amount of time that proxy will allow a stream to exist with no activity. Setting this timeout to 0 will disable it. Default is 30m type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false idleTimeout: description: >- IdleTimeout is defined as the period in which there are no bytes sent or received on connection Setting this timeout to 0 will disable it. Be cautious when disabling it because it can lead to connection leaking. Default value is 1h. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of destinations. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshTimeoutCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshTimeoutDeleteSuccessResponse: type: object properties: {} MeshTLSItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshTLS x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshTLS resource. properties: from: description: >- From list makes a match between clients and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of clients referenced in 'targetRef' properties: mode: description: >- Mode defines the behavior of inbound listeners with regard to traffic encryption. enum: - Permissive - Strict type: string x-speakeasy-param-computed: false tlsCiphers: description: >- TlsCiphers section for providing ciphers specification. items: enum: - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-RSA-CHACHA20-POLY1305 type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false tlsVersion: description: Version section for providing version specification. properties: max: default: TLSAuto description: >- Max defines maximum supported version. One of `TLSAuto`, `TLS10`, `TLS11`, `TLS12`, `TLS13`. enum: - TLSAuto - TLS10 - TLS11 - TLS12 - TLS13 type: string x-speakeasy-param-computed: false min: default: TLSAuto description: >- Min defines minimum supported version. One of `TLSAuto`, `TLS10`, `TLS11`, `TLS12`, `TLS13`. enum: - TLSAuto - TLS10 - TLS11 - TLS12 - TLS13 type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of clients. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false rules: description: >- Rules defines inbound tls configurations. Currently limited to selecting all inbound traffic, as L7 matching is not yet implemented. items: properties: default: description: Default contains configuration of the inbound tls properties: mode: description: >- Mode defines the behavior of inbound listeners with regard to traffic encryption. enum: - Permissive - Strict type: string x-speakeasy-param-computed: false tlsCiphers: description: >- TlsCiphers section for providing ciphers specification. items: enum: - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-RSA-CHACHA20-POLY1305 type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false tlsVersion: description: Version section for providing version specification. properties: max: default: TLSAuto description: >- Max defines maximum supported version. One of `TLSAuto`, `TLS10`, `TLS11`, `TLS12`, `TLS13`. enum: - TLSAuto - TLS10 - TLS11 - TLS12 - TLS13 type: string x-speakeasy-param-computed: false min: default: TLSAuto description: >- Min defines minimum supported version. One of `TLSAuto`, `TLS10`, `TLS11`, `TLS12`, `TLS13`. enum: - TLSAuto - TLS10 - TLS11 - TLS12 - TLS13 type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined in-place. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshTLSCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshTLSDeleteSuccessResponse: type: object properties: {} MeshTraceItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshTrace x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshTrace resource. properties: default: description: MeshTrace configuration. properties: backends: description: >- A one element array of backend definition. Envoy allows configuring only 1 backend, so the natural way of representing that would be just one object. Unfortunately due to the reasons explained in MADR 009-tracing-policy this has to be a one element array for now. items: description: Only one of zipkin, datadog or openTelemetry can be used. properties: datadog: description: Datadog backend configuration. properties: splitService: default: false description: >- Determines if datadog service name should be split based on traffic direction and destination. For example, with `splitService: true` and a `backend` service that communicates with a couple of databases, you would get service names like `backend_INBOUND`, `backend_OUTBOUND_db1`, and `backend_OUTBOUND_db2` in Datadog. type: boolean x-speakeasy-param-computed: false url: description: >- Address of Datadog collector, only host and port are allowed (no paths, fragments etc.) type: string x-speakeasy-param-computed: false required: - url type: object x-speakeasy-param-computed: false openTelemetry: description: OpenTelemetry backend configuration. properties: endpoint: description: Address of OpenTelemetry collector. example: otel-collector:4317 minLength: 1 type: string x-speakeasy-param-computed: false required: - endpoint type: object x-speakeasy-param-computed: false type: enum: - Zipkin - Datadog - OpenTelemetry type: string x-speakeasy-param-computed: false zipkin: description: Zipkin backend configuration. properties: apiVersion: default: httpJson description: >- Version of the API. https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/trace/v3/zipkin.proto#L66 enum: - httpJson - httpProto type: string x-speakeasy-param-computed: false sharedSpanContext: default: true description: >- Determines whether client and server spans will share the same span context. https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/trace/v3/zipkin.proto#L63 type: boolean x-speakeasy-param-computed: false traceId128bit: default: false description: Generate 128bit traces. type: boolean x-speakeasy-param-computed: false url: description: Address of Zipkin collector. type: string x-speakeasy-param-computed: false required: - url type: object x-speakeasy-param-computed: false required: - type type: object maxItems: 1 type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sampling: description: >- Sampling configuration. Sampling is the process by which a decision is made on whether to process/export a span or not. properties: client: anyOf: - type: integer - type: string description: >- Target percentage of requests that will be force traced if the 'x-client-trace-id' header is set. Mirror of client_sampling in Envoy https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#L127-L133 Either int or decimal represented as string. If not specified then the default value is 100. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false overall: anyOf: - type: integer - type: string description: >- Target percentage of requests will be traced after all other sampling checks have been applied (client, force tracing, random sampling). This field functions as an upper limit on the total configured sampling rate. For instance, setting client to 100 but overall to 1 will result in only 1% of client requests with the appropriate headers to be force traced. Mirror of overall_sampling in Envoy https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#L142-L150 Either int or decimal represented as string. If not specified then the default value is 100. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false random: anyOf: - type: integer - type: string description: >- Target percentage of requests that will be randomly selected for trace generation, if not requested by the client or not forced. Mirror of random_sampling in Envoy https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#L135-L140 Either int or decimal represented as string. If not specified then the default value is 100. x-kubernetes-int-or-string: true x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false tags: description: >- Custom tags configuration. You can add custom tags to traces based on headers or literal values. items: description: |- Custom tags configuration. Only one of literal or header can be used. properties: header: description: Tag taken from a header. properties: default: description: >- Default value to use if header is missing. If the default is missing and there is no value the tag will not be included. type: string x-speakeasy-param-computed: false name: description: Name of the header. type: string x-speakeasy-param-computed: false required: - name type: object x-speakeasy-param-computed: false literal: description: Tag taken from literal value. type: string x-speakeasy-param-computed: false name: description: Name of the tag. type: string x-speakeasy-param-computed: false required: - name type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined inplace. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshTraceCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshTraceDeleteSuccessResponse: type: object properties: {} MeshTrafficPermissionItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshTrafficPermission x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: >- Spec is the specification of the Kuma MeshTrafficPermission resource. properties: from: description: >- From list makes a match between clients and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of clients referenced in 'targetRef' properties: action: description: >- Action defines a behavior for the specified group of clients: enum: - Allow - Deny - AllowWithShadowDeny type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of clients. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined inplace. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshTrafficPermissionCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshTrafficPermissionDeleteSuccessResponse: type: object properties: {} BuiltinCertificateAuthorityConfig: properties: caCert: properties: expiration: type: string x-speakeasy-param-computed: false rsaBits: format: uint32 type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object DatadogTracingBackendConfig: properties: address: description: Address of datadog collector. type: string x-speakeasy-param-computed: false port: description: Port of datadog collector type: integer x-speakeasy-param-computed: false splitService: description: >- Determines if datadog service name should be split based on traffic direction and destination. For example, with `splitService: true` and a `backend` service that communicates with a couple of databases, you would get service names like `backend_INBOUND`, `backend_OUTBOUND_db1`, and `backend_OUTBOUND_db2` in Datadog. Default: false type: boolean x-speakeasy-param-computed: false type: object FileLoggingBackendConfig: properties: path: description: Path to a file that logs will be written to type: string x-speakeasy-param-computed: false type: object MeshItem: properties: constraints: description: Constraints that applies to the mesh and its entities properties: dataplaneProxy: description: >- DataplaneProxyMembership defines a set of requirements for data plane proxies to be a member of the mesh. properties: requirements: description: >- Requirements defines a set of requirements that data plane proxies must fulfill in order to join the mesh. A data plane proxy must fulfill at least one requirement in order to join the mesh. Empty list of allowed requirements means that any proxy that is not explicitly denied can join. items: description: >- Rules defines a set of rules for data plane proxies to be member of the mesh. properties: tags: additionalProperties: type: string description: >- Tags defines set of required tags. You can specify '*' in value to require non empty value of tag type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: array default: [] x-speakeasy-param-computed: false restrictions: description: >- Restrictions defines a set of restrictions that data plane proxies cannot fulfill in order to join the mesh. A data plane proxy cannot fulfill any requirement in order to join the mesh. Restrictions takes precedence over requirements. items: description: >- Rules defines a set of rules for data plane proxies to be member of the mesh. properties: tags: additionalProperties: type: string description: >- Tags defines set of required tags. You can specify '*' in value to require non empty value of tag type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: array default: [] x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false labels: additionalProperties: type: string type: object x-speakeasy-param-computed: false logging: description: |- Logging settings. +optional properties: backends: description: List of available logging backends items: description: LoggingBackend defines logging backend available to mesh. properties: conf: oneOf: - $ref: '#/components/schemas/FileLoggingBackendConfig' - $ref: '#/components/schemas/TcpLoggingBackendConfig' type: object x-speakeasy-param-computed: false format: description: >- Format of access logs. Placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log type: string x-speakeasy-param-computed: false name: description: >- Name of the backend, can be then used in Mesh.logging.defaultBackend or in TrafficLogging type: string x-speakeasy-param-computed: false type: description: Type of the backend (Kuma ships with 'tcp' and 'file') type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: array default: [] x-speakeasy-param-computed: false defaultBackend: description: Name of the default backend type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false meshServices: properties: mode: oneOf: - type: string - type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false metrics: description: >- Configuration for metrics collected and exposed by dataplanes. Settings defined here become defaults for every dataplane in a given Mesh. Additionally, it is also possible to further customize this configuration for each dataplane individually using Dataplane resource. +optional properties: backends: description: List of available Metrics backends items: description: MetricsBackend defines metric backends properties: conf: oneOf: - $ref: '#/components/schemas/PrometheusMetricsBackendConfig' type: object x-speakeasy-param-computed: false name: description: >- Name of the backend, can be then used in Mesh.metrics.enabledBackend type: string x-speakeasy-param-computed: false type: description: Type of the backend (Kuma ships with 'prometheus') type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: array default: [] x-speakeasy-param-computed: false enabledBackend: description: Name of the enabled backend type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false mtls: description: |- mTLS settings. +optional properties: backends: description: List of available Certificate Authority backends items: description: >- CertificateAuthorityBackend defines Certificate Authority backend properties: conf: oneOf: - $ref: >- #/components/schemas/ProvidedCertificateAuthorityConfig - $ref: '#/components/schemas/BuiltinCertificateAuthorityConfig' - $ref: '#/components/schemas/VaultCertificateAuthorityConfig' - $ref: '#/components/schemas/ACMCertificateAuthorityConfig' - $ref: >- #/components/schemas/CertManagerCertificateAuthorityConfig type: object x-speakeasy-param-computed: false dpCert: description: Dataplane certificate settings properties: requestTimeout: description: >- Timeout on request to CA for DP certificate generation and retrieval properties: nanos: type: integer x-speakeasy-param-computed: false seconds: type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false rotation: description: Rotation settings properties: expiration: description: >- Time after which generated certificate for Dataplane will expire type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false mode: description: >- Mode defines the behaviour of inbound listeners with regard to traffic encryption oneOf: - type: string - type: integer x-speakeasy-param-computed: false name: description: Name of the backend type: string x-speakeasy-param-computed: false rootChain: properties: requestTimeout: description: >- Timeout on request for to CA for root certificate chain. If not specified, defaults to 10s. properties: nanos: type: integer x-speakeasy-param-computed: false seconds: type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: description: >- Type of the backend. Has to be one of the loaded plugins (Kuma ships with builtin and provided) type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: array default: [] x-speakeasy-param-computed: false enabledBackend: description: Name of the enabled backend type: string x-speakeasy-param-computed: false skipValidation: description: If enabled, skips CA validation. type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false name: type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false networking: description: Networking settings of the mesh properties: outbound: description: Outbound settings properties: passthrough: description: Control the passthrough cluster type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false routing: description: Routing settings of the mesh properties: defaultForbidMeshExternalServiceAccess: description: |- If true, blocks traffic to MeshExternalServices. Default: false type: boolean x-speakeasy-param-computed: false localityAwareLoadBalancing: description: Enable the Locality Aware Load Balancing type: boolean x-speakeasy-param-computed: false zoneEgress: description: >- Enable routing traffic to services in other zone or external services through ZoneEgress. Default: false type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false skipCreatingInitialPolicies: description: >- List of policies to skip creating by default when the mesh is created. e.g. TrafficPermission, MeshRetry, etc. An '*' can be used to skip all policies. items: type: string x-speakeasy-param-computed: false type: array default: [] x-speakeasy-param-computed: false tracing: description: |- Tracing settings. +optional properties: backends: description: List of available tracing backends items: description: TracingBackend defines tracing backend available to mesh. properties: conf: oneOf: - $ref: '#/components/schemas/DatadogTracingBackendConfig' - $ref: '#/components/schemas/ZipkinTracingBackendConfig' type: object x-speakeasy-param-computed: false name: description: >- Name of the backend, can be then used in Mesh.tracing.defaultBackend or in TrafficTrace type: string x-speakeasy-param-computed: false sampling: description: >- Percentage of traces that will be sent to the backend (range 0.0 - 100.0). Empty value defaults to 100.0% type: number x-speakeasy-param-computed: false type: description: Type of the backend (Kuma ships with 'zipkin') type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: array default: [] x-speakeasy-param-computed: false defaultBackend: description: Name of the default backend type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: type: string x-speakeasy-param-computed: false required: - type - name type: object MeshCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshDeleteSuccessResponse: type: object properties: {} TcpLoggingBackendConfig: properties: address: description: Address to TCP service that will receive logs type: string x-speakeasy-param-computed: false type: object PrometheusMetricsBackendConfig: properties: aggregate: description: >- Map with the configuration of applications which metrics are going to be scrapped by kuma-dp. items: description: >- PrometheusAggregateMetricsConfig defines endpoints that should be scrapped by kuma-dp for prometheus metrics. properties: address: description: >- Address on which a service expose HTTP endpoint with Prometheus metrics. type: string x-speakeasy-param-computed: false enabled: description: >- If false then the application won't be scrapped. If nil, then it is treated as true and kuma-dp scrapes metrics from the service. type: boolean x-speakeasy-param-computed: false name: description: Name which identify given configuration. type: string x-speakeasy-param-computed: false path: description: >- Path on which a service expose HTTP endpoint with Prometheus metrics. type: string x-speakeasy-param-computed: false port: description: >- Port on which a service expose HTTP endpoint with Prometheus metrics. type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: array x-speakeasy-param-computed: false envoy: description: Configuration of Envoy's metrics. properties: filterRegex: description: >- FilterRegex value that is going to be passed to Envoy for filtering Envoy metrics. type: string x-speakeasy-param-computed: false usedOnly: description: >- If true then return metrics that Envoy has updated (counters incremented at least once, gauges changed at least once, and histograms added to at least once). If nil, then it is treated as false. type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false path: description: >- Path on which a dataplane should expose HTTP endpoint with Prometheus metrics. type: string x-speakeasy-param-computed: false port: description: >- Port on which a dataplane should expose HTTP endpoint with Prometheus metrics. type: integer x-speakeasy-param-computed: false skipMTLS: description: >- If true then endpoints for scraping metrics won't require mTLS even if mTLS is enabled in Mesh. If nil, then it is treated as false. type: boolean x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags associated with an application this dataplane is deployed next to, e.g. service=web, version=1.0. `service` tag is mandatory. type: object x-speakeasy-param-computed: false tls: description: Configuration of TLS for prometheus listener. properties: mode: description: >- mode defines how configured is the TLS for Prometheus. Supported values, delegated, disabled, activeMTLSBackend. Default to `activeMTLSBackend`. oneOf: - type: string - type: integer x-speakeasy-param-computed: false type: object x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object ProvidedCertificateAuthorityConfig: properties: cert: properties: Type: true required: - Type type: object x-speakeasy-param-computed: false key: properties: Type: true required: - Type type: object x-speakeasy-param-computed: false type: object ZipkinTracingBackendConfig: properties: apiVersion: description: >- Version of the API. values: httpJson, httpJsonV1, httpProto. Default: httpJson see https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/trace/v3/trace.proto#envoy-v3-api-enum-config-trace-v3-zipkinconfig-collectorendpointversion type: string x-speakeasy-param-computed: false sharedSpanContext: description: >- Determines whether client and server spans will share the same span context. Default: true. https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/trace/v3/zipkin.proto#config-trace-v3-zipkinconfig type: boolean x-speakeasy-param-computed: false traceId128bit: description: 'Generate 128bit traces. Default: false' type: boolean x-speakeasy-param-computed: false url: description: Address of Zipkin collector. type: string x-speakeasy-param-computed: false type: object MeshGatewayItem: properties: conf: description: The desired configuration of the MeshGateway. properties: listeners: description: >- Listeners define logical endpoints that are bound on this MeshGateway's address(es). items: properties: crossMesh: description: >- CrossMesh enables traffic to flow to this listener only from other meshes. type: boolean x-speakeasy-param-computed: false hostname: description: >- Hostname specifies the virtual hostname to match for protocol types that define this concept. When unspecified, "", or `*`, all hostnames are matched. This field can be omitted for protocols that don't require hostname based matching. type: string x-speakeasy-param-computed: false port: description: |- Port is the network port. Multiple listeners may use the same port, subject to the Listener compatibility rules. type: integer x-speakeasy-param-computed: false protocol: description: >- Protocol specifies the network protocol this listener expects to receive. oneOf: - type: string - type: integer x-speakeasy-param-computed: false resources: description: >- Resources is used to specify listener-specific resource settings. properties: connection_limit: type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags specifies a unique combination of tags that routes can use to match themselves to this listener. When matching routes to listeners, the control plane constructs a set of matching tags for each listener by forming the union of the gateway tags and the listener tags. A route will be attached to the listener if all of the route's tags are preset in the matching tags type: object x-speakeasy-param-computed: false tls: description: |- TLS is the TLS configuration for the Listener. This field is required if the Protocol field is "HTTPS" or "TLS" and ignored otherwise. properties: certificates: description: >- Certificates is an array of datasources that contain TLS certificates and private keys. Each datasource must contain a sequence of PEM-encoded objects. The server certificate and private key are required, but additional certificates are allowed and will be added to the certificate chain. The server certificate must be the first certificate in the datasource. When multiple certificate datasources are configured, they must have different key types. In practice, this means that one datasource should contain an RSA key and certificate, and the other an ECDSA key and certificate. items: description: DataSource defines the source of bytes to use. properties: Type: description: "Types that are assignable to Type:\n\n\t*DataSource_Secret\n\t*DataSource_File\n\t*DataSource_Inline\n\t*DataSource_InlineString" x-speakeasy-param-computed: false required: - Type type: object x-speakeasy-param-computed: false type: array default: [] x-speakeasy-param-computed: false mode: description: >- Mode defines the TLS behavior for the TLS session initiated by the client. oneOf: - type: string - type: integer x-speakeasy-param-computed: false options: description: >- Options should eventually configure how TLS is configured. This is where cipher suite and version configuration can be specified, client certificates enforced, and so on. properties: {} type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: array default: [] x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false labels: additionalProperties: type: string type: object x-speakeasy-param-computed: false mesh: type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false selectors: description: |- Selectors is a list of selectors that are used to match builtin gateway dataplanes that will receive this MeshGateway configuration. items: description: Selector defines structure for selecting tags for given dataplane properties: match: additionalProperties: type: string description: Tags to match, can be used for both source and destinations type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: array default: [] x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags is the set of tags common to all of the gateway's listeners. This field must not include a `kuma.io/service` tag (the service is always defined on the dataplanes). type: object x-speakeasy-param-computed: false type: type: string x-speakeasy-param-computed: false required: - type - name - mesh type: object MeshGatewayCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshGatewayDeleteSuccessResponse: type: object properties: {} HostnameGeneratorItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - HostnameGenerator x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma HostnameGenerator resource. properties: selector: properties: meshExternalService: properties: matchLabels: additionalProperties: type: string type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false meshMultiZoneService: properties: matchLabels: additionalProperties: type: string type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false meshService: properties: matchLabels: additionalProperties: type: string type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false template: type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true HostnameGeneratorCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true HostnameGeneratorDeleteSuccessResponse: type: object properties: {} MeshExternalServiceItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshExternalService x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshExternalService resource. properties: endpoints: description: Endpoints defines a list of destinations to send traffic to. items: properties: address: description: >- Address defines an address to which a user want to send a request. Is possible to provide `domain`, `ip`. example: example.com minLength: 1 type: string x-speakeasy-param-computed: false port: description: Port of the endpoint maximum: 65535 minimum: 1 type: integer x-speakeasy-param-computed: false required: - address - port type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false extension: description: >- Extension struct for a plugin configuration, in the presence of an extension `endpoints` and `tls` are not required anymore - it's up to the extension to validate them independently. properties: config: description: Config freeform configuration for the extension. x-kubernetes-preserve-unknown-fields: true x-speakeasy-plan-modifiers: ArbitraryJSONModifier type: description: Type of the extension. type: string x-speakeasy-param-computed: false required: - type type: object x-speakeasy-param-computed: false match: description: Match defines traffic that should be routed through the sidecar. properties: port: description: Port defines a port to which a user does request. maximum: 65535 minimum: 1 type: integer x-speakeasy-param-computed: false protocol: default: tcp description: >- Protocol defines a protocol of the communication. Possible values: `tcp`, `grpc`, `http`, `http2`. enum: - tcp - grpc - http - http2 type: string x-speakeasy-param-computed: false type: default: HostnameGenerator description: >- Type of the match, only `HostnameGenerator` is available at the moment. enum: - HostnameGenerator type: string x-speakeasy-param-computed: false required: - port type: object x-speakeasy-param-computed: false tls: description: >- Tls provides a TLS configuration when proxy is resposible for a TLS origination properties: allowRenegotiation: default: false description: >- AllowRenegotiation defines if TLS sessions will allow renegotiation. Setting this to true is not recommended for security reasons. type: boolean x-speakeasy-param-computed: false enabled: default: false description: Enabled defines if proxy should originate TLS. type: boolean x-speakeasy-param-computed: false verification: description: Verification section for providing TLS verification details. properties: caCert: description: CaCert defines a certificate of CA. properties: inline: description: Data source is inline bytes. format: byte type: string x-speakeasy-param-computed: false inlineString: description: Data source is inline string` type: string x-speakeasy-param-computed: false secret: description: Data source is a secret with given Secret key. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false clientCert: description: ClientCert defines a certificate of a client. properties: inline: description: Data source is inline bytes. format: byte type: string x-speakeasy-param-computed: false inlineString: description: Data source is inline string` type: string x-speakeasy-param-computed: false secret: description: Data source is a secret with given Secret key. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false clientKey: description: ClientKey defines a client private key. properties: inline: description: Data source is inline bytes. format: byte type: string x-speakeasy-param-computed: false inlineString: description: Data source is inline string` type: string x-speakeasy-param-computed: false secret: description: Data source is a secret with given Secret key. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false mode: default: Secured description: >- Mode defines if proxy should skip verification, one of `SkipSAN`, `SkipCA`, `Secured`, `SkipAll`. Default `Secured`. enum: - SkipSAN - SkipCA - Secured - SkipAll type: string x-speakeasy-param-computed: false serverName: description: >- ServerName overrides the default Server Name Indicator set by Kuma. type: string x-speakeasy-param-computed: false subjectAltNames: description: >- SubjectAltNames list of names to verify in the certificate. items: properties: type: default: Exact description: >- Type specifies matching type, one of `Exact`, `Prefix`. Default: `Exact` enum: - Exact - Prefix type: string x-speakeasy-param-computed: false value: description: Value to match. type: string x-speakeasy-param-computed: false required: - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false version: description: Version section for providing version specification. properties: max: default: TLSAuto description: >- Max defines maximum supported version. One of `TLSAuto`, `TLS10`, `TLS11`, `TLS12`, `TLS13`. enum: - TLSAuto - TLS10 - TLS11 - TLS12 - TLS13 type: string x-speakeasy-param-computed: false min: default: TLSAuto description: >- Min defines minimum supported version. One of `TLSAuto`, `TLS10`, `TLS11`, `TLS12`, `TLS13`. enum: - TLSAuto - TLS10 - TLS11 - TLS12 - TLS13 type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false required: - match type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true status: description: >- Status is the current status of the Kuma MeshExternalService resource. properties: addresses: description: Addresses section for generated domains items: properties: hostname: type: string x-speakeasy-param-computed: false hostnameGeneratorRef: properties: coreName: type: string x-speakeasy-param-computed: false required: - coreName type: object x-speakeasy-param-computed: false origin: type: string x-speakeasy-param-computed: false type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false hostnameGenerators: items: properties: conditions: description: Conditions is an array of hostname generator conditions. items: properties: message: description: >- message is a human readable message indicating details about the transition. This may be an empty string. maxLength: 32768 type: string x-speakeasy-param-computed: false reason: description: >- reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. maxLength: 1024 minLength: 1 pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ type: string x-speakeasy-param-computed: false status: description: >- status of the condition, one of True, False, Unknown. enum: - 'True' - 'False' - Unknown type: string type: description: >- type of condition in CamelCase or in foo.example.com/CamelCase. maxLength: 316 pattern: >- ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$ type: string x-speakeasy-param-computed: false required: - message - reason - status - type type: object type: array x-kubernetes-list-map-keys: - type x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false hostnameGeneratorRef: properties: coreName: type: string x-speakeasy-param-computed: false required: - coreName type: object x-speakeasy-param-computed: false required: - hostnameGeneratorRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false vip: description: Vip section for allocated IP properties: ip: description: >- Value allocated IP for a provided domain with `HostnameGenerator` type in a match section. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object readOnly: true x-speakeasy-param-suppress-computed-diff: true MeshExternalServiceCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshExternalServiceDeleteSuccessResponse: type: object properties: {} MeshMultiZoneServiceItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshMultiZoneService x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshMultiZoneService resource. properties: ports: description: Ports is a list of ports from selected MeshServices items: properties: appProtocol: default: tcp description: Protocol identifies a protocol supported by a service. type: string x-speakeasy-param-computed: false name: type: string x-speakeasy-param-computed: false port: format: int32 type: integer x-speakeasy-param-computed: false required: - port type: object minItems: 1 type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false selector: description: Selector is a way to select multiple MeshServices properties: meshService: description: MeshService selects MeshServices properties: matchLabels: additionalProperties: type: string description: MatchLabels matches multiple MeshServices by labels type: object x-speakeasy-param-computed: false required: - matchLabels type: object x-speakeasy-param-computed: false required: - meshService type: object x-speakeasy-param-computed: false required: - ports - selector type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true status: description: >- Status is the current status of the Kuma MeshMultiZoneService resource. properties: addresses: description: Addresses is a list of addresses generated by HostnameGenerator items: properties: hostname: type: string x-speakeasy-param-computed: false hostnameGeneratorRef: properties: coreName: type: string x-speakeasy-param-computed: false required: - coreName type: object x-speakeasy-param-computed: false origin: type: string x-speakeasy-param-computed: false type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false hostnameGenerators: description: Status of hostnames generator applied on this resource items: properties: conditions: description: Conditions is an array of hostname generator conditions. items: properties: message: description: >- message is a human readable message indicating details about the transition. This may be an empty string. maxLength: 32768 type: string x-speakeasy-param-computed: false reason: description: >- reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. maxLength: 1024 minLength: 1 pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ type: string x-speakeasy-param-computed: false status: description: >- status of the condition, one of True, False, Unknown. enum: - 'True' - 'False' - Unknown type: string type: description: >- type of condition in CamelCase or in foo.example.com/CamelCase. maxLength: 316 pattern: >- ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$ type: string x-speakeasy-param-computed: false required: - message - reason - status - type type: object type: array x-kubernetes-list-map-keys: - type x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false hostnameGeneratorRef: properties: coreName: type: string x-speakeasy-param-computed: false required: - coreName type: object x-speakeasy-param-computed: false required: - hostnameGeneratorRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false meshServices: description: MeshServices is a list of matched MeshServices items: properties: mesh: type: string x-speakeasy-param-computed: false name: description: Name is a core name of MeshService type: string x-speakeasy-param-computed: false namespace: type: string x-speakeasy-param-computed: false zone: type: string x-speakeasy-param-computed: false required: - mesh - name - namespace - zone type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false vips: description: VIPs is a list of assigned Kuma VIPs. items: properties: ip: type: string x-speakeasy-param-computed: false type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object readOnly: true x-speakeasy-param-suppress-computed-diff: true MeshMultiZoneServiceCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshMultiZoneServiceDeleteSuccessResponse: type: object properties: {} MeshServiceItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshService x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshService resource. properties: identities: items: properties: type: enum: - ServiceTag type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - type - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false ports: items: properties: appProtocol: default: tcp description: Protocol identifies a protocol supported by a service. type: string x-speakeasy-param-computed: false name: type: string x-speakeasy-param-computed: false port: format: int32 type: integer x-speakeasy-param-computed: false targetPort: anyOf: - type: integer - type: string x-kubernetes-int-or-string: true x-speakeasy-param-computed: false required: - port type: object type: array x-kubernetes-list-map-keys: - port - appProtocol x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false selector: properties: dataplaneRef: properties: name: type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false dataplaneTags: additionalProperties: type: string type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false state: default: Unavailable description: >- State of MeshService. Available if there is at least one healthy endpoint. Otherwise, Unavailable. It's used for cross zone communication to check if we should send traffic to it, when MeshService is aggregated into MeshMultiZoneService. enum: - Available - Unavailable type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true status: description: Status is the current status of the Kuma MeshService resource. properties: addresses: items: properties: hostname: type: string x-speakeasy-param-computed: false hostnameGeneratorRef: properties: coreName: type: string x-speakeasy-param-computed: false required: - coreName type: object x-speakeasy-param-computed: false origin: type: string x-speakeasy-param-computed: false type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false dataplaneProxies: description: Data plane proxies statistics selected by this MeshService. properties: connected: description: >- Number of data plane proxies connected to the zone control plane type: integer x-speakeasy-param-computed: false healthy: description: >- Number of data plane proxies with all healthy inbounds selected by this MeshService. type: integer x-speakeasy-param-computed: false total: description: Total number of data plane proxies. type: integer x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false hostnameGenerators: items: properties: conditions: description: Conditions is an array of hostname generator conditions. items: properties: message: description: >- message is a human readable message indicating details about the transition. This may be an empty string. maxLength: 32768 type: string x-speakeasy-param-computed: false reason: description: >- reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. maxLength: 1024 minLength: 1 pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ type: string x-speakeasy-param-computed: false status: description: >- status of the condition, one of True, False, Unknown. enum: - 'True' - 'False' - Unknown type: string type: description: >- type of condition in CamelCase or in foo.example.com/CamelCase. maxLength: 316 pattern: >- ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$ type: string x-speakeasy-param-computed: false required: - message - reason - status - type type: object type: array x-kubernetes-list-map-keys: - type x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false hostnameGeneratorRef: properties: coreName: type: string x-speakeasy-param-computed: false required: - coreName type: object x-speakeasy-param-computed: false required: - hostnameGeneratorRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false tls: properties: status: enum: - Ready - NotReady type: string type: object x-speakeasy-param-computed: false vips: items: properties: ip: type: string x-speakeasy-param-computed: false type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object readOnly: true x-speakeasy-param-suppress-computed-diff: true MeshServiceCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshServiceDeleteSuccessResponse: type: object properties: {} VaultCertificateAuthorityConfig: properties: Mode: true type: object ACMCertificateAuthorityConfig: properties: arn: type: string x-speakeasy-param-computed: false auth: properties: awsCredentials: properties: accessKey: properties: Type: true required: - Type type: object x-speakeasy-param-computed: false accessKeySecret: properties: Type: true required: - Type type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false caCert: properties: Type: true required: - Type type: object x-speakeasy-param-computed: false commonName: type: string x-speakeasy-param-computed: false type: object CertManagerCertificateAuthorityConfig: properties: caCert: properties: Type: true required: - Type type: object x-speakeasy-param-computed: false commonName: type: string x-speakeasy-param-computed: false dnsNames: items: type: string x-speakeasy-param-computed: false type: array x-speakeasy-param-computed: false issuerRef: properties: group: type: string x-speakeasy-param-computed: false kind: type: string x-speakeasy-param-computed: false name: type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object MeshControlPlaneFeatures: type: array items: $ref: '#/components/schemas/MeshControlPlaneFeature' MeshControlPlaneFeatureHostnameGenerationCreation: required: - enabled properties: enabled: type: boolean MeshControlPlaneFeatureMeshCreation: required: - enabled properties: enabled: type: boolean MeshControlPlaneFeature: description: > Features to be enabled in the control plane. Currently only defaults are supported. type: object required: - type properties: type: type: string enum: - MeshCreation - HostnameGeneratorCreation hostnameGeneratorCreation: $ref: >- #/components/schemas/MeshControlPlaneFeatureHostnameGenerationCreation meshCreation: $ref: '#/components/schemas/MeshControlPlaneFeatureMeshCreation' MeshGlobalRateLimitItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshGlobalRateLimit x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshGlobalRateLimit resource. properties: from: description: >- From list makes a match between clients and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of clients referenced in 'targetRef' properties: backend: description: >- Backend defines location of rate limit backend service. properties: rateLimitService: properties: limitOnServiceFail: description: >- LimitOnServiceFail will pass limit requests if ratelimit service is not reachable. type: boolean x-speakeasy-param-computed: false timeout: description: >- Timeout for rate limit request made form Data Plane Proxy to rate limit service. type: string x-speakeasy-param-computed: false url: description: Url defines address of rate limit service. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false required: - rateLimitService type: object x-speakeasy-param-computed: false http: properties: disabled: description: Define if rate limiting should be disabled. type: boolean x-speakeasy-param-computed: false onRateLimit: description: >- Describes the actions to take on a rate limit event properties: headers: description: >- The Headers to be added to the HTTP response on a rate limit event properties: add: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false set: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false status: description: >- The HTTP status code to be set on a rate limit event format: int32 type: integer type: object x-speakeasy-param-computed: false ratelimitOnRequest: description: Defines rate limit based on request content items: properties: kind: description: >- Kind defines type of rate limit config. Possible options: OnHeader. enum: - OnHeader type: string x-speakeasy-param-computed: false limits: description: Limits defines limit configuration. items: properties: requestRate: description: >- Defines how many requests are allowed per interval. properties: interval: description: >- The interval the number of units is accounted for. Only 1s, 1m, 1h or 24h can be configured. type: string x-speakeasy-param-computed: false num: description: >- Number of units per interval (depending on usage it can be a number of requests, or a number of connections). format: int32 type: integer x-speakeasy-param-computed: false required: - interval - num type: object x-speakeasy-param-computed: false value: description: >- Value of the request element on which rate limit should apply. E.g. header value. type: string x-speakeasy-param-computed: false required: - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false name: description: >- Name of the request element on which rate limit should apply. E.g. header name. type: string x-speakeasy-param-computed: false required: - kind - limits - name type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false requestRate: description: >- Defines how many requests are allowed per interval. properties: interval: description: >- The interval the number of units is accounted for. Only 1s, 1m, 1h or 24h can be configured. type: string x-speakeasy-param-computed: false num: description: >- Number of units per interval (depending on usage it can be a number of requests, or a number of connections). format: int32 type: integer x-speakeasy-param-computed: false required: - interval - num type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false mode: description: >- Mode defines rate limit behavior when limits are reached. Possible options: Limit and Shadow. Setting Shadow will not block over the limit requests but will update metrics. This is useful for testing rate limit configuration. enum: - Limit - Shadow type: string x-speakeasy-param-computed: false required: - backend - http type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of clients. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined inplace. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false to: description: >- To list makes a match between clients and corresponding configurations items: properties: default: description: >- Default is a configuration specific to the group of clients referenced in 'targetRef' properties: backend: description: >- Backend defines location of rate limit backend service. properties: rateLimitService: properties: limitOnServiceFail: description: >- LimitOnServiceFail will pass limit requests if ratelimit service is not reachable. type: boolean x-speakeasy-param-computed: false timeout: description: >- Timeout for rate limit request made form Data Plane Proxy to rate limit service. type: string x-speakeasy-param-computed: false url: description: Url defines address of rate limit service. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false required: - rateLimitService type: object x-speakeasy-param-computed: false http: properties: disabled: description: Define if rate limiting should be disabled. type: boolean x-speakeasy-param-computed: false onRateLimit: description: >- Describes the actions to take on a rate limit event properties: headers: description: >- The Headers to be added to the HTTP response on a rate limit event properties: add: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false set: items: properties: name: maxLength: 256 minLength: 1 pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$ type: string x-speakeasy-param-computed: false value: type: string x-speakeasy-param-computed: false required: - name - value type: object maxItems: 16 type: array x-kubernetes-list-map-keys: - name x-kubernetes-list-type: map x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false status: description: >- The HTTP status code to be set on a rate limit event format: int32 type: integer type: object x-speakeasy-param-computed: false ratelimitOnRequest: description: Defines rate limit based on request content items: properties: kind: description: >- Kind defines type of rate limit config. Possible options: OnHeader. enum: - OnHeader type: string x-speakeasy-param-computed: false limits: description: Limits defines limit configuration. items: properties: requestRate: description: >- Defines how many requests are allowed per interval. properties: interval: description: >- The interval the number of units is accounted for. Only 1s, 1m, 1h or 24h can be configured. type: string x-speakeasy-param-computed: false num: description: >- Number of units per interval (depending on usage it can be a number of requests, or a number of connections). format: int32 type: integer x-speakeasy-param-computed: false required: - interval - num type: object x-speakeasy-param-computed: false value: description: >- Value of the request element on which rate limit should apply. E.g. header value. type: string x-speakeasy-param-computed: false required: - value type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false name: description: >- Name of the request element on which rate limit should apply. E.g. header name. type: string x-speakeasy-param-computed: false required: - kind - limits - name type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false requestRate: description: >- Defines how many requests are allowed per interval. properties: interval: description: >- The interval the number of units is accounted for. Only 1s, 1m, 1h or 24h can be configured. type: string x-speakeasy-param-computed: false num: description: >- Number of units per interval (depending on usage it can be a number of requests, or a number of connections). format: int32 type: integer x-speakeasy-param-computed: false required: - interval - num type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false mode: description: >- Mode defines rate limit behavior when limits are reached. Possible options: Limit and Shadow. Setting Shadow will not block over the limit requests but will update metrics. This is useful for testing rate limit configuration. enum: - Limit - Shadow type: string x-speakeasy-param-computed: false required: - backend - http type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource that represents a group of clients. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false required: - targetRef type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshGlobalRateLimitCreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshGlobalRateLimitDeleteSuccessResponse: type: object properties: {} MeshOPAItem: type: object required: - type - name - spec properties: type: description: the type of the resource type: string enum: - MeshOPA x-speakeasy-param-computed: false mesh: description: >- Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. type: string default: default x-speakeasy-param-force-new: true x-speakeasy-param-computed: false name: description: Name of the Kuma resource type: string x-speakeasy-param-force-new: true x-speakeasy-param-computed: false labels: additionalProperties: type: string description: The labels to help identity resources type: object x-speakeasy-param-computed: false spec: description: Spec is the specification of the Kuma MeshOPA resource. properties: default: properties: agentConfig: description: AgentConfig defines bootstrap OPA agent configuration. properties: inline: description: Data source is inline bytes. format: byte type: string x-speakeasy-param-computed: false inlineString: description: Data source is inline string` type: string x-speakeasy-param-computed: false secret: description: Data source is a secret with given Secret key. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false appendPolicies: description: >- Policies define OPA policies that will be applied on OPA Agent. items: properties: ignoreDecision: description: >- If true, then policy won't be taken into account when making a decision. type: boolean x-speakeasy-param-computed: false rego: description: >- OPA Policy written in Rego. Available values: secret, inline, inlineString. properties: inline: description: Data source is inline bytes. format: byte type: string x-speakeasy-param-computed: false inlineString: description: Data source is inline string` type: string x-speakeasy-param-computed: false secret: description: Data source is a secret with given Secret key. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false required: - rego type: object type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false authConfig: description: AuthConfig are configurations specific to the filter. properties: onAgentFailure: description: >- OnAgentFailure either 'allow' or 'deny' (default to deny) whether to allow requests when the authorization agent failed. enum: - Allow - Deny type: string x-speakeasy-param-computed: false requestBody: description: >- RequestBody configuration to apply on the request body sent to the authorization agent (if absent, the body is not sent). properties: maxSize: description: >- MaxSize defines the maximum payload size sent to authorization agent. If the payload is larger it will be truncated and there will be a header `x-envoy-auth-partial-body: true`. If it is set to 0 no body will be sent to the agent. format: int32 type: integer x-speakeasy-param-computed: false sendRawBody: description: >- SendRawBody enable sending raw body instead of the body encoded into UTF-8 type: boolean x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false statusOnError: description: >- StatusOnError is the http status to return when there's a connection failure between the dataplane and the authorization agent format: int32 type: integer x-speakeasy-param-computed: false timeout: description: >- Timeout for the single gRPC request from Envoy to OPA Agent. type: string x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false targetRef: description: >- TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined inplace. properties: kind: description: Kind of the referenced resource enum: - Mesh - MeshSubset - MeshGateway - MeshService - MeshExternalService - MeshMultiZoneService - MeshServiceSubset - MeshHTTPRoute - Dataplane type: string x-speakeasy-param-computed: false labels: additionalProperties: type: string description: >- Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. type: object x-speakeasy-param-computed: false mesh: description: >- Mesh is reserved for future use to identify cross mesh resources. type: string x-speakeasy-param-computed: false name: description: >- Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` type: string x-speakeasy-param-computed: false namespace: description: >- Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. type: string x-speakeasy-param-computed: false proxyTypes: description: >- ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. items: enum: - Sidecar - Gateway type: string type: array x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false sectionName: description: >- SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. type: string x-speakeasy-param-computed: false tags: additionalProperties: type: string description: >- Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` type: object x-speakeasy-param-computed: false required: - kind type: object x-speakeasy-param-computed: false type: object x-speakeasy-param-computed: false creationTime: readOnly: true type: string description: Time at which the resource was created format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true modificationTime: readOnly: true type: string description: Time at which the resource was updated format: date-time example: '0001-01-01T00:00:00Z' x-speakeasy-param-suppress-computed-diff: true MeshOPACreateOrUpdateSuccessResponse: type: object properties: warnings: type: array readOnly: true description: > warnings is a list of warning messages to return to the requesting Kuma API clients. Warning messages describe a problem the client making the API request should correct or be aware of. items: type: string x-speakeasy-plan-modifiers: SupressZeroNullModifier x-speakeasy-param-computed: false x-speakeasy-param-suppress-computed-diff: true MeshOPADeleteSuccessResponse: type: object properties: {} MeshControlPlaneLabels: title: Labels type: object nullable: true example: test: 'true' description: >- Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters. maxProperties: 10 additionalProperties: type: string pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z\-\.\_]*[a-z0-9A-Z]+)?$ minLength: 1 maxLength: 63 nullable: true MeshControlPlaneNonNullableLabels: title: Labels type: object nullable: true example: test: 'true' description: >- Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters. maxProperties: 10 additionalProperties: type: string pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z\-\.\_]*[a-z0-9A-Z]+)?$ minLength: 1 maxLength: 63 MeshControlPlane: type: object title: ControlPlane description: a control plane required: - id - name - updated_at - created_at properties: id: type: string format: uuid description: ID of the control plane. 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 CreateMeshControlPlaneRequest: type: object title: CreateMeshControlPlaneRequest description: a payload to create a control plane required: - name additionalProperties: false properties: name: $ref: '#/components/schemas/MeshControlPlaneName' description: $ref: '#/components/schemas/MeshControlPlaneDescription' features: $ref: '#/components/schemas/MeshControlPlaneFeatures' labels: $ref: '#/components/schemas/MeshControlPlaneLabels' PutMeshControlPlaneRequest: type: object title: PutMeshControlPlaneRequest description: a payload to update the whole control plane properties: name: $ref: '#/components/schemas/MeshControlPlaneName' description: $ref: '#/components/schemas/MeshControlPlaneDescription' labels: $ref: '#/components/schemas/MeshControlPlaneNonNullableLabels' required: - name MeshControlPlaneName: type: string example: Test control plane description: The name of the control plane. minLength: 1 maxLength: 100 pattern: ^[a-z0-9A-Z]{1}.*$ MeshControlPlaneDescription: type: string example: A control plane to handle traffic on development environment. maxLength: 250 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](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard. The PAT 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 kpat_xgfT...'` 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 authenticate with.