v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB

Agents

Get agent details

Retrieves details for a specific agent

get/v1/agents/{agentId}

Path parameters

agentIdstring required

The ID of the agent to retrieve

Response

Success

agentIdstring

The ID of the Agent

agentStatusstring

The reported status of the Agent

agentTypestring

The type of Agent

cloudProviderstring

The cloud provider the Agent is hosted in

connectedboolean

Whether the Agent is connected

deploymentstring

The deployment type of the Agent

descriptionstring

The description set for the Agent

enableAutoUpdatesboolean

Whether the Agent is set to automatically update

namestring

The name of the Agent

pausedUntilstring

The date and time the Agent will be unpaused automatically. Only returned if the Agent is currently paused

restrictedAccessboolean

Whether the Agent is restricted to a specific set of projects

Example response

{
  "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "agentStatus": "running",
  "agentType": "data_productivity_cloud",
  "cloudProvider": "aws",
  "connected": true,
  "deployment": "fargate",
  "description": "An AWS Agent",
  "enableAutoUpdates": true,
  "name": "AWS Agent",
  "pausedUntil": "2025-01-01T00:00:00.000Z",
  "restrictedAccess": true,
  "versionDetails": {
    "agentVersion": "1.0.0",
    "support": "SUPPORTED",
    "trackName": "current",
    "trackReleaseDate": "2025-01-01T00:00:00.000Z",
    "trackVersion": "1.0.0"
  }
}