Verify an API Key

Request

Make sure to include the x-api-key header with your API key in the request.

curl -X GET "https://status.example.com/api/v1/verify" -H "x-api-key: YOUR_API_KEY"

If the API key is valid and hasn't expired, the API will return a JSON response with a message indicating that the API key is valid.

{
	"error": false,
	"message": "API key is valid"
}

If there is a problem with the key, the API will return a JSON response with an error message.

{
	"error": true,
	"message": "API key not found"
}

The API will return a JSON response that can include the following values:

Prop

Type