Restart agent handler

Required scope: agents:admin

POST /api/v1/agents/{agent_name}/restart

cURL

curl --request POST \
  --url 'https://api.nsr.stateset.com/api/v1/agents/{agent_name}/restart' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "action": "string",
  "name": "Two-Person Tent",
  "running": true,
  "status": "pending"
}

Required scope: agents:admin

Path parameters

agent_name · string · required

Agent name

Response

AgentActionResponse

action · string · required

name · string · required

running · boolean · required

status · string · required

Status codes

Code	Meaning
200	Agent restarted
401	Unauthorized — missing or invalid credentials
403	Forbidden — the key/token lacks the required scope
404	Agent not found
429	Rate limited — see Retry-After / X-RateLimit-Reset

cURL

curl --request POST \
  --url 'https://api.nsr.stateset.com/api/v1/agents/{agent_name}/restart' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "action": "string",
  "name": "Two-Person Tent",
  "running": true,
  "status": "pending"
}