Publish API Package
Publish an API Package to a portal.
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The Portal identifier
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
API Package Publication
An API Package publication in a portal
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.
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
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
Response
An API Package publication in a portal
API Package Publication
An API Package publication in a portal
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.
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
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
Informational warnings (e.g. incompatible fields stripped for ACE). Empty if none.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
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.
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The Portal identifier
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
An API Package publication in a portal
API Package Publication
An API Package publication in a portal
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.
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
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
Informational warnings (e.g. incompatible fields stripped for ACE). Empty if none.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Delete API Package Publication
Unpublish an API Package from a portal.
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The Portal identifier
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
API Package was successfully unpublished from portal.
Authentication
Path Parameters
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.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Body
application/json
Body
API Implementation
An entity that implements an API
One OfA Gateway service that implements an API
Show Child Parameters
Response
application/json
Response
An API implementation
API Implementation
An entity that implements an API
One OfContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
A Gateway service that implements an API