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

Creating an API

You can use this endpoint to create an API.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis

Listing all APIs

You can use this endpoint to list all API.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis

Retrieving an API

You can use this endpoint to retrieve an API.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis/{id}

Publishing an API

You can use this endpoint to publish an API.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis/{id}/publish

Viewing an API publish preview

You can use this endpoint to view a preview of an API detail before publishing it.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis/{id}/publishPreview

Unpublishing an API

You can use this endpoint to unpublish an API.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis/{id}/unpublish

Updating an API

You can use this endpoint to update an API.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis/{id}

Deleting an API

You can use this endpoint to delete an API.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis/{id}

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.