Publish API Package

Publish an API Package to a portal.

put

Path Parameters

apiPackageIdstring(uuid)required

The UUID API Package identifier

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

portalIdstring(uuid)required

The Portal identifier

Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

API Package Publication

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 | null[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

Response

application/json

An API Package publication in a portal

API Package Publication

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 | null[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

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

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

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

Body

{}
 
application/json

Get an API Package Publication

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

Path Parameters

apiPackageIdstring(uuid)required

The UUID API Package identifier

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

portalIdstring(uuid)required

The Portal identifier

Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

An API Package publication in a portal

API Package Publication

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 | null[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

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

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

get/api-packages/{apiPackageId}/publications/{portalId}
 
application/json

Delete API Package Publication

Unpublish an API Package from a portal.

delete

Path Parameters

apiPackageIdstring(uuid)required

The UUID API Package identifier

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

portalIdstring(uuid)required

The Portal identifier

Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

Response

API Package was successfully unpublished from portal.

delete/api-packages/{apiPackageId}/publications/{portalId}
 

API Implementation

Create API Implementation

Creates an implementation for an API.
If all operations in an API are implemented by a single gateway service and the service
has no routes that are not part of the API, then the API can be linked to the service.
For cases where an API is implemented by multiple gateway services, only a subset of
routes in one or more gateway services, or API operations need to be made available for API packages,
then the API should be linked to the control plane that defines the routes that overlap with the API.

post

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

Body

application/json

API Implementation

API Implementationobject

An entity that implements an API

One Of
serviceobject

A Gateway service that implements an API

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

An API implementation

API Implementation

API Implementationobject

An entity that implements an API

One Of
idstring(uuid)read-only

Contains a unique identifier used for this resource.

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

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

serviceobject

A Gateway service that implements an API

* Additional properties are NOT allowed.
Show Child Parameters
post/apis/{apiId}/implementations

Body

{ "service": { "control_plane_id": "fd4e1b98-3629-4dd3-acc0-759a726ffee2", "id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2" } }
 
application/json