API Package Publication

object

An API Package 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

API Implementation Service

object

A Gateway service that implements an API

* Additional properties are NOT allowed.
control_plane_idstring(uuid)required

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

idstring(uuid)required

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

auth_strategy_sync_errorobjectread-only

Example:{"control_plane_error":"control_plane_error_unavailable","message":"Unable to connect to the control plane to update plugin"}

* Additional properties are NOT allowed.
Show Child Parameters
Example

API Implementation Control Plane

object

A Control plane that implements an API

* Additional properties are NOT allowed.
access_control_enforcement_enabledbooleanread-only

Indicates if the access control enforcement plugin is installed globally in the target control plane

control_plane_idstring(uuid)required

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

Example

API Implementation List Item

object

An entity that implements an API

One Of
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

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

api_idstring(uuid)requiredread-only

The API identifier.

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

serviceobject

A Gateway service that implements an API

* Additional properties are NOT allowed.
Show Child Parameters
Example

ApiImplementationListItemGatewayServiceEntity

object

An API Implementation list item for gateway services

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

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

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

api_idstring(uuid)requiredread-only

The API identifier.

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

serviceobject

A Gateway service that implements an API

* Additional properties are NOT allowed.
Show Child Parameters
Example