Skip to main content

getConnection

GET 

/v1/environment/:environment/connections/:id

Get a Connection in an Environment by its id.

Request

Path Parameters

    environment stringrequired
    id stringrequired

Responses

Connection

Schema

    idstringrequired
    namestringrequired
    stateConnectionState (string)required

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

    versionstringrequired
    startTimestringrequired
    agentIdstringrequired
    environmentstringrequired

    tags

    object[]

  • Array [

  • idstringrequired
    typestringrequired
    valuestringrequired
  • ]

  • labelsstring[]nullable

    identifier metadata for a connection