{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs DP Nodes API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "DP Nodes", "type": "folder" }, "items": [ { "info": { "name": "Get an Expected Config Hash", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/expected-config-hash", "params": [ { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." } ] }, "docs": "Retrieve the expected config hash for this control plane. The expected config hash can be used to verify if the config hash of a data plane node is up to date with the control plane. The config hash will be the same if they are in sync." }, { "info": { "name": "List Data Plane Node Records", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/nodes", "params": [ { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." }, { "name": "page[size]", "value": "", "type": "query", "description": "The maximum number of items to include per page. The last page of a collection may include fewer items." }, { "name": "page[after]", "value": "", "type": "query", "description": "Request the next page of data, starting with the item after this parameter." } ] }, "docs": "Returns a list of data plane node records that are associated to this control plane. A data plane node record contains metadata information for the data plane running Kong Gateway." }, { "info": { "name": "Get a Data Plane Node Record", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/nodes/:nodeId", "params": [ { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." }, { "name": "nodeId", "value": "", "type": "path", "description": "Node identifier" }, { "name": "size", "value": "", "type": "query", "description": "Number of resources to be returned." }, { "name": "tags", "value": "tag1,tag2", "type": "query", "description": "A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR." } ] }, "docs": "Retrieve a specific data plane node record associated to this control plane. A data plane node record contains all the metadata information of the Kong Gateway dataplane." }, { "info": { "name": "Delete Data Plane Node Record", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/nodes/:nodeId", "params": [ { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." }, { "name": "nodeId", "value": "", "type": "path", "description": "Node identifier" } ] }, "docs": "Remove a specific data plane node record associated to this control plane. Deleting this record does not prevent the data plane node from re-connecting to the control plane." }, { "info": { "name": "List End-of-Life Data Plane Node Records", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/nodes/eol", "params": [ { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." }, { "name": "page[size]", "value": "", "type": "query", "description": "The maximum number of items to include per page. The last page of a collection may include fewer items." }, { "name": "page[after]", "value": "", "type": "query", "description": "Request the next page of data, starting with the item after this parameter." } ] }, "docs": "Returns a list of records of data plane nodes, whose versions are approaching End of Full Support/End of Life, that are associated with this control plane. Each record contains a data plane node's id, version, and corresponding resolution message to upgrade to the closest Long Term Support version." } ] } ], "bundled": true }