DOC-API-MODEL-schema-opqho625u2#overview
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.
Secret values are write-only through the project secret API: writes accept a value and return metadata, while read operations return metadata without the value. Resource references name a secret within their own scope rather than carrying its value or an alternate tenant or project.
Input constraints
Section ID: DOC-API-MODEL-schema-opqho625u2#input-constraints
name
Section ID: DOC-API-MODEL-schema-opqho625u2#name
The name must contain one through 63 characters. Its first character must be a lowercase ASCII letter or digit. Every remaining character must be a lowercase ASCII letter, digit, period, underscore, or hyphen.
Meaning and usage
Section ID: DOC-API-MODEL-schema-opqho625u2#meaning
See the definition above.
Input constraints
Section ID: DOC-API-MODEL-schema-opqho625u2#input-constraints-1
See the definition above.
name
Section ID: DOC-API-MODEL-schema-opqho625u2#name-1
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-opqho625u2#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-opqho625u2#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-opqho625u2#request-field-namename | string | Required in requests | Name identifying the secret within its project. Pattern: ^[a-z0-9][a-z0-9._-]{0,62}$. |
Request validation
Section ID: DOC-API-MODEL-schema-opqho625u2#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
Section ID: DOC-API-MODEL-schema-opqho625u2#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-opqho625u2#field-nameSection ID: DOC-API-MODEL-schema-opqho625u2#response-field-namename | string | Required in requests | Name identifying the secret within its project. |
DOC-API-MODEL-schema-opqho625u2#validation
Request validation
Section ID: DOC-API-MODEL-schema-opqho625u2#response-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
Section ID: DOC-API-MODEL-schema-opqho625u2#where-used
| Reference | Relationship |
|---|---|
| Register a custom MCP server | POST /api/v1/mcp-servers/create |
| Get a custom MCP server | POST /api/v1/mcp-servers/get |
| List custom MCP servers | POST /api/v1/mcp-servers/list |
| Update a custom MCP server | POST /api/v1/mcp-servers/update |
Models containing this value
| Model | Relationship |
|---|---|
| CustomMCPServer | Nested in model |
| CustomMCPServer | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-opqho625u2