Sign in
API Publication

Publish API Package

Publish an API Package to a portal.

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

Request body

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

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'

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.

warningsstring[]

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

created_atstring date-time

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time

An ISO-8601 timestamp representation of entity update date.

Example request

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

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.

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

Changed in 3 of the 75 revisions of this API.4

  • 7d3c634668f82See the full diff
    • ○

      the request property default value private was removed

      request-property-default-value-removed

    • ○

      the response's property default value private was removed for the status

      response-property-default-value-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c80d57ed14ab1See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 48b406d912db1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog