Skip to main content
GET
Get live instance status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Instance ID

Response

Instance status

status
enum<string>
required

Current instance status

Available options:
created,
starting,
scan_qr,
connected,
disconnected,
failed
instance_type
enum<string>
required

Instance type

Available options:
waha,
cloud_api