The StatusDashboard admin API supports the following authentication methods:
| Session Authentication | If you are already authenticated in the Statusdashboard portal in a web browser, you can access the API using your existing authenticated session. This is useful for exploring the different API endpoints via your web browser. | ||||
| ApiKey Authentication |
Provide your StatusDashboard user account's API key in an HTTP Authorization header on each API request. The format of the authorization header is as follows:
|
Examples
Curl
curl --header "Authorization:ApiKey testuser:256ee09ded99b29036fac4de96acedb7e8af7bf7" https://www.statusdashboard.com/api/v1/service/
Windows PowerShell
Invoke-restmethod -Headers @{'Authorization:ApiKey' = 'testuser:256ee09ded99b29036fac4de96acedb7e8af7bf7'} -uri https://www.statusdashboard.com/api/v1/service/ -SkipHeaderValidation
Note: PowerShell utilizes strict header checking by default and does not allow certain characters in the header name/value. StatusDashboard uses certain header characters that cause Powershell validation to fail by default so the -SkipHeaderValidation flag must be used.