What this page covers: the fastest path from an API token to a working call, so you can confirm your setup works before building anything real.

The Redgate Monitor REST API is available in Monitor Enterprise.

Base URL

Every v2 request starts with:

https://your-host/api/v2

Replace your-host with your Monitor installation's hostname. The v2 segment is the whole versioning scheme. There's no separate version header or query parameter.

Make a request

Monitored servers is a good first call. It needs no parameters and returns something meaningful straight away.

curl https://your-host/api/v2/monitored-servers \
  -H "Authorization: Bearer $TOKEN"

If your token's valid and has the Read permission, you will get a 200 with a list of servers:

{
  "status": "success",
  "data": [
    {
      "entityId": "r1,4:base,s36:4bba3b44-...-f53c4315efe3,7:Cluster,1,4:Name,s15:dev-prod,",
      "name": "PROD-SQL-01",
      "alias": "Production SQL Server",
      "entityType": "SqlServer",
      "group": "Production",
      "status": "Monitoring",
      "tags": ["production", "finance"],
      "parentEntityId": null
    }
  ]
}

If your token has no matching servers, or your filters match nothing, the call still succeeds. You just get an empty data array:

{
  "status": "success",
  "data": []
}

Read the response

Every v2 response uses the same envelope: a status field, plus data on success. See Understanding the response for the full shape, including what changes on errors.

If something goes wrong

Certificate errors

If your Monitor web server uses a self-signed certificate, curl will fail with a certificate error before it reaches the API. The right fix is to install a proper certificate on the Monitor server. If that isn't possible, you can tell curl to skip verification with curl -k (insecure mode). However, this is less secure and you should avoid it in production.

Explore the API interactively

Everything in this API also has a live, interactive reference at https://your-host/api-docs. It's generated straight from the OpenAPI spec, so it's always exactly in sync with what's shipped, and because every v2 endpoint so far is read-only (GET only), it's safe to send a request from it without worrying about side effects.

Use it when you already roughly know what you want and need to confirm an exact shape (a parameter's allowed values, a field you're not sure is nullable) or see a working example payload and response. Come back to these pages when you're still building your mental model of how the API fits together, or want a multi-call worked example. That's what this site is for.

Next steps

• Understanding the response for the full response shape.