Get a Publication
Retrieve an API’s publication in a portal.
If the API is not published to the portal, a 404 response is returned.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The Portal identifier
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
An API publication in a portal
API Publication
An API 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 Publication
Unpublish an API from a portal.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The Portal identifier
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
API was successfully unpublished from portal.
Authentication
Path Parameters
List Publications
Returns a collection of all API Publications.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters API Publications in the response.
Show Child Parameters
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Response
application/json
Response
Paginated list of API publications
ListApiPublications
returns the pagination information
Show Child Parameters
An API publication in a portal
Show Child Parameters
Authentication
Query Parameters
List Portal API Publications
Returns a collection of all API Publications for a specific portal.
Access Control: Requires permission to view the specified portal. Once portal access is granted, all API publications for that portal are returned regardless of the caller’s individual API permissions.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
API Publication filters excluding portal-specific fields (since portal is already specified in path)
Show Child Parameters
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Path Parameters
The Portal identifier
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
Paginated list of publications
ListPublications
returns the pagination information
Show Child Parameters
An API or API Package publication in a portal
Show Child Parameters
Authentication
Path Parameters
Query Parameters
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