Skip to main content
GET
Get the health of a BYOD line
  • Credential: an API key of the owner of the line. The operation serves BYOD lines only. See Health for the meaning of each field and of each null.
  • Line-scoped keys: a line-scoped key gets 403 forbidden unless the line is in its list.
  • Events: none. For the events about the connection of a line, see Connectivity events.
  • Other lines: for a rented, shared or test line, read GET /v1/attention.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Path Parameters

id
string
required

Id of a line: line_ followed by 25 letters or digits.

Pattern: ^line_[0-9A-Za-z]{25}$

Response

The health of the line.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

The health of a BYOD line, from the last reports of its device.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.