API Specification Validation Success Response
objectAny informational messages or warnings generated during validation. Empty if none.
Show Child Parameters
API Publication Visibility
stringThe 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
API Publication Auth Strategy IDs
arrayThe 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
API Publication List Item
objectAn API publication in a portal
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The portal identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
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 type of entity that is being published. Can be either an API or an API Package.
Allowed values:apiapi_package
Example:api
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
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
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
Publication List Item
objectAn API or API Package publication in a portal
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The portal identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
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 type of entity that is being published. Can be either an API or an API Package.
Allowed values:apiapi_package
Example:api
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
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
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