Delete Publication

Unpublish an API from a portal.

delete

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

portalIdstring(uuid)required

The Portal identifier

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

Response

API was successfully unpublished from portal.

delete/apis/{apiId}/publications/{portalId}
 

List Publications

Returns a collection of all API Publications.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters API Publications in the response.

Show Child Parameters
sortstring

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

Paginated list of API publications

ListApiPublications

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

An API publication in a portal

* Additional properties are NOT allowed.
Show Child Parameters
get/api-publications
 
application/json

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.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

API Publication filters excluding portal-specific fields (since portal is already specified in path)

Show Child Parameters
sortstring

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

portalIdstring(uuid)required

The Portal identifier

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

Response

application/json

Paginated list of publications

ListPublications

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

An API or API Package publication in a portal

* Additional properties are NOT allowed.
Show Child Parameters
get/portals/{portalId}/api-publications
 
application/json

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