{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs Pages API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Pages", "type": "folder" }, "items": [ { "info": { "name": "Create Boilerplate Content", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/default-content", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ] }, "docs": "Creates a default collection of pages, snippets, and customization config for a portal if they do not already exist. This endpoint is optional, you can call it to populate a newly created developer portal with default content, but it is not required. Existing pages and snippets will not be modified or deleted. If used, it is typically called once per portal shortly after creation." }, { "info": { "name": "List Pages", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/pages", "params": [ { "name": "sort", "value": "", "type": "query", "description": "Sorts a collection of portal pages. Supported sort attributes are:\n - created_at\n - updated_at\n - slug\n - title\n - visibility\n" }, { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "filter", "value": "", "type": "query", "description": "Filter pages returned in the response." } ] }, "docs": "Returns the tree view of custom pages that have been created for this portal. The full tree is returned in one response; this endpoint is not paginated." }, { "info": { "name": "Create Page", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/pages", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new custom page for this portal. Custom pages 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 frontmatter will take precedence." }, { "info": { "name": "Get a Page", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/pages/:pageId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "pageId", "value": "", "type": "path", "description": "ID of the page." } ] }, "docs": "Returns the configuration of a single custom page for this portal. Custom pages can be used to display static content, documentation, or other information to developers." }, { "info": { "name": "Update Page", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/pages/:pageId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "pageId", "value": "", "type": "path", "description": "ID of the page." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of a single custom page for this portal." }, { "info": { "name": "Delete Page", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/pages/:pageId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "pageId", "value": "", "type": "path", "description": "ID of the page." } ] }, "docs": "Deletes a single custom page for this portal." }, { "info": { "name": "Move Page", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/pages/:pageId/move", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "pageId", "value": "", "type": "path", "description": "ID of the page." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This api allows the user to move a page within the page tree using the parameters parent_page_id and index. If parent_page_id is not provided, the page will be placed at the top level of the page tree. index represents a zero-indexed page order relative to its siblings under the same parent. For example, if we want to put the page at top level in first position we would send parent_page_id: null and index: 0. This api also supports using a negative index to count backwards from the end of the pa" } ] } ], "bundled": true }