You can manage an API groups within a workspace using the Platform Automation API for operations including:
- Creating an API group
- Listing all API groups
- Retrieving an API group
- Publishing an API group
- Viewing an API group publish preview
- Unpublishing an API group
- Updating an API group
- Deleting an API group
Details of required parameters, available methods and endpoint urls can be found within the FaUAPI API group task schema documentation.
Creating an API group
You can use this endpoint to create an API group.
View details of the URL and parameters required to use this endpoint.
Listing all API groups
You can use this endpoint to list all API groups.
View details of the URL and parameters required to use this endpoint.
Retrieving an API group
You can use this endpoint to retrieve an API group.
View details of the URL and parameters required to use this endpoint.
Publishing an API group
You can use this endpoint to publish an API group.
View details of the URL and parameters required to use this endpoint.
Viewing an API group publish preview
You can use this endpoint to view a preview of an API group detail before publishing it.
View details of the URL and parameters required to use this endpoint.
Unpublishing an API group
You can use this endpoint to unpublish an API group.
View details of the URL and parameters required to use this endpoint.
Updating an API group
You can use this endpoint to update an API group.
View details of the URL and parameters required to use this endpoint.
Deleting an API group
You can use this endpoint to delete an API group.
View details of the URL and parameters required to use this endpoint.
Example
An example showing how to use a Platform Automation API endpoint for automation can be found within the Example automation using an api endpoint section.