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

idstringrequired
namestringrequired
stateConnectionState (string)required

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

versionstringrequired
startTimestringrequired
agentIdstringrequired
environmentstringrequired
agentCodebaseVersionstringrequired
agentVersionstringrequired
tags object[]
Array [
idstringrequired
typestringrequired
valuestringrequired
]
labelsstring[]nullable

identifier metadata for a connection

Example (auto)

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

Authorization: Authorization

name: Authorizationtype: httpscheme: bearerbearerFormat: JWTdescription: Enter JWT tokenin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://host/v1/environment/:environment/connections/:id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <Authorization>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://host

Auth

Security Scheme

BearerAuthapi-key

Bearer Token

Parameters

environment — pathrequired

id — pathrequired

ResponseClear

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