getHarness

GET

/api/v1/agents/{agentId}/harness

The agent's harness. With connect=true the harness is started (waking the agent) to discover login methods.

getHarness

curl --request GET \
  --url '<base-url>/api/v1/agents/<agentId>/harness' \
  --cookie 'agenthold_session=<agenthold_session>'

const url = '<base-url>/api/v1/agents/<agentId>/harness';
const options = {
  method: 'GET',
  headers: {cookie: 'agenthold_session=<agenthold_session>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "harness": "string",
  "connected": true,
  "agentName": "string",
  "agentVersion": "string",
  "loadSession": true,
  "authMethods": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "type": "string"
    }
  ]
}

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

agentId
string
required

Query parameters

connect
optional
boolean

Returns

200

Harness state.

JSON

harness
string
required
connected
boolean
required
agentName
string
required
agentVersion
string
required
loadSession
boolean
required
authMethods
array of
object
required
- id
  string
  required
- name
  string
  required
- description
  string
  required
- type
  string
  required
  "terminal": run it in the agent terminal (terminal?auth=<id>).
}

404

Error.

JSON

error
string
required

409

Error.

JSON

error
string
required