> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Update Agent
> Update an agent's display name, description, metadata, or status
# Update Agent
`PATCH /v1/agents/{agentID}`
Updates mutable fields on an existing machine agent identity. Only the fields provided in the request body are modified; all other fields remain unchanged. At least one field must be provided.
To change an agent's scopes, use the delegation system or re-register the
agent. Scopes cannot be modified directly through this endpoint to preserve
the audit trail of scope changes.
### Authentication
Requires `X-API-Key` header or Bearer JWT token. Tenant-scoped via `X-Tenant-ID`.
### Path Parameters
The MAIP agent identifier (e.g., `maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH`).
### Request Body
All fields are optional, but at least one must be provided.
Updated human-readable name. Maximum 256 characters.
Updated description. Maximum 2048 characters.
Replacement metadata object. Replaces the entire metadata field (not a merge).
Maximum 16 KB serialized.
Update the agent's lifecycle status. One of: `"active"`, `"suspended"`. Use
the dedicated [suspend](/api-reference/machine-identity/agents/suspend) or
[revoke](/api-reference/machine-identity/agents/revoke) endpoints for status
changes that require a reason for audit compliance.
### Response
Returns the full updated agent identity object.
Internal UUID primary key.
MAIP-compliant agent identifier.
The updated display name.
The updated description.
The updated metadata object.
Current lifecycle status after update.
ISO 8601 timestamp reflecting the update.
### Example
```bash theme={null}
curl -X PATCH https://api.truthlocks.com/v1/agents/maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH \
-H "X-API-Key: tl_live_..." \
-H "Content-Type: application/json" \
-d '{
"display_name": "Customer Support Bot v2",
"description": "Upgraded to handle Tier-1 and Tier-2 support with escalation",
"metadata": {
"team": "support",
"model": "claude-opus-4",
"environment": "production",
"version": "2.0"
}
}'
```
## OpenAPI
````yaml mint-openapi.yaml PATCH /v1/agents/{agentId}
openapi: 3.0.3
info:
title: Truthlocks API
description: >
Truthlocks is a universal verification infrastructure for documents,
credentials, and digital assets.
This specification defines the canonical API for interacting with Truthlocks
services.
## Base URLs
- **Production**: `https://api.truthlocks.com`
- **Sandbox**: `https://sandbox-api.truthlocks.com`
## Authentication
- **API Keys**: Use `X-API-Key` header for machine-to-machine operations
- **Bearer Tokens**: Use `Authorization: Bearer ` for user-initiated
operations
## Tenant Identity
In production, tenant identity is derived from the authenticated context
(API key or JWT).
The `X-Tenant-ID` header is ignored in production to prevent spoofing.
version: 1.0.0
contact:
name: Truthlocks Support
url: https://truthlocks.com/support
email: support@truthlocks.com
servers:
- url: https://api.truthlocks.com
description: Production API
- url: https://sandbox-api.truthlocks.com
description: Sandbox Environment
security:
- APIKey: []
tags:
- name: Authentication
description: API key and token management
- name: Issuers
description: Issuer registration and trust management
- name: Keys
description: Cryptographic key management for issuers
- name: Attestations
description: Attestation lifecycle (mint, revoke, supersede)
- name: Verification
description: Attestation verification and proof bundles
- name: Governance
description: Issuer governance workflows (admin only)
- name: Identity
description: Organization, user, and role management
- name: Audit
description: Audit event queries
- name: Platform
description: Platform administration (super admin only)
- name: Platform Review
description: Staff review workflows for issuer applications
- name: Tenant Console
description: Tenant profile and lifecycle endpoints
- name: Health
description: Service health and readiness endpoints
- name: Risk
description: Risk signal ingestion and fraud detection
- name: Risk Enforcement
description: Risk enforcement actions — block, challenge, quarantine, and configuration
- name: Billing
description: Billing, subscription, and addon management
- name: Machine Identity
description: >-
Machine Agent Identity Protocol (MAIP) — agent registration, sessions,
trust, witness, compliance, orchestration, and observability
externalDocs:
description: Transparency read-only API (separate service spec)
url: >-
https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
/v1/agents/{agentId}:
patch:
tags:
- Machine Identity
summary: Update Agent
description: Update mutable fields on an existing agent identity.
operationId: maip.agents.update
parameters:
- name: agentId
in: path
required: true
schema:
type: string
format: uuid
description: Agent identifier
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
display_name:
type: string
maxLength: 256
description:
type: string
scopes:
type: array
items:
type: string
metadata:
type: object
additionalProperties: true
responses:
'200':
description: Agent updated
content:
application/json:
schema:
$ref: '#/components/schemas/MaipAgent'
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'404':
description: Agent not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
security:
- APIKey: []
components:
schemas:
MaipAgent:
type: object
properties:
id:
type: string
format: uuid
agent_type:
type: string
enum:
- orchestrator
- worker
- inference
- pipeline
- service
- bot
- llm
display_name:
type: string
maxLength: 256
description:
type: string
status:
type: string
enum:
- active
- suspended
- revoked
scopes:
type: array
items:
type: string
metadata:
type: object
additionalProperties: true
trust_score:
type: number
format: float
minimum: 0
maximum: 1
public_key:
type: string
description: Base64-encoded public key
session_count:
type: integer
keys:
type: array
items:
type: object
properties:
kid:
type: string
algorithm:
type: string
public_key:
type: string
status:
type: string
enum:
- active
- disabled
- expired
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
ErrorEnvelope:
type: object
required:
- code
- message
- http_status
properties:
code:
type: string
description: Machine-readable error code
enum:
- AUTH_REQUIRED
- AUTH_INVALID
- PERMISSION_DENIED
- TENANT_IDENTITY_UNVERIFIED
- NOT_FOUND
- VALIDATION_ERROR
- CONFLICT
- PAYLOAD_TOO_LARGE
- RATE_LIMIT_EXCEEDED
- QUOTA_EXCEEDED
- SERVICE_UNAVAILABLE
- INTERNAL_ERROR
message:
type: string
description: Human-readable error message
http_status:
type: integer
description: HTTP status code
retry_after_ms:
type: integer
description: Milliseconds to wait before retrying (for rate limits)
details:
type: object
description: Additional error context
example:
code: AUTH_REQUIRED
message: Authentication required
http_status: 401
securitySchemes:
APIKey:
type: apiKey
in: header
name: X-API-Key
description: API key for machine-to-machine authentication
````