Update secret
PUT
/v1/servers/{serverId}/secrets/{secretId}How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| serverId | path | string | Yes | Resource ID |
| secretId | path | string | Yes | Secret document ID or name |
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | No | Human-readable name. |
| value | string | No | Optional replacement value. Omit to keep the existing encrypted value. |
| description | string | No | Human-readable description. |
| metadata | object | No | Free-form metadata object. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Secret updatedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| serverId | string | No | Resource ID. |
| secret | object | No | — |
| secret.id | string | No | Unique identifier. |
| secret.name | string | No | Human-readable name. |
| secret.description | string | No | Human-readable description. |
| secret.maskedValue | string | No | — |
| secret.metadata | object | No | Free-form metadata object. |
| secret.createdAt | string | No | ISO 8601 timestamp. |
| secret.updatedAt | string | No | ISO 8601 timestamp. |
| secret.lastAccessedAt | string | No | — |
| secrets | object[] | No | — |
| secrets[].id | string | No | Unique identifier. |
| secrets[].name | string | No | Human-readable name. |
| secrets[].description | string | No | Human-readable description. |
| secrets[].maskedValue | string | No | — |
| secrets[].metadata | object | No | Free-form metadata object. |
| secrets[].createdAt | string | No | ISO 8601 timestamp. |
| secrets[].updatedAt | string | No | ISO 8601 timestamp. |
| secrets[].lastAccessedAt | string | No | — |