API Publication Auth Strategy IDs

array

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.

>= 1 items<= 1 items

API Publication List Item

object

An API publication in a portal

* Additional properties are NOT allowed.
api_idstring(uuid)requiredread-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

portal_idstring(uuid)requiredread-only

The portal identifier.

Example:7710d5c4-d902-410b-992f-18b814155b53

auto_approve_registrationsbooleanrequired

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.

entity_typestringrequired

The type of entity that is being published. Can be either an API or an API Package.

Allowed values:apiapi_package

Example:api

visibilitystringrequired

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.

Allowed values:publicprivate

Default:private

auth_strategy_idsarray[string](uuid)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.

>= 1 items<= 1 items

warningsarray[string]read-only

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

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

Publication List Item

object

An API or API Package publication in a portal

* Additional properties are NOT allowed.
api_idstring(uuid)requiredread-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

portal_idsarray[string](uuid)requiredread-only

The portal identifier.

Example:7710d5c4-d902-410b-992f-18b814155b53

auto_approve_registrationsbooleanrequired

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.

entity_typestringrequired

The type of entity that is being published. Can be either an API or an API Package.

Allowed values:apiapi_package

Example:api

visibilitystringrequired

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.

Allowed values:publicprivate

Default:private

auth_strategy_idsarray[string](uuid)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.

>= 1 items<= 1 items

warningsarray[string]read-only

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

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

Auto Approve Registrations

boolean

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.

API Publication

object

An API publication in a portal

* Additional properties are NOT allowed.
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_idsarray[string](uuid)

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.

>= 1 items<= 1 items

visibilitystring

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.

Allowed values:publicprivate

Default:private

warningsarray[string]read-only

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

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example