Managing API environments task

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

• Listing all API environments
• Retrieving an API environment
• Updating an API environment

Listing all API environments

You can use this endpoint to list all API environments.

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

Retrieving an API environment

You can use this endpoint to retrieve an API environment.

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

Updating an API environment

You can use this endpoint to update an API environment.

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

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.