{
  "opencollection": "1.0.0",
  "info": {
    "name": "Kuma Dataplane Meshes API",
    "version": "v1alpha1"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Meshes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a proxy XDS config on a CP, this endpoint is only available on zone CPs.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meshes/:mesh/dataplanes/:name/_config",
            "params": [
              {
                "name": "mesh",
                "value": "",
                "type": "path",
                "description": "The mesh of the DPP to get the diff for."
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The name of the DPP within the mesh to get the diff for."
              },
              {
                "name": "shadow",
                "value": "",
                "type": "query",
                "description": "When computing XDS config the CP take into account policies with 'kuma.io/effect: shadow' label\n"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "An array of extra fields to include in the response. When `include=diff` the server computes a diff in JSONPatch format\nbetween the current proxy XDS config and the config returned in the 'xds' field.\n"
              }
            ]
          },
          "docs": "Returns the [xds](https://www.envoyproxy.io/docs/envoy/latest/api-docs/xds_protocol) configuration of the proxy."
        },
        {
          "info": {
            "name": "Get networking layout for this dataplane",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meshes/:mesh/dataplanes/:name/_layout",
            "params": [
              {
                "name": "mesh",
                "value": "",
                "type": "path",
                "description": "The mesh of the DPP to get the layout for."
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The name of the DPP within the mesh to get the layout for."
              }
            ]
          },
          "docs": "Returns detailed dataplane networking layout with most important information on dataplane and list of its inbounds and outbounds"
        },
        {
          "info": {
            "name": "Get proxy policies for this dataplane",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meshes/:mesh/dataplanes/:name/_policies",
            "params": [
              {
                "name": "mesh",
                "value": "",
                "type": "path",
                "description": "The mesh of the DPP to get the diff for."
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The name of the DPP within the mesh to get the diff for."
              }
            ]
          },
          "docs": "Returns proxy level policy configuration derived from combining all proxy policies selecting this dataplane"
        },
        {
          "info": {
            "name": "Get policies for this inbound",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meshes/:mesh/dataplanes/:name/_inbounds/:inbound-kri/_policies",
            "params": [
              {
                "name": "mesh",
                "value": "",
                "type": "path",
                "description": "The mesh of the DPP to get the policies for."
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The name of the DPP within the mesh to get the policies for."
              },
              {
                "name": "inbound-kri",
                "value": "",
                "type": "path",
                "description": "The name of the Inbound from DPP to get the policies for."
              }
            ]
          },
          "docs": "Returns inbound policy configuration derived from combining all policies selecting this dataplane"
        },
        {
          "info": {
            "name": "Get policies for this outbound",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meshes/:mesh/dataplanes/:name/_outbounds/:kri/_policies",
            "params": [
              {
                "name": "mesh",
                "value": "",
                "type": "path",
                "description": "The mesh of the DPP to get the policies for."
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The name of the DPP within the mesh to get the policies for."
              },
              {
                "name": "kri",
                "value": "",
                "type": "path",
                "description": "The KRI of the Outbound to get the policies for."
              }
            ]
          },
          "docs": "Returns outbound policy configuration derived from combining all policies selecting this dataplane"
        },
        {
          "info": {
            "name": "Get routes configuration for this outbound",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meshes/:mesh/dataplanes/:name/_outbounds/:kri/_routes",
            "params": [
              {
                "name": "mesh",
                "value": "",
                "type": "path",
                "description": "The mesh of the DPP to get the policies for."
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The name of the DPP within the mesh to get the policies for."
              },
              {
                "name": "kri",
                "value": "",
                "type": "path",
                "description": "The KRI of the Outbound to get the routes for."
              }
            ]
          },
          "docs": "Returns routes configuration derived from combining all routes on this outbound"
        },
        {
          "info": {
            "name": "Get policies for this route",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meshes/:mesh/dataplanes/:name/_outbounds/:outbound-kri/_routes/:route-kri/_policies",
            "params": [
              {
                "name": "mesh",
                "value": "",
                "type": "path",
                "description": "The mesh of the DPP to get the policies for."
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The name of the DPP within the mesh to get the policies for."
              },
              {
                "name": "outbound-kri",
                "value": "",
                "type": "path",
                "description": "The KRI of the Outbound to get the routes for."
              },
              {
                "name": "route-kri",
                "value": "",
                "type": "path",
                "description": "The KRI of the Route to get the configuration for."
              }
            ]
          },
          "docs": "Returns route policy configuration derived from combining all policies selecting this dataplane"
        },
        {
          "info": {
            "name": "getDataplaneOverview",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meshes/:mesh/dataplanes/:name/_overview",
            "params": [
              {
                "name": "mesh",
                "value": "",
                "type": "path",
                "description": "The mesh of the DPP to get the diff for."
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The name of the DPP within the mesh to get the diff for."
              }
            ]
          }
        },
        {
          "info": {
            "name": "getDataplaneOverviewList",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meshes/:mesh/dataplanes/_overview",
            "params": [
              {
                "name": "mesh",
                "value": "",
                "type": "path",
                "description": "The mesh of the DPP to get the diff for."
              }
            ]
          }
        }
      ]
    }
  ],
  "bundled": true
}