v56

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01142337440.5 KB
WorkspaceSecretService
Workspace Secrets

Update a workspace secret

Updates a workspace secret in the workspace

patch/v1/workspaces/{workspaceId}/workspace_secrets/{id}

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

The workspace the secret belongs to.

idstring required
Example:wsecret_01HXKD2E5NQM3T9AYWCF586W5A

The secret to update.

Request body

workspaceIdstring

The workspace the secret belongs to.

idstring

The secret to update.

updateMaskstring field-mask

Fields to update.

Example request

{
  "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
  "id": "wsecret_01HXKD2E5NQM3T9AYWCF586W5A"
}

Response

OK

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "info": {
    "createdBy": {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    }
  }
}