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

    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

Loading...