API Reference · Instances
GET Live instance state
Query a live instance connection state from the provider.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Query a live instance connection state from the provider.
GET /api/v1/instances/{id}/state
| Nom | Type | Required | Description |
|---|---|---|---|
id | UUID | yes | ID de l’instance |
curl https://srv.msgflash.com/api/v1/instances/INSTANCE_ID/state \
-H "x-api-key: msgf_live_your_api_key_here"
200{
"data": {
"instanceId": "inst_uuid",
"status": "connected",
"providerState": "open"
}
}
| HTTP | Code | When |
|---|---|---|
404 | NOT_FOUND | Instance does not exist or is outside your account |