SecretRef
Reference to a secret within the same tenant and project as the resource that uses it. Cross-project and cross-tenant secret references are not supported.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
name | string | Required in requests | Name identifying the secret within its project. Pattern: ^[a-z0-9][a-z0-9._-]{0,62}$. |
Request validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
name | Pattern | ^[a-z0-9][a-z0-9._-]{0,62}$ |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
name | string | Required in requests | Name identifying the secret within its project. |
Request validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
name | Pattern | ^[a-z0-9][a-z0-9._-]{0,62}$ |
Where used
| Reference | Relationship |
|---|---|
| Register a custom MCP server | POST /api/v1/mcp-servers/create |
| Update a custom MCP server | POST /api/v1/mcp-servers/update |
| Get a custom MCP server | POST /api/v1/mcp-servers/get |
| List custom MCP servers | POST /api/v1/mcp-servers/list |
| CustomMCPServer | Nested in model |
| CustomMCPServer | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-secret-ref.