Criar ou atualizar segredo do workspace

COLOCAR /api/v1/projects/{id}/workspaces/{workspace_id}secrets/{name}

Valida o nome secreto e faz proxy da solicitação de upsert para o ECP com escopo para um espaço de trabalho. O escopo do projeto é realizado pelo parâmetro route id path e a organização é derivada desse projeto. Aceita uma sessão JWT ou uma chave de API com escopo de projeto, para que o CI/CD possa alimentar credenciais de construção de curta duração sem um login interativo; uma chave de API deve ter como escopo o projeto nomeado no caminho. O chamador precisa de direitos de gerenciamento de implantação nesse projeto (PROJECT_OWNER, AGENT_DEVELOPER, ORG_ADMIN em projetos nativos do Agent Engine ouSYSTEM_ADMIN).

parâmetros de caminho

  • id string Obrigatório

    ID do Projeto

  • workspace_id string Obrigatório

    ID do espaço de trabalho

  • name string Obrigatório

    Nome secreto (maiúsculas no estilo env-var)

aplicação/json

corpo, corpo Obrigatório

Valor secreto e descrição opcional

  • Descrição string
  • valor string
  • valor_unchanged booleano

    ValueUnchanged deve ser definido explicitamente por um chamador que edite apenas a descrição de um segredo existente; é o que permite que o Valor esteja vazio. Sem ele, um valor vazio é sempre rejeitado - um chamador que envia "" por erro (por exemplo, um bug de modelo ou uma varredura de ambiente desconfigurada) obtém um 400 limpo em vez de deixar silenciosamente o valor antigo no lugar.

Respostas

  • Versão de API não permitida ou malformada, uma operação indisponível no contrato publicado selecionado ou uma representação inaceitável (incluindo parâmetros de tipo de mídia não suportados ou SSE excluído). Falhas existentes de autenticação, autorização e limite de taxa têm precedência.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.

  • 200

    OK

  • Solicitação inválida

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • Proibido

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • Não encontrado

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • Entidade solicitante muito grande

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 429

    Muitas solicitações

    Ocultar atributo de cabeçalhos Mostrar atributo de cabeçalhos
    • Tentar novamente depois string

      Segundos para esperar antes de tentar novamente

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • Gateway incorreto

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 503

    Serviço indisponível

    Ocultar atributo de cabeçalhos Mostrar atributo de cabeçalhos
    • Tentar novamente depois string

      Segundos para esperar antes de tentar novamente

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
PUT /api/v1/projects/{id}/workspaces/{workspace_id}/secrets/{name}
curl \
 --request PUT 'https://agentengine.mongodb.com/api/v1/projects/{id}/workspaces/{workspace_id}/secrets/{name}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "description": "string",
  "value": "string",
  "value_unchanged": true
}'
Exemplos de solicitação
{
  "description": "string",
  "value": "string",
  "value_unchanged": true
}
Exemplos de resposta (406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Exemplos de resposta (406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Exemplos de resposta (200)
{}
Exemplos de resposta (200)
{}
Exemplos de resposta (400)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (400)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (403)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (403)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (404)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (404)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (413)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (413)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (429)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (429)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (502)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (502)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (503)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (503)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}