getConnection

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

Get a Connection in an Environment by its id.

Request

Path Parameters

environment stringrequired
id stringrequired

Responses

200

Connection

application/json

Schema

Schema

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/:id' \
-H 'Accept: application/json' \
-H 'api-key: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://host

Auth

api-key

Parameters

environment — pathrequired

id — pathrequired

ResponseClear

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