You can manage API documents using the Platform Automation API for tasks including:

Creating an API document

You can use this endpoint to add an API document.

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

Listing all API documents

You can use this endpoint to list all API documents.

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

Retrieving an API document

You can use this endpoint to retrieve a specific API document.

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

Updating an API document

You can use this endpoint to update an API document.

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

Deleting an API document

You can use this endpoint to delete an API document.

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