v1

latestOpenAPI 3.0.02026-07-249372139.7 KB

Agents

Agent

Edits a deployed liongard agent, cannot update On-Demand agents.

put/agents/{AgentID}

Path parameters

AgentIDinteger required

ID of Agent

Request body

Namestring required

Descriptionstring

Example request

{
  "Name": "Agent 1",
  "Description": " agent description",
  "Environment": {
    "ID": 1234
  }
}

Response

IDinteger

UIDstring

Bucketstring

Namestring

Descriptionstring

Statusinteger

Hostnamestring

IPstring

JobQueuestring

Platformstring

Suspendedboolean

Managedboolean

LastHeartbeatstring

CreatedOnstring

UpdatedOnstring nullable

UpdatesCheckedOnstring nullable

Typestring

SAASboolean

Example response

[
  {
    "ID": 1511,
    "Environment": {
      "ID": 18701,
      "ServiceProviderID": 1,
      "Name": "Contoso Nation",
      "ShortName": "CN",
      "Description": "Example Description",
      "Status": 1,
      "Visible": true,
      "ExpiresOn": "2021-09-10T19:21:03.195Z",
      "KeyRotation": 90,
      "LastKeyRotation": "2021-09-10T19:21:03.195Z",
      "Website": "contoso.com",
      "CreatedOn": "2021-09-10T19:21:03.195Z",
      "UpdatedOn": "2021-09-10T19:21:03.195Z",
      "Tier": "Core"
    },
    "Data": {
      "PSVersion": "5.1.17763.1490",
      "AgentVersion": "2.0.2",
      "MaxJobsAllowed": 5,
      "AutoUpdatingStatus": "Enabled"
    },
    "UID": "07c4265fbd647d5b460324991df2f6c",
    "Bucket": "roar-payloads-52327fb",
    "Name": "Contoso Nation Agent",
    "Description": "Main Agent",
    "Status": 1,
    "Hostname": "CN-DC01",
    "IP": "72.33.231.92",
    "JobQueue": "https://sqs.us-west-2.amazonaws.com/414981065368/02f6c-down",
    "Platform": "windows",
    "LastHeartbeat": "2021-09-10T19:21:03.195Z",
    "CreatedOn": "2021-09-10T19:21:03.195Z",
    "UpdatedOn": "2021-09-10T19:21:03.195Z",
    "UpdatesCheckedOn": "2021-09-10T19:21:03.195Z",
    "Type": "customer-on-prem",
    "CreatedBy": {
      "ID": 1234,
      "FirstName": "Alex",
      "LastName": "Weber",
      "Username": "Alex.Weber"
    }
  }
]