List the head and the agents that send heartbeats
Lists every instance that sends heartbeats, with a status and the problems found for each. The head that answers comes first, then the rest with critical problems first. An instance silent for over 3 minutes shows checkingIn false. A 503 means the app runs without its database.
session<token>Session cookie authentication.
Request fulfilled, document follows
application/json- response
Every instance that sends heartbeats.
checkedAt*stringThe database time when GeoMetrikks built this list. It measures each heartbeat's age from it to set checkingIn and the problems.
date-timehead*The head that answered the request.
instances*array<>curl -X GET 'https://geometrikks.example.com/api/v1/instances'{ "checkedAt": "2019-08-24T14:15:22Z", "head": { "appVersion": "string", "instanceName": "string", "schemaRevision": "string" }, "instances": [ { "appVersion": "string", "bootId": "string", "checkingIn": true, "health": { "advisories": [ { "detail": "string", "docsUrl": "string", "id": "string", "remedy": "string", "severity": "warning", "summary": "string" } ], "crowdsec": { "enabled": true, "lapiReachable": true }, "database": { "reachable": true, "servicesActive": true }, "geoip": { "asnAvailable": false, "asnDbBuildDate": "string", "available": true, "dbBuildDate": "string" }, "ingestion": { "failedBatches": 0, "failedRecords": 0, "lastRecordAt": "string", "missingFiles": [ "string" ], "parsedLines": 0, "pendingRecords": 0, "publishDropped": 0, "running": true, "status": "running", "unavailableSources": [ { "kind": "string", "label": "string", "reason": "string" } ] }, "mode": "full", "schemaWait": "string", "startedAt": "string", "status": "healthy", "timestamp": "string" }, "instanceName": "string", "isSelf": true, "lastSeen": "2019-08-24T14:15:22Z", "mode": "string", "payload": { "failed5M": 0, "failedBatches5M": 0, "health": { "property1": null, "property2": null }, "instanceNameSource": "fallback", "jobs": [ { "id": "", "lastError": "string", "lastStart": "2019-08-24T14:15:22Z", "lastStatus": "string", "name": "", "nextRunTime": "2019-08-24T14:15:22Z" } ], "lastError": { "at": "2019-08-24T14:15:22Z", "message": "" }, "lines5M": 0, "nameConflictAt": "2019-08-24T14:15:22Z", "recentStarts": [ "2019-08-24T14:15:22Z" ], "serverNames": [ "string" ], "sources": [ { "available": true, "kind": "", "label": "", "lastParsedAt": "2019-08-24T14:15:22Z", "lastReadAt": "2019-08-24T14:15:22Z", "logFormat": "string", "parsedLines": 0, "reason": "string", "serverName": "" } ], "written5M": 0 }, "problems": [ { "detail": "string", "docsUrl": "string", "id": "string", "remedy": "string", "severity": "warning", "summary": "string" } ], "schemaRevision": "string", "serverLocations": [ { "detectedAt": "2019-08-24T14:15:22Z", "latitude": 0, "longitude": 0, "server": "string", "source": "string" } ], "startedAt": "2019-08-24T14:15:22Z", "status": "ok" } ]}List the busiest IPs at one location GET
Returns the client IPs with the most events at the location in the range, most first. The items carry no `location`. An unknown `location_id` gets an empty list.
Remove a retired instance from the list DELETE
Removes the instance from the list. An instance that is still running reappears at its next heartbeat, and the head that answers cannot remove itself. Needs a Read/write API key or a browser session.