# Get a secret ## `GET /v1/projects/{projectId}/secrets/{secretName}` Returns a specific secret by name. The secret value is always masked. ### Path parameters - `projectId` (integer, required): The ID of the project - `secretName` (string, required): The name of the secret ### Header parameters - `Authorization` (string, required): `Bearer `. [Authentication](https://spice.ai/docs/cloud/api/management#authentication) lists the tokens it accepts. - `X-Org-Name` (string, optional): The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but `GET /v1/orgs` (400 `org_assertion_required` otherwise). Pattern: `^[A-Za-z0-9._-]{1,255}$`. ### Example request ```bash curl "https://api.spice.ai/v1/projects//secrets/" \ -H "Authorization: Bearer " ``` ```http GET /v1/projects//secrets/ HTTP/1.1 Host: api.spice.ai Authorization: Bearer ``` ### Responses **200 OK** Secret details (value is masked) Content type: `application/json` - `id` (integer): Unique identifier for the secret - `name` (string): Name of the secret - `value` (string): Always masked with asterisks - `created_at` (string (date-time)): Timestamp when the secret was created - `updated_at` (string (date-time)): Timestamp when the secret was last updated **400 Bad Request** Invalid project ID **401 Unauthorized** Unauthorized **403 Forbidden** Insufficient scope or admin or owner role required **404 Not Found** Project or secret not found **500 Internal Server Error** Internal server error ## `GET /v1/orgs/{orgId}/projects/{projectId}/secrets/{secretName}` The org is `orgId` in the path. Returns a specific secret by name. The secret value is always masked. ### Path parameters - `orgId` (integer, required): The org id from GET /v1/orgs. Minimum: `1`. - `projectId` (integer, required): The ID of the project - `secretName` (string, required): The name of the secret ### Header parameters - `Authorization` (string, required): `Bearer `. [Authentication](https://spice.ai/docs/cloud/api/management#authentication) lists the tokens it accepts. - `X-Org-Name` (string, optional): When present, X-Org-Name must name the same org as orgId. Otherwise the request returns org\_path\_mismatch (400). Pattern: `^[A-Za-z0-9._-]{1,255}$`. ### Example request ```bash curl "https://api.spice.ai/v1/orgs//projects//secrets/" \ -H "Authorization: Bearer " ``` ```http GET /v1/orgs//projects//secrets/ HTTP/1.1 Host: api.spice.ai Authorization: Bearer ``` ### Responses **200 OK** Secret details (value is masked) Content type: `application/json` - `id` (integer): Unique identifier for the secret - `name` (string): Name of the secret - `value` (string): Always masked with asterisks - `created_at` (string (date-time)): Timestamp when the secret was created - `updated_at` (string (date-time)): Timestamp when the secret was last updated **400 Bad Request** Invalid project ID. orgId is not a valid org id (`invalid_org_id`), or X-Org-Name does not name that org (`org_path_mismatch`). **401 Unauthorized** Unauthorized **403 Forbidden** Insufficient scope or admin or owner role required. The caller is not a member of the org (`org_forbidden`). A machine credential named a different org (`org_assertion_mismatch`). The org is deleted (`org_deleted`). **404 Not Found** Project or secret not found **500 Internal Server Error** Internal server error ## `GET /v1/apps/{appId}/secrets/{secretName}` (deprecated) Legacy alias of `/v1/projects/{projectId}/secrets/{secretName}` — projects were previously called apps. Returns a specific secret by name. The secret value is always masked. ### Path parameters - `appId` (integer, required): The ID of the project - `secretName` (string, required): The name of the secret ### Header parameters - `Authorization` (string, required): `Bearer `. [Authentication](https://spice.ai/docs/cloud/api/management#authentication) lists the tokens it accepts. - `X-Org-Name` (string, optional): The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but `GET /v1/orgs` (400 `org_assertion_required` otherwise). Pattern: `^[A-Za-z0-9._-]{1,255}$`. ### Example request ```bash curl "https://api.spice.ai/v1/apps//secrets/" \ -H "Authorization: Bearer " ``` ```http GET /v1/apps//secrets/ HTTP/1.1 Host: api.spice.ai Authorization: Bearer ``` ### Responses **200 OK** Secret details (value is masked) Content type: `application/json` - `id` (integer): Unique identifier for the secret - `name` (string): Name of the secret - `value` (string): Always masked with asterisks - `created_at` (string (date-time)): Timestamp when the secret was created - `updated_at` (string (date-time)): Timestamp when the secret was last updated **400 Bad Request** Invalid project ID **401 Unauthorized** Unauthorized **403 Forbidden** Insufficient scope or admin or owner role required **404 Not Found** Project or secret not found **500 Internal Server Error** Internal server error OpenAPI: [api.spice.ai/openapi.json](https://api.spice.ai/openapi.json)