Skip to main content

RemotePairingStatus

Phone-pairing status shown in the dashboard's Devices & pairing.

stateRemotePairingState (string)required

Current phone-pairing state.

Possible values: [not_set_up, registering, connecting, connected, relay_unreachable, revoked, managed_elsewhere]

registrationAvailableRegistrationavailable (boolean)required

Whether this node can register a relay route: registration is turned on, the node is online, and a relay is configured.

registrationBlockedReason object

Why this node cannot register a relay route, when it cannot.

anyOf
RegistrationBlockedReason (string)

Possible values: [disabled, offline, not_configured]

lastFailure object

Stable code of the last failed registration since phone pairing was last turned on or off.

anyOf
RelayRegistrationFailure (string)

Possible values: [disabled, offline, not_configured, invalid_request, already_registered, rate_limited, registration_paused, capacity_exhausted, registration_unsupported, relay_busy, unreachable, invalid_response]

retryAfterSeconds object

Seconds the relay asked to wait before registering again.

anyOf
integer
managedOnNodeId object

Node that holds the cluster's relay route, when it is another node.

anyOf
string
managedOnNodeName object

Friendly name of that node, when known.

anyOf
string
relayHost object

Host of the relay this node uses, or would register with.

anyOf
string
RemotePairingStatus
{
"state": "not_set_up",
"registrationAvailable": true,
"registrationBlockedReason": "disabled",
"lastFailure": "disabled",
"retryAfterSeconds": 0,
"managedOnNodeId": "string",
"managedOnNodeName": "string",
"relayHost": "string"
}