List agents awaiting enrollment

GET 
/api/agent/pending

List all agents that have submitted enrollment requests but have not yet been accepted or rejected.

Responses

200

List of pending agents.

application/json

Schema

Schema

agents

object[]

required

Array [

machine_id stringrequired

The permanent machine identifier.

hostname stringrequired

The hostname of the agent.

fingerprint stringrequired

The SHA256 fingerprint of the agent's public key.

requested_at date-timerequired

When the enrollment request was received.

]

total integerrequired

Total number of pending agents.

Example (from schema)

{
  "agents": [
    {
      "machine_id": "string",
      "hostname": "string",
      "fingerprint": "string",
      "requested_at": "2024-07-29T15:51:28.071Z"
    }
  ],
  "total": 0
}

401

Unauthorized - API key required

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

500

Error listing pending agents.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

Loading...