Delete API Specification

DEPRECATED

Deletes the specification (OpenAPI or AsyncAPI) of an API.
Note: This endpoint is deprecated and will be removed: use /versions instead.

delete

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

specIdstring(uuid)required

The API specification identifier

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

Response

API Specification was deleted successfully.

delete/apis/{apiId}/specifications/{specId}
 

API Publication

Publish API

Publish an API to a portal.

put

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

Body

application/json

API Publication

An API 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 publication in a portal

API Publication

An API 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/apis/{apiId}/publications/{portalId}

Body

{}
 
application/json

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.

get

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

application/json

An API publication in a portal

API Publication

An API 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/apis/{apiId}/publications/{portalId}
 
application/json

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}