You can manage an API using the Platform Automation API for operations including:

Details of required parameters, available methods and endpoint urls can be found within FaUAPI API task schema documentation.

Creating an API

You can use this endpoint to create an API.View details on the url and any parameters required to use this endpoint.

Listing all APIs

You can use this endpoint to list all APIs.View details on the url and any parameters required to use this endpoint.

Retrieving an API

You can use this endpoint to retrieve an API.View details on the url and any parameters required to use this endpoint.

Publishing an API

You can use this endpoint to publish an API.View details on the url and any parameters required to use this endpoint.

Viewing an API publish preview

You can use this endpoint to view a preview of an API detail before publishing it.View details on the url and any parameters required to use this endpoint.

Unpublishing an API

You can use this endpoint to unpublish an API.The url and required parameters for this endpoint can be found atView details on the url and any parameters required to use this endpoint.

Updating an API

You can use this endpoint to update an API.View details on the url and any parameters required to use this endpoint.

Deleting an API

You can use this endpoint to delete an API.View details on the url and any parameters required to use this endpoint.

Example

An example showing how to use a Platform Automation API endpoint for automation can found in the Example automation using an api endpoint section.