Agents

Update Agent

Partially update an agent's properties.

patch/agents/{agent_id}

Request

Base URL
http://localhost:8000/api/v1
Auth
- HTTP bearer
- or API key in header Authorization
TypeScript
https://skmtc.dev/deeptrail/apis/deepsecure-api-dual-service-architecture/docs/agents/:agent_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

agent_idstring required

The unique agent identifier

Request body

namestring

descriptionstring

status'active' | 'inactive' | 'revoked'

Response

Agent updated successfully

agent_idstring

namestring

descriptionstring

public_keystring base64

status'active' | 'inactive' | 'revoked'

created_atstring date-time

updated_atstring date-time

last_seen_atstring date-time nullable

Example response

{
  "agent_id": "agent-ebd9cd4a-1234-5678-90ab-cdef01234567",
  "name": "MyAwesomeAgent",
  "description": "Agent for processing order data",
  "public_key": "AAAAC3NzaC1lZDI1NTE5AAAAIDAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
  "status": "active"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.