API explorerConnectors
Mark a connector online and refresh its last-seen time
POST /api/agent/connectors/{id}/heartbeat. Required scopes: connectors:write.
Loading API reference…
Required scopes: connectors:write
POST
bearer connectors:writeheader
AuthorizationBearer <token>A Notify agent token from notify auth login or the dashboard.
Scope: connectors:write
id*stringapplication/json- body
tunnelId?stringMatch
^[a-z0-9]+$Length
1 <= length <= 64hostname?stringLength
1 <= length <= 253routes?array<>Items
items <= 32status?stringValue in
"online""offline""unknown"graceful?booleanSuccess
application/json- response
connector*curl -X POST 'https://example.com/api/agent/connectors/string/heartbeat' \ -H 'Content-Type: application/json' \ -d '{}'{ "connector": { "id": "string", "enabled": true, "name": "string", "tunnelId": "string", "hostname": "string", "routes": [ { "name": "string", "target": "string", "url": "string", "appId": "string", "enabled": true } ], "status": "online", "lastSeenAt": "2019-08-24T14:15:22Z", "teamId": "string", "oncallGroupId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}