API Publication

List Portal API Publications

Changed on

Returns a collection of all API Publications for a specific portal.

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.

get/v3/portals/{portalId}/api-publications

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/api-publications
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

Filters API Publications in a portal response (excludes portal-specific filters).

sortstring

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

Example:created_at desc

Sorts a collection of API publications within a portal. Supported sort attributes are:

  • api_id
  • api_name
  • created_at
  • updated_at

Response

Paginated list of publications

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  },
  "data": [
    {
      "api_id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
      "portal_ids": [
        "7710d5c4-d902-410b-992f-18b814155b53"
      ],
      "entity_type": "api",
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ]
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

    • info

      added the required property // to the response with the status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 401.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status