You can manage workspace backend using the Platform Automation API for operations including:
- Creating a workspace backend
- Listing all workspace backends
- Retrieving a workspace backend
- Updating a workspace backend
- Deleting a workspace backend
Creating a workspace backend
You can use this endpoint to add a workspace backend.
Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/backends
Listing all workspace backends
You can use this endpoint to list all workspace backends.
Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/backends
Retrieving a workspace backend
You can use this endpoint to retrieve a workspace backend.
Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/backends/{name}
Updating a workspace backend
You can use this endpoint to update a workspace backend.
Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/backends/{name}
Deleting a workspace backend
You can use this endpoint to delete a workspace backend.
Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/backends/{name}
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.