{ "opencollection": "1.0.0", "info": { "name": "Kuma API", "version": "v1alpha1" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "System", "type": "folder" }, "items": [ { "info": { "name": "The index endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/" }, "docs": "The index endpoint, some common metadata" }, { "info": { "name": "A list of all resources that exist", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/_resources" }, "docs": "Returns a Global Insight object" } ] }, { "info": { "name": "GlobalInsight", "type": "folder" }, "items": [ { "info": { "name": "Get Global Insight", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/global-insight" }, "docs": "Returns a Global Insight object" } ] }, { "info": { "name": "Inspect", "type": "folder" }, "items": [ { "info": { "name": "Returns rules matching this dataplane", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/:resourceType/:resourceName/_rules", "params": [ { "name": "mesh", "value": "default", "type": "path", "description": "The mesh the policy is part of" }, { "name": "resourceType", "value": "dataplanes", "type": "path", "description": "The type of resource (only some resources support rules api)" }, { "name": "resourceName", "value": "my-dp", "type": "path", "description": "The name of the resource" } ] }, "docs": "Returns rules matching this dataplane" }, { "info": { "name": "Returns resources matched by this policy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/:policyType/:policyName/_resources/dataplanes", "params": [ { "name": "mesh", "value": "default", "type": "path", "description": "The mesh the policy is part of" }, { "name": "policyType", "value": "meshretries", "type": "path", "description": "The type of the policy" }, { "name": "policyName", "value": "retry-all", "type": "path", "description": "The type of the policy" }, { "name": "size", "value": "", "type": "query", "description": "The max number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of result" }, { "name": "name", "value": "", "type": "query", "description": "A sub string to filter resources by name" } ] }, "docs": "Returns resources matched by this policy. In the case of `targetRef` policies we'll match using the top level `targetRef`" }, { "info": { "name": "Returns dataplanes matched by a MeshService", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshservices/:name/_dataplanes", "params": [ { "name": "mesh", "value": "default", "type": "path", "description": "The mesh the service is part of" }, { "name": "name", "value": "redis", "type": "path", "description": "The name of the service" }, { "name": "size", "value": "", "type": "query", "description": "The max number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of result" }, { "name": "name", "value": "", "type": "query", "description": "A sub string to filter resources by name" } ] }, "docs": "Returns dataplanes matched by a MeshService" }, { "info": { "name": "Returns hostnames for service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/:serviceType/:serviceName/_hostnames", "params": [ { "name": "mesh", "value": "default", "type": "path", "description": "The mesh the service is part of" }, { "name": "serviceType", "value": "meshservices", "type": "path", "description": "The type of the service" }, { "name": "serviceName", "value": "redis", "type": "path", "description": "The name of the service" } ] }, "docs": "Returns hostnames for a service" } ] }, { "info": { "name": "Default", "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." } ] } } ] }, { "info": { "name": "KRI", "type": "folder" }, "items": [ { "info": { "name": "Returns a resource by KRI", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/_kri/:kri", "params": [ { "name": "kri", "value": "", "type": "path", "description": "KRI of the resource" } ] }, "docs": "Returns a resource by KRI" } ] }, { "info": { "name": "MeshAccessLog", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshAccessLog entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshaccesslogs/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshAccessLog" } ] }, "docs": "Returns MeshAccessLog entity" }, { "info": { "name": "Creates or Updates MeshAccessLog entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshaccesslogs/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshAccessLog" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshAccessLog entity" }, { "info": { "name": "Deletes MeshAccessLog entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshaccesslogs/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshAccessLog" } ] }, "docs": "Deletes MeshAccessLog entity" }, { "info": { "name": "Returns a list of MeshAccessLog in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshaccesslogs", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshAccessLog in the mesh." } ] }, { "info": { "name": "MeshCircuitBreaker", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshCircuitBreaker entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshcircuitbreakers/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshCircuitBreaker" } ] }, "docs": "Returns MeshCircuitBreaker entity" }, { "info": { "name": "Creates or Updates MeshCircuitBreaker entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshcircuitbreakers/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshCircuitBreaker" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshCircuitBreaker entity" }, { "info": { "name": "Deletes MeshCircuitBreaker entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshcircuitbreakers/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshCircuitBreaker" } ] }, "docs": "Deletes MeshCircuitBreaker entity" }, { "info": { "name": "Returns a list of MeshCircuitBreaker in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshcircuitbreakers", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshCircuitBreaker in the mesh." } ] }, { "info": { "name": "MeshFaultInjection", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshFaultInjection entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshfaultinjections/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshFaultInjection" } ] }, "docs": "Returns MeshFaultInjection entity" }, { "info": { "name": "Creates or Updates MeshFaultInjection entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshfaultinjections/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshFaultInjection" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshFaultInjection entity" }, { "info": { "name": "Deletes MeshFaultInjection entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshfaultinjections/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshFaultInjection" } ] }, "docs": "Deletes MeshFaultInjection entity" }, { "info": { "name": "Returns a list of MeshFaultInjection in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshfaultinjections", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshFaultInjection in the mesh." } ] }, { "info": { "name": "MeshHealthCheck", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshHealthCheck entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshhealthchecks/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshHealthCheck" } ] }, "docs": "Returns MeshHealthCheck entity" }, { "info": { "name": "Creates or Updates MeshHealthCheck entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshhealthchecks/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshHealthCheck" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshHealthCheck entity" }, { "info": { "name": "Deletes MeshHealthCheck entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshhealthchecks/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshHealthCheck" } ] }, "docs": "Deletes MeshHealthCheck entity" }, { "info": { "name": "Returns a list of MeshHealthCheck in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshhealthchecks", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshHealthCheck in the mesh." } ] }, { "info": { "name": "MeshHTTPRoute", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshHTTPRoute entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshhttproutes/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshHTTPRoute" } ] }, "docs": "Returns MeshHTTPRoute entity" }, { "info": { "name": "Creates or Updates MeshHTTPRoute entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshhttproutes/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshHTTPRoute" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshHTTPRoute entity" }, { "info": { "name": "Deletes MeshHTTPRoute entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshhttproutes/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshHTTPRoute" } ] }, "docs": "Deletes MeshHTTPRoute entity" }, { "info": { "name": "Returns a list of MeshHTTPRoute in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshhttproutes", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshHTTPRoute in the mesh." } ] }, { "info": { "name": "MeshLoadBalancingStrategy", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshLoadBalancingStrategy entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshloadbalancingstrategies/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshLoadBalancingStrategy" } ] }, "docs": "Returns MeshLoadBalancingStrategy entity" }, { "info": { "name": "Creates or Updates MeshLoadBalancingStrategy entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshloadbalancingstrategies/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshLoadBalancingStrategy" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshLoadBalancingStrategy entity" }, { "info": { "name": "Deletes MeshLoadBalancingStrategy entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshloadbalancingstrategies/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshLoadBalancingStrategy" } ] }, "docs": "Deletes MeshLoadBalancingStrategy entity" }, { "info": { "name": "Returns a list of MeshLoadBalancingStrategy in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshloadbalancingstrategies", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshLoadBalancingStrategy in the mesh." } ] }, { "info": { "name": "MeshMetric", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshMetric entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshmetrics/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshMetric" } ] }, "docs": "Returns MeshMetric entity" }, { "info": { "name": "Creates or Updates MeshMetric entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshmetrics/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshMetric" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshMetric entity" }, { "info": { "name": "Deletes MeshMetric entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshmetrics/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshMetric" } ] }, "docs": "Deletes MeshMetric entity" }, { "info": { "name": "Returns a list of MeshMetric in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshmetrics", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshMetric in the mesh." } ] }, { "info": { "name": "MeshPassthrough", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshPassthrough entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshpassthroughs/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshPassthrough" } ] }, "docs": "Returns MeshPassthrough entity" }, { "info": { "name": "Creates or Updates MeshPassthrough entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshpassthroughs/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshPassthrough" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshPassthrough entity" }, { "info": { "name": "Deletes MeshPassthrough entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshpassthroughs/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshPassthrough" } ] }, "docs": "Deletes MeshPassthrough entity" }, { "info": { "name": "Returns a list of MeshPassthrough in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshpassthroughs", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshPassthrough in the mesh." } ] }, { "info": { "name": "MeshProxyPatch", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshProxyPatch entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshproxypatches/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshProxyPatch" } ] }, "docs": "Returns MeshProxyPatch entity" }, { "info": { "name": "Creates or Updates MeshProxyPatch entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshproxypatches/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshProxyPatch" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshProxyPatch entity" }, { "info": { "name": "Deletes MeshProxyPatch entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshproxypatches/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshProxyPatch" } ] }, "docs": "Deletes MeshProxyPatch entity" }, { "info": { "name": "Returns a list of MeshProxyPatch in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshproxypatches", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshProxyPatch in the mesh." } ] }, { "info": { "name": "MeshRateLimit", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshRateLimit entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshratelimits/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshRateLimit" } ] }, "docs": "Returns MeshRateLimit entity" }, { "info": { "name": "Creates or Updates MeshRateLimit entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshratelimits/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshRateLimit" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshRateLimit entity" }, { "info": { "name": "Deletes MeshRateLimit entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshratelimits/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshRateLimit" } ] }, "docs": "Deletes MeshRateLimit entity" }, { "info": { "name": "Returns a list of MeshRateLimit in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshratelimits", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshRateLimit in the mesh." } ] }, { "info": { "name": "MeshRetry", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshRetry entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshretries/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshRetry" } ] }, "docs": "Returns MeshRetry entity" }, { "info": { "name": "Creates or Updates MeshRetry entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshretries/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshRetry" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshRetry entity" }, { "info": { "name": "Deletes MeshRetry entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshretries/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshRetry" } ] }, "docs": "Deletes MeshRetry entity" }, { "info": { "name": "Returns a list of MeshRetry in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshretries", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshRetry in the mesh." } ] }, { "info": { "name": "MeshTCPRoute", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshTCPRoute entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshtcproutes/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTCPRoute" } ] }, "docs": "Returns MeshTCPRoute entity" }, { "info": { "name": "Creates or Updates MeshTCPRoute entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshtcproutes/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTCPRoute" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshTCPRoute entity" }, { "info": { "name": "Deletes MeshTCPRoute entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshtcproutes/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTCPRoute" } ] }, "docs": "Deletes MeshTCPRoute entity" }, { "info": { "name": "Returns a list of MeshTCPRoute in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshtcproutes", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshTCPRoute in the mesh." } ] }, { "info": { "name": "MeshTimeout", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshTimeout entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshtimeouts/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTimeout" } ] }, "docs": "Returns MeshTimeout entity" }, { "info": { "name": "Creates or Updates MeshTimeout entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshtimeouts/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTimeout" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshTimeout entity" }, { "info": { "name": "Deletes MeshTimeout entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshtimeouts/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTimeout" } ] }, "docs": "Deletes MeshTimeout entity" }, { "info": { "name": "Returns a list of MeshTimeout in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshtimeouts", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshTimeout in the mesh." } ] }, { "info": { "name": "MeshTLS", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshTLS entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshtlses/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTLS" } ] }, "docs": "Returns MeshTLS entity" }, { "info": { "name": "Creates or Updates MeshTLS entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshtlses/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTLS" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshTLS entity" }, { "info": { "name": "Deletes MeshTLS entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshtlses/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTLS" } ] }, "docs": "Deletes MeshTLS entity" }, { "info": { "name": "Returns a list of MeshTLS in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshtlses", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshTLS in the mesh." } ] }, { "info": { "name": "MeshTrace", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshTrace entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshtraces/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTrace" } ] }, "docs": "Returns MeshTrace entity" }, { "info": { "name": "Creates or Updates MeshTrace entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshtraces/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTrace" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshTrace entity" }, { "info": { "name": "Deletes MeshTrace entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshtraces/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTrace" } ] }, "docs": "Deletes MeshTrace entity" }, { "info": { "name": "Returns a list of MeshTrace in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshtraces", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshTrace in the mesh." } ] }, { "info": { "name": "MeshTrafficPermission", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshTrafficPermission entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshtrafficpermissions/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTrafficPermission" } ] }, "docs": "Returns MeshTrafficPermission entity" }, { "info": { "name": "Creates or Updates MeshTrafficPermission entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshtrafficpermissions/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTrafficPermission" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshTrafficPermission entity" }, { "info": { "name": "Deletes MeshTrafficPermission entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshtrafficpermissions/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTrafficPermission" } ] }, "docs": "Deletes MeshTrafficPermission entity" }, { "info": { "name": "Returns a list of MeshTrafficPermission in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshtrafficpermissions", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshTrafficPermission in the mesh." } ] }, { "info": { "name": "Dataplane", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of Dataplane in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/dataplanes", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of Dataplane in the mesh." }, { "info": { "name": "Returns Dataplane entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/dataplanes/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the Dataplane" } ] }, "docs": "Returns Dataplane entity" }, { "info": { "name": "Creates or Updates Dataplane entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/dataplanes/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the Dataplane" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates Dataplane entity" }, { "info": { "name": "Deletes Dataplane entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/dataplanes/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the Dataplane" } ] }, "docs": "Deletes Dataplane entity" } ] }, { "info": { "name": "Mesh", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of Mesh in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" } ] }, "docs": "Returns a list of Mesh in the mesh." }, { "info": { "name": "Returns Mesh entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name of the Mesh" } ] }, "docs": "Returns Mesh entity" }, { "info": { "name": "Creates or Updates Mesh entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name of the Mesh" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates Mesh entity" }, { "info": { "name": "Deletes Mesh entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name of the Mesh" } ] }, "docs": "Deletes Mesh entity" } ] }, { "info": { "name": "MeshGateway", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of MeshGateway in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshgateways", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshGateway in the mesh." }, { "info": { "name": "Returns MeshGateway entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshgateways/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshGateway" } ] }, "docs": "Returns MeshGateway entity" }, { "info": { "name": "Creates or Updates MeshGateway entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshgateways/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshGateway" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshGateway entity" }, { "info": { "name": "Deletes MeshGateway entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshgateways/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshGateway" } ] }, "docs": "Deletes MeshGateway entity" } ] }, { "info": { "name": "Secret", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of Secret in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/secrets", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of Secret in the mesh." }, { "info": { "name": "Returns Secret entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/secrets/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the Secret" } ] }, "docs": "Returns Secret entity" }, { "info": { "name": "Creates or Updates Secret entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/secrets/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the Secret" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates Secret entity" }, { "info": { "name": "Deletes Secret entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/secrets/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the Secret" } ] }, "docs": "Deletes Secret entity" } ] }, { "info": { "name": "ZoneEgress", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of ZoneEgress in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/zoneegresses", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" } ] }, "docs": "Returns a list of ZoneEgress in the mesh." }, { "info": { "name": "Returns ZoneEgress entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/zoneegresses/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name of the ZoneEgress" } ] }, "docs": "Returns ZoneEgress entity" }, { "info": { "name": "Creates or Updates ZoneEgress entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/zoneegresses/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name of the ZoneEgress" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates ZoneEgress entity" }, { "info": { "name": "Deletes ZoneEgress entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/zoneegresses/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name of the ZoneEgress" } ] }, "docs": "Deletes ZoneEgress entity" } ] }, { "info": { "name": "ZoneIngress", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of ZoneIngress in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/zoneingresses", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" } ] }, "docs": "Returns a list of ZoneIngress in the mesh." }, { "info": { "name": "Returns ZoneIngress entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/zoneingresses/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name of the ZoneIngress" } ] }, "docs": "Returns ZoneIngress entity" }, { "info": { "name": "Creates or Updates ZoneIngress entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/zoneingresses/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name of the ZoneIngress" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates ZoneIngress entity" }, { "info": { "name": "Deletes ZoneIngress entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/zoneingresses/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name of the ZoneIngress" } ] }, "docs": "Deletes ZoneIngress entity" } ] }, { "info": { "name": "HostnameGenerator", "type": "folder" }, "items": [ { "info": { "name": "Returns HostnameGenerator entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hostnamegenerators/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name of the HostnameGenerator" } ] }, "docs": "Returns HostnameGenerator entity" }, { "info": { "name": "Creates or Updates HostnameGenerator entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hostnamegenerators/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name of the HostnameGenerator" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates HostnameGenerator entity" }, { "info": { "name": "Deletes HostnameGenerator entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hostnamegenerators/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "name of the HostnameGenerator" } ] }, "docs": "Deletes HostnameGenerator entity" }, { "info": { "name": "Returns a list of HostnameGenerator in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hostnamegenerators", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" } ] }, "docs": "Returns a list of HostnameGenerator in the mesh." } ] }, { "info": { "name": "MeshExternalService", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshExternalService entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshexternalservices/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshExternalService" } ] }, "docs": "Returns MeshExternalService entity" }, { "info": { "name": "Creates or Updates MeshExternalService entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshexternalservices/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshExternalService" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshExternalService entity" }, { "info": { "name": "Deletes MeshExternalService entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshexternalservices/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshExternalService" } ] }, "docs": "Deletes MeshExternalService entity" }, { "info": { "name": "Returns a list of MeshExternalService in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshexternalservices", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshExternalService in the mesh." } ] }, { "info": { "name": "MeshIdentity", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshIdentity entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshidentities/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshIdentity" } ] }, "docs": "Returns MeshIdentity entity" }, { "info": { "name": "Creates or Updates MeshIdentity entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshidentities/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshIdentity" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshIdentity entity" }, { "info": { "name": "Deletes MeshIdentity entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshidentities/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshIdentity" } ] }, "docs": "Deletes MeshIdentity entity" }, { "info": { "name": "Returns a list of MeshIdentity in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshidentities", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshIdentity in the mesh." } ] }, { "info": { "name": "MeshMultiZoneService", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshMultiZoneService entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshmultizoneservices/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshMultiZoneService" } ] }, "docs": "Returns MeshMultiZoneService entity" }, { "info": { "name": "Creates or Updates MeshMultiZoneService entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshmultizoneservices/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshMultiZoneService" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshMultiZoneService entity" }, { "info": { "name": "Deletes MeshMultiZoneService entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshmultizoneservices/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshMultiZoneService" } ] }, "docs": "Deletes MeshMultiZoneService entity" }, { "info": { "name": "Returns a list of MeshMultiZoneService in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshmultizoneservices", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshMultiZoneService in the mesh." } ] }, { "info": { "name": "MeshOpenTelemetryBackend", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshOpenTelemetryBackend entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshopentelemetrybackends/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshOpenTelemetryBackend" } ] }, "docs": "Returns MeshOpenTelemetryBackend entity" }, { "info": { "name": "Creates or Updates MeshOpenTelemetryBackend entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshopentelemetrybackends/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshOpenTelemetryBackend" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshOpenTelemetryBackend entity" }, { "info": { "name": "Deletes MeshOpenTelemetryBackend entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshopentelemetrybackends/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshOpenTelemetryBackend" } ] }, "docs": "Deletes MeshOpenTelemetryBackend entity" }, { "info": { "name": "Returns a list of MeshOpenTelemetryBackend in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshopentelemetrybackends", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshOpenTelemetryBackend in the mesh." } ] }, { "info": { "name": "MeshService", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshService entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshservices/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshService" } ] }, "docs": "Returns MeshService entity" }, { "info": { "name": "Creates or Updates MeshService entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshservices/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshService" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshService entity" }, { "info": { "name": "Deletes MeshService entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshservices/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshService" } ] }, "docs": "Deletes MeshService entity" }, { "info": { "name": "Returns a list of MeshService in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshservices", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshService in the mesh." } ] }, { "info": { "name": "MeshTrust", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshTrust entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshtrusts/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTrust" } ] }, "docs": "Returns MeshTrust entity" }, { "info": { "name": "Creates or Updates MeshTrust entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshtrusts/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTrust" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshTrust entity" }, { "info": { "name": "Deletes MeshTrust entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshtrusts/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshTrust" } ] }, "docs": "Deletes MeshTrust entity" }, { "info": { "name": "Returns a list of MeshTrust in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshtrusts", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshTrust in the mesh." } ] }, { "info": { "name": "MeshZoneAddress", "type": "folder" }, "items": [ { "info": { "name": "Returns MeshZoneAddress entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshzoneaddresses/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshZoneAddress" } ] }, "docs": "Returns MeshZoneAddress entity" }, { "info": { "name": "Creates or Updates MeshZoneAddress entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/meshzoneaddresses/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshZoneAddress" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates MeshZoneAddress entity" }, { "info": { "name": "Deletes MeshZoneAddress entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/meshzoneaddresses/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the MeshZoneAddress" } ] }, "docs": "Deletes MeshZoneAddress entity" }, { "info": { "name": "Returns a list of MeshZoneAddress in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/meshzoneaddresses", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of MeshZoneAddress in the mesh." } ] }, { "info": { "name": "Workload", "type": "folder" }, "items": [ { "info": { "name": "Returns Workload entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/workloads/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the Workload" } ] }, "docs": "Returns Workload entity" }, { "info": { "name": "Creates or Updates Workload entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meshes/:mesh/workloads/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the Workload" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or Updates Workload entity" }, { "info": { "name": "Deletes Workload entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meshes/:mesh/workloads/:name", "params": [ { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" }, { "name": "name", "value": "", "type": "path", "description": "name of the Workload" } ] }, "docs": "Deletes Workload entity" }, { "info": { "name": "Returns a list of Workload in the mesh.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meshes/:mesh/workloads", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "offset in the list of entities" }, { "name": "size", "value": "", "type": "query", "description": "the number of items per page" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "filter by labels when multiple filters are present, they are ANDed" }, { "name": "mesh", "value": "", "type": "path", "description": "name of the mesh" } ] }, "docs": "Returns a list of Workload in the mesh." } ] } ], "bundled": true }