{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs Snippets API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Snippets", "type": "folder" }, "items": [ { "info": { "name": "List Snippets", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/snippets", "params": [ { "name": "sort", "value": "", "type": "query", "description": "Sorts a collection of portal snippets. Supported sort attributes are:\n - created_at\n - updated_at\n - name\n - title\n - visibility\n" }, { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "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[number]", "value": "", "type": "query", "description": "Determines which page of the entities to retrieve." }, { "name": "filter", "value": "", "type": "query", "description": "Filter snippets returned in the response." } ] }, "docs": "Returns the paginated list of custom snippets that have been created for this portal." }, { "info": { "name": "Create Snippet", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/snippets", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers. Title and Description properties may be provided in the frontmatter section of `content`. If you set values in both the `POST` request _and_ in the frontmatter, the values in the frontmatter will take precedence." }, { "info": { "name": "Get a Snippet", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/snippets/:snippetId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "snippetId", "value": "", "type": "path", "description": "ID of the snippet." } ] }, "docs": "Returns the configuration of a single custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers." }, { "info": { "name": "Update Snippet", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/snippets/:snippetId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "snippetId", "value": "", "type": "path", "description": "ID of the snippet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of a single custom snippet for this portal." }, { "info": { "name": "Delete Snippet", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/snippets/:snippetId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "snippetId", "value": "", "type": "path", "description": "ID of the snippet." } ] }, "docs": "Deletes a single custom snippet for this portal." } ] } ], "bundled": true }