{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs Portals API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Portals", "type": "folder" }, "items": [ { "info": { "name": "List Portals", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals", "params": [ { "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": "sort", "value": "", "type": "query", "description": "Sorts a collection of portals. Supported sort attributes are:\n - name\n - description\n - authentication_enabled\n - rbac_enabled\n - auto_approve_applications\n - auto_approve_developers\n - default_domain\n - canonical_domain\n - created_at\n - updated_at\n" }, { "name": "filter", "value": "", "type": "query", "description": "Filter portals returned in the response." } ] }, "docs": "Lists developer portals defined in this region for this organization. Each developer portal is available at a unique address and has isolated configuration, customization, developers, and applications." }, { "info": { "name": "Create Portal", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/portals", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new developer portal scoped in this region for this organization." }, { "info": { "name": "Get a Portal", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ] }, "docs": "Returns the configuration for a single developer portal, including the current visibility, access, and domain settings." }, { "info": { "name": "Update Portal", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration for a single portal including the visibility, access, and custom domain settings." }, { "info": { "name": "Delete Portal", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "force", "value": "", "type": "query", "description": "If true, the portal will be deleted, automatically deleting all API publications. If the force param is not set, the deletion will only succeed if there are no APIs currently published." } ] }, "docs": "Deletes a single portal, along with all related entities." } ] } ], "bundled": true }