When publishing your APIs through the DfE's Find and Use an API Management Portal for access and consumption through the DfE's Find and Use API Consumption Portal the available status options are:

  • Draft - APIs with this status can only be viewed and edited by the owners of the workspace. This means any API with a Draft status is not ready for release and to be listed on the DfE's Find and Use an API Catalogue for access through the Find and Use an API Consumption Portal.

  • Publishing - APIs with this status are in the process of validation before being published and released to the public.

  • PublishingFailed - APIs with this status indicate that they have failed the process of validation and have not been published to the Find and Use API Catalogue.

  • Published - APIs with this status have been released, listed within the DfE's Find and Use an API Catalogue and ready for consumption. All users can search, view and use them through DfE's Find and Use API Consumption Portal.

The publication status process flow can be summarised as: Draft -> Publishing -> PublishedFailed or Published