Skip to main content

Get a Monitor

The Get Monitor endpoint allows you to retrieve a specific Monitor in your Garmingo Status instance.

EndpointMethodURL
/monitors/{id}GEThttps://garmingo.com/api/status/v1/monitors/{id}

Query Parameters

ParameterTypeDescriptionRequiredDefaultMinimumMaximum

Response

The response is a JSON object with the following properties:

PropertyTypeDescription
successbooleanWhether the request was successful.
dataMonitorThe Monitor data.

Example

{
"success": true,
"data": {
"id": "5f4b3b3b-0b3b-4b3b-0b3b-4b3b0b3b0b3b",
"displayName": "My Monitor",
"ttl": 60,
"type": "http",
"region": "eu-central",
"enabled": true,
"retries": 3,
"keywords": ["my", "monitor"],
"metadata": {
"key": "value"
},
"settings": {
"url": "https://example.com",
"method": "GET",
"headers": {
"Authorization": "Bearer my-token"
},
"body": null
},
"lastCheck": "2021-01-01T00:00:00.000Z",
"proxyType": "socks5",
"proxyHost": "proxy.example.com",
"proxyPort": 8080,
"proxyUsername": "my-username",
"proxyPassword": "my-password",
"currentStatus": true
}
}