Connection State

GET 
/api/v2/instance/:instanceId/connection-state

Check your connection status.

Request

Path Parameters

instanceId stringrequired

ID of the instance.

Responses

200

InstanceConnectionStateResponse

application/json

Schema

Schema

state stringrequired

Default value: open | connecting | close | refused

statusReason numberrequired

Example (from schema)

{
  "state": "open | connecting | close | refused",
  "statusReason": 0
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...