This technical document will provide you with the information you need integrate and setup automation for various API tasks.

The table of contents providesd below outlines the APIs tasks covered within this technical documentation.

  1. Introduction

    1.1 Common Information

  2. Managing API Authentication Task

    2.1 Create an API authentication

    2.2 Retrieve a specific API authentication

    2.3 List all API authentications

    2.4 Update an API authentication

    2.5 Deletes an API authentication

  3. Managing API Document Task

    3.1 Create an API document

    3.2 Retrieve all API documents

    3.3 Retrieve a specific API document

    3.4 Update API document

    3.5 Delete an API document

  4. Managing API Environment Policy Task

    4.1 Retrieve a specific API environment policy

    4.2 Update an API environment policy

    4.3 Delete an API environment policy

  5. Managing API Environment Task

    5.1 List all API environments for a specific API

    5.2 Retrieve a specific API environment for a specific API

    5.3 Update an API environment

  6. Managing API Operation Task

    6.1 List all operations for the specific API

  7. Managing API Operation Policy Task

    7.1 Retrieve specific API operation policy for a specific API

    7.2 Update specific API operation policy for a specific API

    7.3 Delete specific API operation policy for a specific API

  8. Managing API Policy Task

    8.1 Retrieve API-scope policy for a specific API

    8.2 Update an API-scope policy

    8.3 Delete an API-scope policy

  9. Managing API Release Task

    9.1 Create an API release

    9.2 Retrieve all releases for the selected API

    9.3 Retrieve a specific API release

    9.4 Update an API release

    9.5 Delete an API release

  10. Managing API Security Configuration Task

    10.1 Create an API Security Configuration

    10.2 Retrieve all API Security Configurations

    10.3 Retrieve a specific API Security Configuration

    10.4 Update an API Security Configuration

    10.5 Delete an API Security Configuration

  11. Managing API Task

    11.1 Create an API

    11.2 List all APIs

    11.3 Retrieve an API

    11.4 Publish an API

    11.5 View API publish preview

    11.6 UnPublish an API

    11.7 Update API

    11.8 Delete an API

  12. Managing Named Values Task

    11.1 Create Named Value

    11.2 List all named values

    11.3 Retrieve a named value

    11.4 Update a named value

    11.5 Delete a named value

  13. Managing API Workspace Backend Task

    12.1 Create a workspace backend task

    12.2 List all workspace backend tasks

    12.3 Retrieve a workspace backend task

    12.4 Update a workspace backend task

    12.5 Delete a workspace backend task

Introduction

This document provides a comprehensive overview of all avalable endpoints, their functionality, and how to integrate with DfE APIs efficiently for automation. Designed for developers and technical users, this documentation will enable you to automate tasks, build integrations, and optimise workflows with ease.

With focus on automation, scalability and flexibility, it empowers you to:

  • Automate repetive tasks.
  • Retrieve and manipulate data programmatically.
  • Integrate with third-party application or internal systems.

Whether you are creating custom applications, extending existing tools, or managing workflows, this API technical document provides the resource to help you with automation.

Common information

The following applies to all endpoints outlined in this documentation. This approach and structure has been used for the API task documentation to avoid repeating these here and online schema documentation.

  • Response formats: JSON

  • Requires authentication?: Yes

  • Authorisation Type: Bearer Token

  • HEADER PARAMETERS

    • Parameters

      Details of any required header parameters can be found here

  • REQUEST BODY SCHEMA: application/json

    • Data / Body Parameters

      Details of any required data parameters including name, if required, parameter type, description can be found here

  • PATH (URL) PARAMETERS Details of any required URL parameters including name, if required, parameter type, description can be found here

  • QUERY PARAMETERS Details of any required query parameters including name, if required, parameter type, description can be found here

Managing API Authentication Task

API Name: ApiAuthenticationTask

This API provides a way to manage API authentication tasks including creating, listing, updating and deleting an authentication method. Authentication

Here are the different endpoints and methods for available operations that can be performed with this API.

Create an API authentication

This endpoint is used to add an authentication method to an API by creating a new authentication object and record.

One or more authentication method objects are appended to an array in the body of the request.

Sample Request and Responses

  • Sample Request:

    POST https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/authentication

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "Authentication method does not exist"
        }
    ]
  }

List all API authentications

This endpoint returns a list of all authentication methods for an API by retrieving all authentication method objects.

If there are records matching the query parameters supplied, an array of authentication objects is retrieved, else an empty array is returned.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/authentication

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "Authentication method does not exist"
        }
    ]
  }

Retrieve a specific API authentication

This endpoint returns a specific authentication method information by retrieving a specific authentication method object for an API by ID.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/authentication/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "Authentication method does not exist"
        }
    ]
  }

Update an API authentication

This endpoint is used to edit one or more authentication method details by modifying authentication method record.

One or more authentication method object are edited within an array in the body of the request.

And every object must have the ID of the authentication method along with the fields that are to be edited. Only specified fields are updated with this method, which means unspecified fields remain unchanged.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/authentication/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "Authentication method does not exist"
        }
    ]
  }

Delete an API authentication

This endpoint deletes a specific authentication method by ID.

On deletion, the record for the API is marked as deleted.

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/authentication/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "Authentication method does not exist"
        }
    ]
  }

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/authentication/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "Authentication method does not exist"
        }
    ]
  }

Managing API Document Task

API Name: ApiDocumentTask

This API provides a way to manage API document tasks including creating, listing, updating and deleting a document associated with an API.

Here are the different endpoints and methods for available operations that can be performed with this API.

Create an API document

This endpoint is used to add an API document by creating a new document object and record.

One or more document objects are appended to an array in the body of the request.

Sample Request and Responses

  • Sample Request:

    POST https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/document

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "Document does not exist"
        }
    ]
  }

List all API documents

This endpoint returns a list of all documents associated with an API by retrieving all API document objects.

If there are records matching the query parameters supplied, an array of API documents is retrieved, else an empty array is returned.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/document

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API document does not exist"
        }
    ]
  }

Retrieve a specific API document

This endpoint returns a specific API document by retrieving a specific document object for an API by ID.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/document/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API document does not exist"
        }
    ]
  }

Update an API document

This endpoint is used to edit one or more API document details by modifying API document record.

One or more API document object are edited within an array in the body of the request.

And every object must have the ID of the API document along with the fields that are to be edited. Only specified fields are updated with this method, which means unspecified fields remain unchanged.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/document/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API document does not exist"
        }
    ]
  }

Delete an API document

This endpoint deletes a specific API document by ID.

On deletion, the record for the API is marked as deleted.

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/document/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API document does not exist"
        }
    ]
  }

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/document/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API document does not exist"
        }
    ]
  }

Managing API Environment Policy Task

API Name: ApiEnvironmentPolicyTask

This API provides a way to manage API environment policy tasks including creating, listing, updating and deleting an API environment policy.

Here are the different endpoints and methods for available operations that can be performed with this API.

Retrieve a specific API environment policy

This endpoint returns a specific API environment policy information by retrieving a specific API environment policy object for an API by ID.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/environments/{environmentName}/policy

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API environment policydoes not exist"
        }
    ]
  }

Update an API authentication

This endpoint is used to edit one or more API environment policy details by modifying the API environment policy record.

One or more API environment policy object are edited within an array in the body of the request.

And every object must have the ID of the API environment policy along with the fields that are to be edited. Only specified fields are updated with this method, which means unspecified fields remain unchanged.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/environments/{environmentName}/policy

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API environment policy does not exist"
        }
    ]
  }

Delete an API Environment Policy

This endpoint deletes a specific API Environment Policy by ID.

On deletion, the record for the API is marked as deleted.

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/environments/{environmentName}/policy

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API Environment Policy does not exist"
        }
    ]
  }

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/environments/{environmentName}/policy

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API Environment Policy does not exist"
        }
    ]
  }

Managing API Environment Task

API Name: ApiEnvironmentTask

This API provides a way to manage API environment tasks including creating, listing, updating and deleting an API environment.

Here are the different endpoints and methods for available operations that can be performed with this API.

List all API environments

This endpoint returns a list of all API environments for an API by retrieving all API environment objects.

If there are records matching the query parameters supplied, an array of API environment objects is retrieved, else an empty array is returned.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk//api/tasks/apis/{apiId}/environments

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API environment does not exist"
        }
    ]
  }

Retrieve a specific API authentication

This endpoint returns a specific API environment information by retrieving a specific API environment object for an API by Environment name.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/environments/{environmentName}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API environment does not exist"
        }
    ]
  }

Update an API authentication

This endpoint is used to edit one or more API environment details by modifying API environment record.

One or more API environment object are edited within an array in the body of the request.

And every object must have the Name of the API environment along with the fields that are to be edited. Only specified fields are updated with this method, which means unspecified fields remain unchanged.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/environments/{environmentName}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API environment does not exist"
        }
    ]
  }

Managing API Operation Task

API Name: ApiIOperationTask

This API provides a way to manage API operations task including listing all the operations that can be performed by an API.

Here is the endpoint and method for doing that.

List all API operations

This endpoint returns a list of all operations for an API by retrieving all operations objects.

If there are records matching the query parameters supplied, an array of operation objects is retrieved, else an empty array is returned.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/operations

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "Operation does not exist"
        }
    ]
  }

Managing API Operation Policy Task

API Name: ApiOperationPolicyTask

This API provide a way to manage API operation policy tasks including listing, updating and deleting an API operation policy.

Here are the different endpoints and methods for available operations that can be performed with this API.

Retrieve a specific API operation policy

This endpoint returns a specific API operation policy information by retrieving a specific API operation policy object for an API by ID.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/operations/{operationId}/policy

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API operation policy does not exist"
        }
    ]
  }

Update an API Operation Policy

This endpoint is used to edit one or more API operation policy details by modifying API operation policy record.

One or more API operation policy object are edited within an array in the body of the request.

And every object must have the ID of the API operation policy along with the fields that are to be edited. Only specified fields are updated with this method, which means unspecified fields remain unchanged.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/operations/{operationId}/policy

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API operation policy does not exist"
        }
    ]
  }

Delete an API Operation Policy

This endpoint deletes a specific authentication method by ID.

On deletion, the record for the API is marked as deleted.

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/operations/{operationId}/policy

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API operation policy does not exist"
        }
    ]
  }

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/operations/{operationId}/policy

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API operation policy does not exist"
        }
    ]
  }

Managing API Policy Task

API Name: ApiPolicyTask

This API provide a way to manage API policy tasks including listing, updating and deleting an API policy.

Here are the different endpoints and methods for available operations that can be performed with this API.

Retrieve a specific API policy

This endpoint returns a specific API policy information by retrieving a specific API policy object for an API by ID.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/policy

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API policy does not exist"
        }
    ]
  }

Update an API policy

This endpoint is used to edit one or more API policy details by modifying API policy record.

One or more API policy object are edited within an array in the body of the request.

And every object must have the ID of the API policy along with the fields that are to be edited. Only specified fields are updated with this method, which means unspecified fields remain unchanged.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/policy

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API policy does not exist"
        }
    ]
  }

Delete an API policy

This endpoint deletes a specific API policy by ID.

On deletion, the record for the API is marked as deleted.

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/policy

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API policy does not exist"
        }
    ]
  }

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/policy

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API policy does not exist"
        }
    ]
  }

Managing API Release Task

API Name: ApiReleaseTask

This API provide a way to manage API release tasks including creating, listing, updating and deleting an API release.

Here are the different endpoints and methods for available operations that can be performed with this API.

Create an API release

This endpoint is used to add an API release to an API by creating a new API release object and record.

One or more API release objects are appended to an array in the body of the request.

Sample Request and Responses

  • Sample Request:

    POST https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/releases

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API release does not exists"
        }
    ]
  }

List all API releases

This endpoint returns a list of all API releases for an API by retrieving all API release objects.

If there are records matching the query parameters supplied, an array of API release objects is retrieved, else an empty array is returned.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/releases

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API release does not exist"
        }
    ]
  }

Retrieve a specific API release

This endpoint returns a specific API release information by retrieving a specific API release object for an API by ID.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/releases/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API release does not exist"
        }
    ]
  }

Update an API release

This endpoint is used to edit one or more API release details by modifying API release record.

One or more API release object are edited within an array in the body of the request.

And every object must have the ID of the API release along with the fields that are to be edited. Only specified fields are updated with this method, which means unspecified fields remain unchanged.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/releases/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API release does not exist"
        }
    ]
  }

Delete an API release

This endpoint deletes a specific API release by ID.

On deletion, the record for the API is marked as deleted.

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/releases/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API release does not exist"
        }
    ]
  }

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/releases/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API release does not exist"
        }
    ]
  }

Managing API Security Configuration Task

API Name: ApiSecurityConfigurationTask

This API provide a way to manage custom security configuration settings for an API or API Environment. A custom security configuration for an API allows you to override the default HTTPS timeout value and add Web Application Firewall (WAF) exclusions. A web application firewall (WAF) filters, monitors, and blocks HTTP traffic to and from a web service.

An environment scope policy will override an API scope policy by default, unless the Inheritance option is enabled, in which case WAF exclusions will be combined from both scopes (if each exist).

Create an API Security Configuration

This endpoint is used to add security configuration to an API by creating a new API security configuration object and record.

One or more API release objects are appended to an array in the body of the request.

Sample Request and Responses

  • Sample Request:

    POST https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/security

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API security configuration does not exists"
        }
    ]
  }

Retrieve all API Security Configurations

This endpoint returns a list of all security configuration for an API by retrieving all API security configuration objects.

If there are records matching the query parameters supplied, an array of API security configuration objects is retrieved, else an empty array is returned.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/security

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API security configuration does not exist"
        }
    ]
  }

Retrieve a specific API Security Configuration

This endpoint returns a specific security configuration information for an API by retrieving a specific API security configuration object for an API by ID.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/security/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API security configuration does not exist"
        }
    ]
  }

Update an API Security Configuration

This endpoint is used to edit one or more API security configuration details by modifying the API security configuration record.

One or more API security configuration object are edited within an array in the body of the request.

And every object must have the ID of the API security configuration along with the fields that are to be edited. Only specified fields are updated with this method, which means unspecified fields remain unchanged.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/security/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "security configuration does not exist"
        }
    ]
  }

Delete an API Security Configuration

This endpoint deletes a specific API security configuration by ID.

On deletion, the record for the API security configuration is marked as deleted.

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/security/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API security configuration does not exist"
        }
    ]
  }

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/security/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API security configuration does not exist"
        }
    ]
  }

Managing API Task

API Name: ApiTask

This API provide a way to perform API management tasks including creating, listing, updating, publishing and deleting an API.

Here are the different endpoints and methods for available operations that can be performed with this API.

Create an API

This endpoint is used to add an API by creating a new API object and record.

One or more API objects are appended to an array in the body of the request.

Sample Request and Responses

  • Sample Request:

    POST https://dev-apimanagement.education.gov.uk/api/tasks/apis

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API does not exists"
        }
    ]
  }

List all APIs

This endpoint returns a list of all APIs for an API by retrieving all API objects.

If there are records matching the query parameters supplied, an array of API objects is retrieved, else an empty array is returned.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API does not exist"
        }
    ]
  }

Retrieve a specific API

This endpoint returns a specific API information by retrieving a specific API object for an API by ID.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API does not exist"
        }
    ]
  }

Update an API

This endpoint is used to edit one or more API details by modifying API record.

One or more API object are edited within an array in the body of the request.

And every object must have the ID of the API along with the fields that are to be edited. Only specified fields are updated with this method, which means unspecified fields remain unchanged.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/apis/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API does not exist"
        }
    ]
  }

Publish an API

This endpoint is used to edit one or more API details by modifying API record.

One or more API object are edited within an array in the body of the request.

And every object must have the ID of the API along with the fields that are to be edited. Only specified fields are updated with this method, which means unspecified fields remain unchanged.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/apis/publish/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API does not exist"
        }
    ]
  }

View API publish preview

This endpoint returns the submitted publishing details for specific API by retrieving a specific API publish request object by ID.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/apis/{id}/publishPreview

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API publish preview does not exist"
        }
    ]
  }

UnPublish an API

This endpoint is used to edit one or more API publish details to unpublish the API by modifying API record.

One or more API object are edited within an array in the body of the request.

And every object must have the ID of the API along with the fields that are to be edited. All fields are updated with this method, which means unspecified fields are changed to unpublish the API.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/apis/{id}/unpublish

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API does not exist"
        }
    ]
  }

Delete an API authentication

This endpoint deletes a specific API by ID.

On deletion, the record for the API is marked as deleted.

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API does not exist"
        }
    ]
  }

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/apis/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API does not exist"
        }
    ]
  }

Managing Named Values

This is an API used for Named Values tasks automation. You can create, retrieve, or delete Named values through the automation process and specific endpoints.

Create a Named Values

This endpoint allows you to setup and configure the automation for creating Named values. You must authenticate using an authorisation token to consume the Named values API through this endpoint.

  • Endpoint URL: https://dev-apimanagement.education.gov.uk/api/tasks/namedvalues

  • Method: POST

  • Sample Request:

    POST https://dev-apimanagement.education.gov.uk/api/tasks/namedvalues
  {
    "name": "sample-named-value",
    "description": "This is a sample to demonstrate new Named Value creation through automation.",
    "type": "secret",
    "value": "QeubsdkskOKL"
  }

  • Sample Success Response:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response:

      {
    "errors": [
        {
          "message": "Named value already exist"
        }
    ]
  }

Retrieve All Named Values

This endpoint allows you to setup and configure the automation for retrieving a list of all Named Values. This means it returns an array containing all Named Values objects for an environment. If there are no matching Named Values entries, an empty array is returned.

You must authenticate using an authorisation token to consume the Named Values API through this endpoint.

  • Endpoint URL : https://dev-apimanagement.education.gov.uk/api/tasks/namedvalues

  • Method: GET

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/namedvalues

  • Sample Success Response:

      { 
    "name": "sample-named-value",
    "description": "This is a sample to demonstrate new Named Value creation through automation.",
    "status": "Active",
    "type": "secret",
    "value": "QeubsdkskOKL"
  }

  {
    "name": "sample-named-value-secret-2",
    "description": "This is a second sample to demonstrate new Named Value creation through automation.",
    "status": "Active",
    "type": "secret",
    "value": "QeyioLLOKEMC87M"
  }

Retrieve a Named Value

This endpoint returns a specific named value information by retrieving a specific named value object for an API by ID.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/namedvalues/{name}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Value Schema:

      {
  "description": "This is an example named value",
  "name": "named-value-name",
  "namedValueContentValue": "SecretValue!",
  "status": null,
  "type": "keyvault"
  }

- Sample Error Response Value:

{
  "errors": [
      {
        "message": "Named value does not exist"
      }
  ]
}
```

Update a Named Value

This endpoint is used to edit one or more named value details by modifying named value record.

One or more Named value object are edited within an array in the body of the request.

And every object must have the ID of the named value along with the fields that are to be edited. Only specified fields are updated with this method, which means unspecified fields remain unchanged.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/namedvalues/{name}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Value Schema:

      {
  "description": "This is an example named value",
  "name": "named-value-name",
  "namedValueContentValue": "SecretValue!",
  "status": null,
  "type": "keyvault"
  }

- Sample Error Response Value:

{
  "errors": [
      {
        "message": "Named value does not exist"
      }
  ]
}
```

Delete a Named Value

This endpoint allows you to setup and configure the automation of deleting Named Values. On deletion, the Named Value status within the record is changed to 'Deleted' to indicate it has been deleted.

You must authenticate using an authorisation token to consume the Named Values API through this endpoint.

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/namedvalues/sample-name-value

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "Named value does not exist"
        }
    ]
  }

Managing API Workspace Backend Task

API Name: WorkspaceBackendTask

This API provide a way to manage API workspace backend tasks including creating, listing, updating and deleting a API workspace backend.

Here are the different endpoints and methods for available operations that can be performed with this API.

Create an API workspace backend

This endpoint is used to add an API workspace backend to an API by creating a new API workspace backend object and record.

One or more API workspace backend objects are appended to an array in the body of the request.

Sample Request and Responses

  • Sample Request:

    POST https://dev-apimanagement.education.gov.uk/api/tasks/backends

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API workspace backend does not exists"
        }
    ]
  }

List all API workspace backends

This endpoint returns a list of all API workspace backends for an API by retrieving all API workspace backend objects.

If there are records matching the query parameters supplied, an array of API workspace backend objects is retrieved, else an empty array is returned.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/backends

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API workspace backend does not exist"
        }
    ]
  }

Retrieve a specific API workspace backend

This endpoint returns a specific API workspace backend information by retrieving a specific API workspace backend object for an API by name.

Sample Request and Responses

  • Sample Request:

    GET https://dev-apimanagement.education.gov.uk/api/tasks/backends/{name}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API workspace backend does not exist"
        }
    ]
  }

Update an API workspace backend

This endpoint is used to edit one or more API workspace backend details by modifying API workspace backend record.

One or more API workspace backend object are edited within an array in the body of the request.

And every object must have the Name of the API workspace backend along with the fields that are to be edited. Only specified fields are updated with this method, which means unspecified fields remain unchanged.

Sample Request and Responses

  • Sample Request:

    PUT https://dev-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/authentication/{id}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API workspace backend does not exist"
        }
    ]
  }

Delete an API workspace backend

This endpoint deletes a specific API workspace backend by name.

On deletion, the record for the API is marked as deleted.

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/backends/{name}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API workspace backend does not exist"
        }
    ]
  }

Sample Request and Responses

  • Sample Request:

    DELETE https://dev-apimanagement.education.gov.uk/api/tasks/backends/{name}

  • Sample Success Response Value:

      {
    "Success": [
        {
          "message": "OK"
        }
    ]
  }

  • Sample Error Response Value:

      {
    "errors": [
        {
          "message": "API workspace backend does not exist"
        }
    ]
  }