Pular para o conteúdo principal

Secrets

Os valores que um workflow do agente referencia como ${{secrets.KEY}}. Seis ferramentas.

O valor é somente escrita. Nenhuma ferramenta o devolve — nem para o cliente que acabou de gravá-lo. Se a pessoa for precisar da credencial em outro lugar, mostre-a antes de guardar.

Veja o modelo Secret.


secrets_list​

Leitura · escopo inbox/secrets · permissão secrets.list · GET /secrets

Lista os secrets do workspace. A resposta traz apenas key, notes, last_used_at e timestamps.

ParâmetroTipoDescrição
cursorstringCursor opaco de uma página anterior.
limitintegerTamanho da página, padrão 25, máximo 100.
sortstringChaves de ordenação, prefixo - para decrescente.
keystringFiltra pela chave.

secrets_get​

Leitura · escopo inbox/secrets · permissão secrets.show · GET /secrets/{id}

Busca um secret pelo id. O valor não faz parte da resposta.

ParâmetroTipoDescrição
id obrigatóriostring (uuid)Id do secret.

secrets_create​

Escrita · escopo inbox/secrets + write · permissão secrets.create · POST /secrets

Guarda um novo secret. key duplicada no workspace é recusada com 409 conflict.

ParâmetroTipoDescrição
key obrigatóriostringLetras maiúsculas, dígitos e underscores, começando por letra — o que um passo escreve dentro de ${{secrets.KEY}}.
value obrigatóriostringGuardado criptografado; nunca devolvido.
notesstring | nullPara que serve o valor.
idempotency_keystringProteção contra reenvio.

secrets_upsert​

Escrita · escopo inbox/secrets + write · permissão secrets.create · PUT /secrets

Cria o secret, ou substitui o valor do existente com a mesma key. O caminho da rotação: sem buscar o id antes.

ParâmetroTipoDescrição
key obrigatóriostringChave de busca do upsert.
value obrigatóriostringSubstitui o valor guardado.
notesstring | null
idempotency_keystringProteção contra reenvio.

secrets_update​

Escrita · escopo inbox/secrets + write · permissão secrets.update · PATCH /secrets/{id}

Substitui o valor de um secret ou suas notas. key é imutável — os workflows a referenciam pelo nome, então renomeá-la os quebraria silenciosamente.

ParâmetroTipoDescrição
id obrigatóriostring (uuid)Id do secret.
valuestringNovo valor.
notesstring | null

secrets_delete​

Escrita · escopo inbox/secrets + write · permissão secrets.delete · DELETE /secrets/{id}

Faz o soft delete de um secret. A partir da próxima execução, qualquer passo que referencie a chave falha com secret not defined, antes de a requisição ser enviada.

ParâmetroTipoDescrição
id obrigatóriostring (uuid)Id do secret.