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

Creating an API release

You can use this endpoint to add an API release.

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

Listing all API releases

You can use this endpoint to list all API releases.

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

Retrieving an API release

You can use this endpoint to retrieve an API release.

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

Updating an API release

You can use this endpoint to update an API release.

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

Deleting an API release

You can use this endpoint to delete an API release.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/releases/{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.