{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs API Publication API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "API Publication", "type": "folder" }, "items": [ { "info": { "name": "Get an API Package Publication", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/api-packages/:apiPackageId/publications/:portalId", "params": [ { "name": "apiPackageId", "value": "", "type": "path", "description": "The UUID API Package identifier" }, { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ] }, "docs": "Retrieve an API Package's publication in a portal.\nIf the API Package is not published to the portal, a 404 response is returned.\n" }, { "info": { "name": "Publish API Package", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}:{port}{path}/v3/api-packages/:apiPackageId/publications/:portalId", "params": [ { "name": "apiPackageId", "value": "", "type": "path", "description": "The UUID API Package identifier" }, { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Publish an API Package to a portal.\n" }, { "info": { "name": "Delete API Package Publication", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/api-packages/:apiPackageId/publications/:portalId", "params": [ { "name": "apiPackageId", "value": "", "type": "path", "description": "The UUID API Package identifier" }, { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ] }, "docs": "Unpublish an API Package from a portal." }, { "info": { "name": "List Publications", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/api-publications", "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": "filter", "value": "", "type": "query", "description": "Filters API Publications in the response." }, { "name": "sort", "value": "", "type": "query", "description": "Sorts a collection of API publications. Supported sort attributes are:\n - portal_id\n - portal_name\n - api_id\n - api_name\n - created_at\n - updated_at\n" } ] }, "docs": "Returns a collection of all API Publications." }, { "info": { "name": "Get a Publication", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/apis/:apiId/publications/:portalId", "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The UUID API identifier" }, { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ] }, "docs": "Retrieve an API's publication in a portal.\nIf the API is not published to the portal, a 404 response is returned.\n" }, { "info": { "name": "Publish API", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}:{port}{path}/v3/apis/:apiId/publications/:portalId", "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The UUID API identifier" }, { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Publish an API to a portal.\n" }, { "info": { "name": "Delete Publication", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/apis/:apiId/publications/:portalId", "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The UUID API identifier" }, { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ] }, "docs": "Unpublish an API from a portal." }, { "info": { "name": "List Portal API Publications", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/api-publications", "params": [ { "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": "Filters API Publications in a portal response (excludes portal-specific filters)." }, { "name": "sort", "value": "", "type": "query", "description": "Sorts a collection of API publications within a portal. Supported sort attributes are:\n\n\n - api_id\n - api_name\n - created_at\n - updated_at\n" } ] }, "docs": "Returns a collection of all API Publications for a specific portal.\n\n**Access Control**: Requires permission to view the specified portal. Once portal access is granted, all API publications for that portal are returned regardless of the caller's individual API permissions.\n" } ] } ], "bundled": true }