COLOCAR /api/v1/projects/{id}
Autenticação do portador

Atualize o nome, descrição ou configurações de um projeto existente.

parâmetros de caminho

  • id string Obrigatório

    ID do Projeto

aplicação/json

corpo, corpo Obrigatório

Campos a serem atualizados

  • allow_member_invites booleano
  • Descrição string
  • name string

    O nome é cortado antes da validação. Deve ter 1-64 caracteres e pode conter letras/números Unicode, espaços e os caracteres - _ . ( ) , & @ + '.

    O comprimento mínimo é 1, o comprimento máximo é 64.

  • política de compartilhamento objeto
    Ocultar atributos de shared_policy Mostrar atributos de shared_policy objeto
    • permitido_sources array[string]
    • shared_modes array[string]
    • compartilhável booleano

Respostas

  • 406

    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

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • allow_member_invites booleano
    • atlas objeto
      Ocultar atributos do atlas Mostrar atributos do atlas objeto
      • ambiente string Obrigatório
      • id string Obrigatório
      • organizations_id string Obrigatório
    • can_manage_deployments booleano
    • created_at string
    • Descrição string
    • id string
    • name string
    • org_id string
    • política de compartilhamento objeto
      Ocultar atributos de shared_policy Mostrar atributos de shared_policy objeto
      • permitido_sources array[string]
      • shared_modes array[string]
      • compartilhável booleano
    • Fonte string

      Os valores são atlas ou agent_engine.

    • updated_at string
    • workspace_count inteiro

      WorkspaceCount é o número de espaços de trabalho não excluídos no projeto. Incluído nas respostas da lista e omitido no GET de projeto único.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • allow_member_invites booleano
    • atlas objeto
      Ocultar atributos do atlas Mostrar atributos do atlas objeto
      • ambiente string Obrigatório
      • id string Obrigatório
      • organizations_id string Obrigatório
    • can_manage_deployments booleano
    • created_at string
    • Descrição string
    • id string
    • name string
    • org_id string
    • política de compartilhamento objeto
      Ocultar atributos de shared_policy Mostrar atributos de shared_policy objeto
      • permitido_sources array[string]
      • shared_modes array[string]
      • compartilhável booleano
    • Fonte string

      Os valores são atlas ou agent_engine.

    • updated_at string
    • workspace_count inteiro

      WorkspaceCount é o número de espaços de trabalho não excluídos no projeto. Incluído nas respostas da lista e omitido no GET de projeto único.
  • 400

    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
  • 404

    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
  • 409

    Conflito

    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
  • 500

    Erro interno do servidor

    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} 
curl \
 --request PUT 'https://agentengine.mongodb.com/api/v1/projects/{id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "allow_member_invites": true,
  "description": "string",
  "name": "string",
  "sharing_policy": {
    "allowed_sources": [
      "string"
    ],
    "share_modes": [
      "string"
    ],
    "shareable": true
  }
}'
Exemplos de solicitação 
{
  "allow_member_invites": true,
  "description": "string",
  "name": "string",
  "sharing_policy": {
    "allowed_sources": [
      "string"
    ],
    "share_modes": [
      "string"
    ],
    "shareable": 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) 
{
  "allow_member_invites": true,
  "atlas": {
    "environment": "string",
    "id": "string",
    "organization_id": "string"
  },
  "can_manage_deployments": true,
  "created_at": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "org_id": "string",
  "sharing_policy": {
    "allowed_sources": [
      "string"
    ],
    "share_modes": [
      "string"
    ],
    "shareable": true
  },
  "source": "atlas",
  "updated_at": "string",
  "workspace_count": 42
}
Exemplos de resposta (200) 
{
  "allow_member_invites": true,
  "atlas": {
    "environment": "string",
    "id": "string",
    "organization_id": "string"
  },
  "can_manage_deployments": true,
  "created_at": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "org_id": "string",
  "sharing_policy": {
    "allowed_sources": [
      "string"
    ],
    "share_modes": [
      "string"
    ],
    "shareable": true
  },
  "source": "atlas",
  "updated_at": "string",
  "workspace_count": 42
}
Exemplos de resposta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (400) 
{
  "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 (409) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (409) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}