getAgent

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

Get an Agent in an Environment by its id.

Request

Path Parameters

environment stringrequired
id stringrequired

Responses

200

Agent

application/json

Schema

Schema

id stringrequired
name stringrequired
state AgentState (string)required

Possible values: [Active, Archived, Disabled]

version stringrequired
processorVersion stringrequired
environment stringrequired
creator string

tags

object[]

Array [

id stringrequired

type stringrequired

value stringrequired

]

Example (from schema)

{
  "id": "string",
  "name": "string",
  "state": "Active",
  "version": "string",
  "processorVersion": "string",
  "environment": "string",
  "creator": "string",
  "tags": [
    {
      "id": "string",
      "type": "string",
      "value": "string"
    }
  ]
}

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

• CURL

curl -L 'https://host/v1/environment/:environment/agents/: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!