SecretMetadata
SecretMetadata is the only thing read APIs return. No message in this file carries a secret value out of the service.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
name | string | Optional | Name identifying the secret within its project. |
projectId | string | Optional | Identifier of the project within the tenant that scopes this record. "default" until Projects ships. |
description | string | Optional | Human-readable explanation of the secret. |
labels | Map from string to string | Optional | Free-form labels used to organize and identify secrets. Free-form, e.g. {"kind": "mcp-auth"}. |
version | string (int64) | Optional | Version number of the stored secret metadata. Increments on every PutSecret. Pattern: ^-?\d+$. |
createdBy | string | Optional | Subject identifier recorded for the creator of this record. Subject from the X-User-ID header, when present. |
createdAt | string (date-time) | Optional | Time this record was created. |
updatedAt | string (date-time) | Optional | Time this record was most recently updated. |
Where used
| Reference | Relationship |
|---|---|
| Get a secret's metadata | POST /api/v1/secrets/get-metadata |
| List secrets | POST /api/v1/secrets/list |
| Create or update a secret | POST /api/v1/secrets/put |
Download the public reference contract.
Document: DOC-API-MODEL-secret-metadata.