{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs Event Gateway Virtual Cluster Consume Policies API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Event Gateway Virtual Cluster Consume Policies", "type": "folder" }, "items": [ { "info": { "name": "List Consume Policies for Virtual Cluster", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v1/event-gateways/:gatewayId/virtual-clusters/:virtualClusterId/consume-policies", "params": [ { "name": "gatewayId", "value": "", "type": "path", "description": "The UUID of your Gateway." }, { "name": "virtualClusterId", "value": "", "type": "path", "description": "The ID of the Virtual Cluster." }, { "name": "filter", "value": "", "type": "query", "description": "Filter policies returned in the response." } ] }, "docs": "Returns a list of consume policies associated with the specified Event Gateway virtual cluster." }, { "info": { "name": "Create Consume Policy for Virtual Cluster", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v1/event-gateways/:gatewayId/virtual-clusters/:virtualClusterId/consume-policies", "params": [ { "name": "gatewayId", "value": "", "type": "path", "description": "The UUID of your Gateway." }, { "name": "virtualClusterId", "value": "", "type": "path", "description": "The ID of the Virtual Cluster." }, { "name": "before", "value": "", "type": "query", "description": "Determines the id of the existing policy the new policy should be inserted before. Either 'before' or 'after' can be provided, when both are omitted the new policy is added to the end of the chain. When both are provided, the request fails with a 400 Bad Request.\n" }, { "name": "after", "value": "", "type": "query", "description": "Determines the id of the existing policy the new policy should be inserted after. Either 'before' or 'after' can be provided, when both are omitted the new policy is added to the end of the chain. When both are provided, the request fails with a 400 Bad Request.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new consume policy associated with the specified Event Gateway virtual cluster." }, { "info": { "name": "Get a Consume Policy for Virtual Cluster", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v1/event-gateways/:gatewayId/virtual-clusters/:virtualClusterId/consume-policies/:policyId", "params": [ { "name": "gatewayId", "value": "", "type": "path", "description": "The UUID of your Gateway." }, { "name": "virtualClusterId", "value": "", "type": "path", "description": "The ID of the Virtual Cluster." }, { "name": "policyId", "value": "", "type": "path", "description": "The UUID of the policy." } ] }, "docs": "Returns information about a specific consume policy associated with the Event Gateway virtual cluster." }, { "info": { "name": "Update Consume Policy for Virtual Cluster", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}:{port}{path}/v1/event-gateways/:gatewayId/virtual-clusters/:virtualClusterId/consume-policies/:policyId", "params": [ { "name": "gatewayId", "value": "", "type": "path", "description": "The UUID of your Gateway." }, { "name": "virtualClusterId", "value": "", "type": "path", "description": "The ID of the Virtual Cluster." }, { "name": "policyId", "value": "", "type": "path", "description": "The UUID of the policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing consume policy associated with the specified Event Gateway virtual cluster." }, { "info": { "name": "Patch Consume Policy for Virtual Cluster", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}:{port}{path}/v1/event-gateways/:gatewayId/virtual-clusters/:virtualClusterId/consume-policies/:policyId", "params": [ { "name": "gatewayId", "value": "", "type": "path", "description": "The UUID of your Gateway." }, { "name": "virtualClusterId", "value": "", "type": "path", "description": "The ID of the Virtual Cluster." }, { "name": "policyId", "value": "", "type": "path", "description": "The UUID of the policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing consume policy associated with the specified Event Gateway virtual cluster." }, { "info": { "name": "Delete Consume Policy for Virtual Cluster", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v1/event-gateways/:gatewayId/virtual-clusters/:virtualClusterId/consume-policies/:policyId", "params": [ { "name": "gatewayId", "value": "", "type": "path", "description": "The UUID of your Gateway." }, { "name": "virtualClusterId", "value": "", "type": "path", "description": "The ID of the Virtual Cluster." }, { "name": "policyId", "value": "", "type": "path", "description": "The UUID of the policy." } ] }, "docs": "Deletes a specific consume policy associated with the Event Gateway virtual cluster." }, { "info": { "name": "Move Consume Policy", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v1/event-gateways/:gatewayId/virtual-clusters/:virtualClusterId/consume-policies/:policyId/move", "params": [ { "name": "gatewayId", "value": "", "type": "path", "description": "The UUID of your Gateway." }, { "name": "virtualClusterId", "value": "", "type": "path", "description": "The ID of the Virtual Cluster." }, { "name": "policyId", "value": "", "type": "path", "description": "The UUID of the policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the position of a specific consume policy relative to the chain associated with the Event Gateway virtual\ncluster.\nIf a policy is defined under a parent policy, it moves the position relative to the sibling policies under the\nsame parent.\n" }, { "info": { "name": "Get Consume Policy Chain", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v1/event-gateways/:gatewayId/virtual-clusters/:virtualClusterId/consume-policy-chain", "params": [ { "name": "gatewayId", "value": "", "type": "path", "description": "The UUID of your Gateway." }, { "name": "virtualClusterId", "value": "", "type": "path", "description": "The ID of the Virtual Cluster." } ] }, "docs": "Get the consume policy chain for a virtual cluster composed of all the ids of the consume policies in order of execution.\n" }, { "info": { "name": "Update Consume Policy Chain", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}:{port}{path}/v1/event-gateways/:gatewayId/virtual-clusters/:virtualClusterId/consume-policy-chain", "params": [ { "name": "gatewayId", "value": "", "type": "path", "description": "The UUID of your Gateway." }, { "name": "virtualClusterId", "value": "", "type": "path", "description": "The ID of the Virtual Cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the consume policy chain for a virtual cluster by providing an ordered list of consume policy ids." } ] } ], "bundled": true }