API Publication

Get an API Package Publication

Changed on

Retrieve an API Package's publication in a portal. If the API Package is not published to the portal, a 404 response is returned.

get/v3/api-packages/{apiPackageId}/publications/{portalId}

Request

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

Response

An API Package publication in a portal

auto_approve_registrationsboolean

Whether the application registration auto approval on this portal for the api is enabled. If set to false, fallbacks on portal's auto_approve_applications value.

auth_strategy_idsstring[] nullable required

The auth strategy the API enforces for applications in the portal. Omitting this property means the portal's default application auth strategy will be used. Setting to null means the API will not require application authentication. DCR support for application registration is currently in development.

visibility'public' | 'private' required

The visibility of the API in the portal. Public API publications do not require authentication to view and retrieve information about them. Private API publications require authentication to retrieve information about them. If omitted, this defaults to the target portal's configured default API visibility.

form_idstring uuid nullable required

UUID of custom form associated with API publication, must be linked to given portal and have type of 'api_registration'

warningsstring[]

Informational warnings (e.g. incompatible fields stripped for ACE). Empty if none.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 59663dd13a10Revision changes
    • breaking

      the response property / became nullable for the status

    • info

      added the required property / to the response with the status

  • 68d43091b84dRevision changes
    • 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