Software Secure Workload
Activity Configure

Get Status

This endpoint returns the current status of the Secure Connector Tunnel for the specified root scope.

GET /openapi/v1/secureconnector/name/{ROOT_SCOPE_NAME}/status

GET /openapi/v1/secureconnector/{ROOT_SCOPE_ID}/status

READ permission to the specified root scope is required.

The returned status is a json object with the following schema:

Key

Type

Value

active

boolean

A Secure Connector tunnel is currently active

peer

string

<ip>:<port> of the Secure Connector client end of the tunnel

start_time

int

Timestamp at which the tunnel was started (epoch time in seconds)

last_heartbeat

int

Timestamp of last heartbeat from the client (epoch time in seconds)