getConnections

GET 
https://host/v1/environment/:environment/connections

A list of all Connections for an Environment.

Request

Path Parameters

environment stringrequired

Query Parameters

agentId string

Responses

200

A list of all Connections for an Environment.

application/json

Schema

Schema

• Array [

id stringrequired
name stringrequired
state ConnectionState (string)required

Possible values: [Live, Updating, Disconnected, Shutdown, Deprecated]

version stringrequired
startTime stringrequired
agentId stringrequired
environment stringrequired

tags

object[]

Array [

id stringrequired

type stringrequired

value stringrequired

]

labels string[]nullable

identifier metadata for a connection

• ]

Example (from schema)

[
  {
    "id": "string",
    "name": "string",
    "state": "Live",
    "version": "string",
    "startTime": "string",
    "agentId": "string",
    "environment": "string",
    "tags": [
      {
        "id": "string",
        "type": "string",
        "value": "string"
      }
    ],
    "labels": [
      "string"
    ]
  }
]

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://host/v1/environment/:environment/connections' \
-H 'Accept: application/json' \
-H 'api-key: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://host

Auth

api-key

Parameters

environment — pathrequired

agentId — query

ResponseClear

Click the Send API Request button above and see the response here!