getAgents

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

A list of all Agents for an Environment.

Request

Path Parameters

environment stringrequired

Responses

200

A list of all Agents for an Environment.

application/json

Schema

Schema

• Array [
idstringrequired
namestringrequired
stateAgentState (string)required

Possible values: [Active, Archived, Disabled]

versionstringrequired
processorVersionstringrequired
agentCodebaseVersionstringrequired
environmentstringrequired
creatorstring
tags object[]
Array [
idstringrequired
typestringrequired
valuestringrequired
]
versionHistory object[]
Array [
agentVersionstringrequired
authorstring
processorstringrequired
configurationstringrequired
coreAgentVersionstringrequired
createdAtdate-timerequired
messagestringrequired
requireFullUpdateboolean
]
• ]

Example (auto)

[
  {
    "id": "string",
    "name": "string",
    "state": "Active",
    "version": "string",
    "processorVersion": "string",
    "agentCodebaseVersion": "string",
    "environment": "string",
    "creator": "string",
    "tags": [
      {
        "id": "string",
        "type": "string",
        "value": "string"
      }
    ],
    "versionHistory": [
      {
        "agentVersion": "string",
        "author": "string",
        "processor": "string",
        "configuration": "string",
        "coreAgentVersion": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "message": "string",
        "requireFullUpdate": true
      }
    ]
  }
]

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/agents");
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

ResponseClear

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