Service Status

This is the GraphQL query to run to return a simple boolean of whether Maildrop is functioning or not.

There are multiple services that report their status; this method is provided as a convenience to see if Maildrop is completely functional or not. Most users should never need to run this query.

Returns the status of Maildrop as a string.

POST https://api.maildrop.cc/graphql

Checks the current status of the various services in the Maildrop architecture and returns either "operational" or an error string.

Results are cached for up to a minute.

Headers

Name	Type	Description
Content-Type	String	application/json

Request Body

Name	Type	Description
	String	'{ query: "query Example { status }" }'

200: OK

{
    "data": {
        "status": "operational"
    }
}

Examples

curl

curl --request POST \
    --header 'content-type: application/json' \
    --url https://api.maildrop.cc/graphql \
    --data '{"query":"query Example {\n  status\n}"}'

returns:

{"data":{"status":"operational"}}

React

export const GET_STATUS = gql`
    query GetStatus {
        status
    }
}`;

interface QueryReturn {
    status: string;
}

const MyComponent = () => {
    const [{ loading, error, data }] = useQuery<QueryReturn>(GET_STATUS);
    return (
        <div>
            {loading && <div>Loading...</div>}
            {!loading && error && <div>There was an error.</div>}
            {!loading && data?.status && <div>Status: {data.status}</div>}            
        </div>
    );
};