Kuma API

naftiko: 1.0.0-alpha2
info:
  label: Kuma API
  description: Kuma API
  tags:
  - Kuma
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: kuma
    baseUri: https://api.example.com
    description: Kuma API HTTP API.
    authentication:
      type: basic
      username: '{{KUMA_USERNAME}}'
      password: '{{KUMA_PASSWORD}}'
    resources:
    - name: resource
      path: /
      operations:
      - name: index
        method: GET
        description: The index endpoint
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: resources
      path: /_resources
      operations:
      - name: get-resource-type-description
        method: GET
        description: A list of all resources that exist
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: global-insight
      path: /global-insight
      operations:
      - name: get-global-insight
        method: GET
        description: Get Global Insight
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-resourcetype-resourcename-rules
      path: /meshes/{mesh}/{resourceType}/{resourceName}/_rules
      operations:
      - name: inspect-dataplanes-rules
        method: GET
        description: Returns rules matching this dataplane
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: The mesh the policy is part of
        - name: resourceType
          in: path
          type: string
          required: true
          description: The type of resource (only some resources support rules api)
        - name: resourceName
          in: path
          type: string
          required: true
          description: The name of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-dataplanes-name-config
      path: /meshes/{mesh}/dataplanes/{name}/_config
      operations:
      - name: get-dataplanes-xds-config
        method: GET
        description: Get a proxy XDS config on a CP, this endpoint is only available on zone CPs.
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: The mesh of the DPP to get the diff for.
        - name: name
          in: path
          type: string
          required: true
          description: The name of the DPP within the mesh to get the diff for.
        - name: shadow
          in: query
          type: boolean
          description: 'When computing XDS config the CP take into account policies with ''kuma.io/effect: shadow'' label'
        - name: include
          in: query
          type: array
          description: An array of extra fields to include in the response. When `include=diff` the server computes a diff
            in JSONPatch format between the current proxy XDS config and
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-dataplanes-name-layout
      path: /meshes/{mesh}/dataplanes/{name}/_layout
      operations:
      - name: get-dataplanes-layout
        method: GET
        description: Get networking layout for this dataplane
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: The mesh of the DPP to get the layout for.
        - name: name
          in: path
          type: string
          required: true
          description: The name of the DPP within the mesh to get the layout for.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-dataplanes-name-policies
      path: /meshes/{mesh}/dataplanes/{name}/_policies
      operations:
      - name: get-proxy-policy-conf
        method: GET
        description: Get proxy policies for this dataplane
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: The mesh of the DPP to get the diff for.
        - name: name
          in: path
          type: string
          required: true
          description: The name of the DPP within the mesh to get the diff for.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-dataplanes-name-inbounds-inbound-kri
      path: /meshes/{mesh}/dataplanes/{name}/_inbounds/{inbound-kri}/_policies
      operations:
      - name: get-inbound-policy-conf
        method: GET
        description: Get policies for this inbound
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: The mesh of the DPP to get the policies for.
        - name: name
          in: path
          type: string
          required: true
          description: The name of the DPP within the mesh to get the policies for.
        - name: inbound-kri
          in: path
          type: string
          required: true
          description: The name of the Inbound from DPP to get the policies for.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-dataplanes-name-outbounds-kri-polici
      path: /meshes/{mesh}/dataplanes/{name}/_outbounds/{kri}/_policies
      operations:
      - name: get-outbound-policy-conf
        method: GET
        description: Get policies for this outbound
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: The mesh of the DPP to get the policies for.
        - name: name
          in: path
          type: string
          required: true
          description: The name of the DPP within the mesh to get the policies for.
        - name: kri
          in: path
          type: string
          required: true
          description: The KRI of the Outbound to get the policies for.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-dataplanes-name-outbounds-kri-routes
      path: /meshes/{mesh}/dataplanes/{name}/_outbounds/{kri}/_routes
      operations:
      - name: get-outbound-routes
        method: GET
        description: Get routes configuration for this outbound
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: The mesh of the DPP to get the policies for.
        - name: name
          in: path
          type: string
          required: true
          description: The name of the DPP within the mesh to get the policies for.
        - name: kri
          in: path
          type: string
          required: true
          description: The KRI of the Outbound to get the routes for.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-dataplanes-name-outbounds-outbound-k
      path: /meshes/{mesh}/dataplanes/{name}/_outbounds/{outbound-kri}/_routes/{route-kri}/_policies
      operations:
      - name: get-route-policy-conf
        method: GET
        description: Get policies for this route
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: The mesh of the DPP to get the policies for.
        - name: name
          in: path
          type: string
          required: true
          description: The name of the DPP within the mesh to get the policies for.
        - name: outbound-kri
          in: path
          type: string
          required: true
          description: The KRI of the Outbound to get the routes for.
        - name: route-kri
          in: path
          type: string
          required: true
          description: The KRI of the Route to get the configuration for.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-policytype-policyname-resources-data
      path: /meshes/{mesh}/{policyType}/{policyName}/_resources/dataplanes
      operations:
      - name: inspect-resources
        method: GET
        description: Returns resources matched by this policy
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: The mesh the policy is part of
        - name: policyType
          in: path
          type: string
          required: true
          description: The type of the policy
        - name: policyName
          in: path
          type: string
          required: true
          description: The type of the policy
        - name: size
          in: query
          type: integer
          description: The max number of items to return
        - name: offset
          in: query
          type: integer
          description: The offset of result
        - name: name
          in: query
          type: string
          description: A sub string to filter resources by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshservices-name-dataplanes
      path: /meshes/{mesh}/meshservices/{name}/_dataplanes
      operations:
      - name: inspect-meshservices-dataplanes
        method: GET
        description: Returns dataplanes matched by a MeshService
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: The mesh the service is part of
        - name: name
          in: path
          type: string
          required: true
          description: The name of the service
        - name: size
          in: query
          type: integer
          description: The max number of items to return
        - name: offset
          in: query
          type: integer
          description: The offset of result
        - name: name
          in: query
          type: string
          description: A sub string to filter resources by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-servicetype-servicename-hostnames
      path: /meshes/{mesh}/{serviceType}/{serviceName}/_hostnames
      operations:
      - name: inspect-hostnames
        method: GET
        description: Returns hostnames for service
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: The mesh the service is part of
        - name: serviceType
          in: path
          type: string
          required: true
          description: The type of the service
        - name: serviceName
          in: path
          type: string
          required: true
          description: The name of the service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: kri-kri
      path: /_kri/{kri}
      operations:
      - name: getbykri
        method: GET
        description: Returns a resource by KRI
        inputParameters:
        - name: kri
          in: path
          type: string
          required: true
          description: KRI of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshaccesslogs-name
      path: /meshes/{mesh}/meshaccesslogs/{name}
      operations:
      - name: getmeshaccesslog
        method: GET
        description: Returns MeshAccessLog entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshAccessLog
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putmeshaccesslog
        method: PUT
        description: Creates or Updates MeshAccessLog entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshAccessLog
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletemeshaccesslog
        method: DELETE
        description: Deletes MeshAccessLog entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshAccessLog
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshaccesslogs
      path: /meshes/{mesh}/meshaccesslogs
      operations:
      - name: getmeshaccessloglist
        method: GET
        description: Returns a list of MeshAccessLog in the mesh.
        inputParameters:
        - name: offset
          in: query
          type: integer
          description: offset in the list of entities
        - name: size
          in: query
          type: integer
          description: the number of items per page
        - name: filter
          in: query
          type: object
          description: filter by labels when multiple filters are present, they are ANDed
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshcircuitbreakers-name
      path: /meshes/{mesh}/meshcircuitbreakers/{name}
      operations:
      - name: getmeshcircuitbreaker
        method: GET
        description: Returns MeshCircuitBreaker entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshCircuitBreaker
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putmeshcircuitbreaker
        method: PUT
        description: Creates or Updates MeshCircuitBreaker entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshCircuitBreaker
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletemeshcircuitbreaker
        method: DELETE
        description: Deletes MeshCircuitBreaker entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshCircuitBreaker
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshcircuitbreakers
      path: /meshes/{mesh}/meshcircuitbreakers
      operations:
      - name: getmeshcircuitbreakerlist
        method: GET
        description: Returns a list of MeshCircuitBreaker in the mesh.
        inputParameters:
        - name: offset
          in: query
          type: integer
          description: offset in the list of entities
        - name: size
          in: query
          type: integer
          description: the number of items per page
        - name: filter
          in: query
          type: object
          description: filter by labels when multiple filters are present, they are ANDed
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshfaultinjections-name
      path: /meshes/{mesh}/meshfaultinjections/{name}
      operations:
      - name: getmeshfaultinjection
        method: GET
        description: Returns MeshFaultInjection entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshFaultInjection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putmeshfaultinjection
        method: PUT
        description: Creates or Updates MeshFaultInjection entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshFaultInjection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletemeshfaultinjection
        method: DELETE
        description: Deletes MeshFaultInjection entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshFaultInjection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshfaultinjections
      path: /meshes/{mesh}/meshfaultinjections
      operations:
      - name: getmeshfaultinjectionlist
        method: GET
        description: Returns a list of MeshFaultInjection in the mesh.
        inputParameters:
        - name: offset
          in: query
          type: integer
          description: offset in the list of entities
        - name: size
          in: query
          type: integer
          description: the number of items per page
        - name: filter
          in: query
          type: object
          description: filter by labels when multiple filters are present, they are ANDed
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshhealthchecks-name
      path: /meshes/{mesh}/meshhealthchecks/{name}
      operations:
      - name: getmeshhealthcheck
        method: GET
        description: Returns MeshHealthCheck entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshHealthCheck
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putmeshhealthcheck
        method: PUT
        description: Creates or Updates MeshHealthCheck entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshHealthCheck
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletemeshhealthcheck
        method: DELETE
        description: Deletes MeshHealthCheck entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshHealthCheck
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshhealthchecks
      path: /meshes/{mesh}/meshhealthchecks
      operations:
      - name: getmeshhealthchecklist
        method: GET
        description: Returns a list of MeshHealthCheck in the mesh.
        inputParameters:
        - name: offset
          in: query
          type: integer
          description: offset in the list of entities
        - name: size
          in: query
          type: integer
          description: the number of items per page
        - name: filter
          in: query
          type: object
          description: filter by labels when multiple filters are present, they are ANDed
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshhttproutes-name
      path: /meshes/{mesh}/meshhttproutes/{name}
      operations:
      - name: getmeshhttproute
        method: GET
        description: Returns MeshHTTPRoute entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshHTTPRoute
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putmeshhttproute
        method: PUT
        description: Creates or Updates MeshHTTPRoute entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshHTTPRoute
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletemeshhttproute
        method: DELETE
        description: Deletes MeshHTTPRoute entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshHTTPRoute
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshhttproutes
      path: /meshes/{mesh}/meshhttproutes
      operations:
      - name: getmeshhttproutelist
        method: GET
        description: Returns a list of MeshHTTPRoute in the mesh.
        inputParameters:
        - name: offset
          in: query
          type: integer
          description: offset in the list of entities
        - name: size
          in: query
          type: integer
          description: the number of items per page
        - name: filter
          in: query
          type: object
          description: filter by labels when multiple filters are present, they are ANDed
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshloadbalancingstrategies-name
      path: /meshes/{mesh}/meshloadbalancingstrategies/{name}
      operations:
      - name: getmeshloadbalancingstrategy
        method: GET
        description: Returns MeshLoadBalancingStrategy entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshLoadBalancingStrategy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putmeshloadbalancingstrategy
        method: PUT
        description: Creates or Updates MeshLoadBalancingStrategy entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshLoadBalancingStrategy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletemeshloadbalancingstrategy
        method: DELETE
        description: Deletes MeshLoadBalancingStrategy entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshLoadBalancingStrategy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshloadbalancingstrategies
      path: /meshes/{mesh}/meshloadbalancingstrategies
      operations:
      - name: getmeshloadbalancingstrategylist
        method: GET
        description: Returns a list of MeshLoadBalancingStrategy in the mesh.
        inputParameters:
        - name: offset
          in: query
          type: integer
          description: offset in the list of entities
        - name: size
          in: query
          type: integer
          description: the number of items per page
        - name: filter
          in: query
          type: object
          description: filter by labels when multiple filters are present, they are ANDed
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshmetrics-name
      path: /meshes/{mesh}/meshmetrics/{name}
      operations:
      - name: getmeshmetric
        method: GET
        description: Returns MeshMetric entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshMetric
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putmeshmetric
        method: PUT
        description: Creates or Updates MeshMetric entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshMetric
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletemeshmetric
        method: DELETE
        description: Deletes MeshMetric entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshMetric
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshmetrics
      path: /meshes/{mesh}/meshmetrics
      operations:
      - name: getmeshmetriclist
        method: GET
        description: Returns a list of MeshMetric in the mesh.
        inputParameters:
        - name: offset
          in: query
          type: integer
          description: offset in the list of entities
        - name: size
          in: query
          type: integer
          description: the number of items per page
        - name: filter
          in: query
          type: object
          description: filter by labels when multiple filters are present, they are ANDed
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshpassthroughs-name
      path: /meshes/{mesh}/meshpassthroughs/{name}
      operations:
      - name: getmeshpassthrough
        method: GET
        description: Returns MeshPassthrough entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshPassthrough
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putmeshpassthrough
        method: PUT
        description: Creates or Updates MeshPassthrough entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshPassthrough
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletemeshpassthrough
        method: DELETE
        description: Deletes MeshPassthrough entity
        inputParameters:
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        - name: name
          in: path
          type: string
          required: true
          description: name of the MeshPassthrough
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: meshes-mesh-meshpassthroughs
      path: /meshes/{mesh}/meshpassthroughs
      operations:
      - name: getmeshpassthroughlist
        method: GET
        description: Returns a list of MeshPassthrough in the mesh.
        inputParameters:
        - name: offset
          in: query
          type: integer
          description: offset in the list of entities
        - name: size
          in: query
          type: integer
          description: the number of items per page
        - name: filter
          in: query
          type: object
          description: filter by labels when multiple filters are present, they are ANDed
        - name: mesh
          in: path
          type: string
          required: true
          description: name of the mesh
        outputRawFormat: json
        outputParameters:
        - nam

# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kuma/refs/heads/main/capabilities/kuma-capability.yaml