---
title: "Upsert a secret"
method: POST
path: "/secret"
tags: ["secrets"]
---

# Upsert a secret

`POST /secret`

## Request

- Base URL: `https://api.faable.com`
- URL: `https://api.faable.com/secret`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://faable.auth.faable.link/authorize`, token URL `https://faable.auth.faable.link/oauth/token`)
  - HTTP bearer
  - OAuth 2 (client credentials, token URL `https://faable.auth.faable.link/oauth/token`)
  - HTTP bearer
  - HTTP basic
  - API key in query parameter `apikey`

Upsert a secret

## Request body

- SecretUpsert: Upsert Secret
  - `app_id` string, required
  - `name` string, required: Secret name
  - `value` string, required: Secret value

## Response `200`

Secret

- Secret: Secret
  - `id` string, required: Secret ID
  - `team` string, required
  - `app_id` string: Secret is linked to App
  - `profile_id` string: Secret is linked to App
  - `related` string, required: Secret is linked to App
  - `related_model` string, required
  - `name` string, required: Secret name
  - `value` string, required: Secret value
  - `metadata` object, required
  - `createdAt` string, required: Secret creation date
  - `updatedAt` string: Secret updated date

## Other responses

- `400`: `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.
- `401`: `unauthorized` — The request carries no valid credentials. `invalid_token` — The bearer token is missing, malformed or expired.
- `403`: `forbidden` — The credentials are valid but do not allow this operation. `user_suspended` — The account is suspended. Contact support@faable.com.
- `429`: `too_many_requests` — Rate limit exceeded. Honour the `Retry-After` header.
- `500`: `internal_error` — Unexpected server error. Retry later; the request id is logged.
- `503`: `database_unavailable` — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.

---

[API](https://skmtc.dev/faable/apis/faablecloud-api.md) · [All operations](https://skmtc.dev/faable/apis/faablecloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faable/apis/faablecloud-api/revisions/e2fc93da3c49?raw)