Status API

Endpoint

Please note the status APIs use a different subdomain:

https://meta.ideal-postcodes.co.uk/

Service Status API

GET /status

The status API is a simple way to view our current availability status.

This endpoint aggregates responses from our 3rd party availability monitors and reports a service as down if all probes agree.

This API currently powers the availability table on status.ideal-postcodes.co.uk

Implementation Notes

In terms of implementation, we recommend watching for status numbers of 2 to detect issues on the API (i.e. instead of watching for status numbers which are not 1)

Request

https://meta.ideal-postcodes.co.uk/status

Response

{
    "Ideal Postcodes Website": {
        "status": 1,
        "message": "Up"
    },
    "Ideal Postcodes API": {
        "status": 1,
        "message": "Up"
    },
    "Postcodes.io API": {
        "status": 1,
        "message": "Up"
    }
}
Property Description
"Ideal Postcodes Website" Object attribute which denotes a specific service.
"service.status" number Indicates the current state of the service
"service.message" string Human readable message that corresponds with the status number

Status Numbers

Status Description
0 Unitialised meta.ideal-postcodes.co.uk needs time (minute or so) to retrieve data from all probes. This status is rare and occurs in the event of a full cache eviction of probe statuses
1 Available Service is up
2 Down Service is down

Current Tracked Services

Service Description
"Ideal Postcodes Website" ideal-postcodes.co.uk
"Ideal Postcodes API" api.ideal-postcodes.co.uk
"Postcodes.io API" postcodes.io