Cria ou troca um segredo
PUT/api/vault/secrets/{name}
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- Chiave API:
- Non accetta chiavi API
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
Só owner e admin. `name` em maiúsculas (`[A-Z][A-Z0-9_]{0,63}`). `value` (até 4.096) entra uma vez e **não volta**; mandar de novo troca na hora. `allowedHosts` (até 20) limita para onde o segredo pode ir (vazio: qualquer host que o nó HTTP aceita); sem `value`, só troca os hosts de um segredo que já existe. Antes do primeiro segredo, alguém da equipe aceita o aviso de dados pessoais (`POST /api/vault/data-notice`), senão 422 `vault.dataNoticeRequired`. Criar, trocar e mudar hosts entram na auditoria (só o nome e os 4 últimos).
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
nameobbligatorio | path | string |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
valuefacoltativo | string | max 4096 |
allowedHostsfacoltativo | string[] |
Risposte
| Codice | Descrizione |
|---|---|
200 | O segredo (sem o valor). |
403 | Autenticado, mas sem permissão para esta operação. |
409 | Corrida com outro cadastro do mesmo nome (`vault.nameTaken`). |
422 | Nome, valor ou hosts inválidos, ou falta o aceite do aviso de dados. |
Esempio con curl
curl -X PUT "https://api.memberfy.net/api/vault/secrets/<name>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'