Properties

Property

Type

Description

Example

agent_connection_subnets_enabled_count

integer

Number of subnets enabled for the connection.

2

agent_connection_group_updated_at

string formatted as
(ISO 8601 date and time)

Date and time of last update of the connection.

"2022-06-20T15:49:43.080Z"

agent_connection_group_status_reason

string

A brief reason of the current status.

"Connection status for connections with virtual agents is not supported."

agent_connection_group_status

string

Current status of the connection. Possible statuses: Pending, Connected, Warning, Error

"PENDING"

agent_connection_group_sdn_enabled

boolean

Indicates if the SDN was enabled for the connection.

true

agent_connection_group_id

integer

Unique identifier for the connection.

1230

agent_connection_group_created_by

string

The way the connection was created.

"API"

agent_2

agent object

Second agent that the connection is established to.

{
        "agent_is_online": true,
        "agent_status": "OK",
        "agent_subnets_count": 0,
        "agent_is_virtual": true,
        "agent_name": "string",
        "agent_public_ipv4": "string",
        "agent_id": 0,
        "agent_provider_id": 0
      }

agent_1

agent object

First agent that the connection is established from.

{
        "agent_is_online": true,
        "agent_status": "OK",
        "agent_subnets_count": 0,
        "agent_is_virtual": true,
        "agent_name": "string",
        "agent_public_ipv4": "string",
        "agent_id": 0,
        "agent_provider_id": 0
      }

Example

{
      "agent_connection_subnets_enabled_count": 4,
      "agent_connection_group_updated_at": "2022-06-20T15:49:43.080Z",
      "agent_connection_group_status_reason": "Connection status for connections with virtual agents is not supported.",
      "agent_connection_group_status": "PENDING",
      "agent_connection_group_sdn_enabled": true,
      "agent_connection_group_id": 1230,
      "agent_connection_group_created_by": "API",
      "agent_2": {
        "agent_is_online": true,
        "agent_status": "OK",
        "agent_subnets_count": 0,
        "agent_is_virtual": true,
        "agent_name": "string",
        "agent_public_ipv4": "string",
        "agent_id": 0,
        "agent_provider_id": 0
      },
      "agent_1": {
        "agent_is_online": true,
        "agent_status": "OK",
        "agent_subnets_count": 0,
        "agent_is_virtual": true,
        "agent_name": "string",
        "agent_public_ipv4": "string",
        "agent_id": 0,
        "agent_provider_id": 0
      }
    }