Cria ou troca um segredo
PUT/api/vault/secrets/{name}
- Auth
- Token erforderlich
- Wer darf:
- owner
- admin
- API-Schlüssel:
- Kein API-Schlüssel möglich
- X-CommunityId
X-CommunityIdSende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.
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).
Parameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
namePflicht | path | string |
Header
| Name | Typ | Beschreibung |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request-Body application/json
| Name | Typ | Beschreibung |
|---|---|---|
valueoptional | string | max 4096 |
allowedHostsoptional | string[] |
Antworten
| Status | Beschreibung |
|---|---|
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. |
curl-Beispiel
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 '{}'