remote-nodes

Test remote node connection

Changed on

Tests connectivity to a remote node by making a health check request

post/remote-nodes/{remoteNodeId}/test-connection

Request

  • Base URL
    http://localhost/api/v1
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or none

Path parameters

remoteNodeIdstring required

The unique identifier of the remote node

Query parameters

remoteNodestring

name of the remote node

Response

Connection test result

successboolean required
messagestring
errorstring

Changes

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new human_task_resume_failed enum value to the response property for the response status

    • warning

      added the new payload_too_large enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status