You can manage an API groups within a workspace using the Platform Automation API for operations including:

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

Creating an API group

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

Listing all API groups

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

Retrieving an API group

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

Publishing an API group

You can use this endpoint to publish an API group. View details on the url and any 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. https://dev-apimanagement.education.gov.uk/api/schema/index.html#operations-.

Unpublishing an API group

You can use this endpoint to unpublish an API group. The url and required parameters for this endpoint can be found athttps://dev-apimanagement.education.gov.uk/api/schema/index.html#operations-.

Updating an API group

You can use this endpoint to update an API group. https://dev-apimanagement.education.gov.uk/api/schema/index.html#operations-.

Deleting an API group

You can use this endpoint to delete an API group. https://dev-apimanagement.education.gov.uk/api/schema/index.html#operations-.

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.