Overview

This demonstration API is provided to allow any user to test the process of subscribing and connecting to an API using the Find and Use an API service.

Access to this API is secured by:

  • Subscription key
  • Native OAuth application flow

Documents

FaUAPI-Demo-Function.json
Uploaded schema

Who can use this API

Anyone who signs in to the Find and Use an API service using a GOV.UK One Login account.

Service level

This is an example service and has no SLA

Technologies

  • C# .NET
  • Azure Storage Blobs

Environments

Environment Base URL
Dev https://pp-api.education.gov.uk/dev/fauapi-demo-api-public-oauth
Staging https://pp-api.education.gov.uk/staging/fauapi-demo-api-public-oauth
Live https://pp-api.education.gov.uk/fauapi-demo-api-public-oauth

You need to sign in to subscribe to an API environment.

Sign in here using GOV.UK One Login

Current release

Release name Available from
1.0 12th September 2024

Other releases

Release name Available from Available to
0.9 10th August 2024 11th September 2024
1.2

Operations

GET Download

Description

Downloads a file specified by the file name

URL template
/Download/{filename}

GET Echo-Get

Description

Simple GET endpoint which echos all the requested data into JSON format

URL template
/Echo-Get

POST Echo-Post

Description

Simple POST endpoint which echos all the requested data into JSON format including a plain text body

URL template
/Echo-Post

GET List

Description

Lists all files which have been uploaded

URL template
/List

POST Upload

Description

Uploads a file

URL template
/Upload
Back to top