Liste as políticas de plataforma eficazes para um projeto

OBTER /api/v1/projects/{id}/policies/sensitive

Retorna cada tipo de política resolvido para o projeto: o valor efetivo mesclado, o valor próprio de cada escopo e qual(is) escopo(s) está(ão) em vigor. Os valores da organização são lidos no lado do servidor, portanto, o chamador precisa apenas de acesso de leitura ao projeto .

parâmetros de caminho

  • id string Obrigatório

    ID do Projeto

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

    Ocultar atributo de resposta Mostrar atributo de resposta objeto
    • políticas array[objeto]
      Ocultar atributos das políticas Mostrar atributos das políticas objeto
      • eficaz_int_value inteiro
      • eficaz_string_list array[string]

        A lista de permissões forçada. Uma array vazia significa que nada é permitido, o que acontece quando as listas de organizações e projeto são separadas; nulo significa que nenhuma lista de permissões é imposta. Os dois não devem entrar em conflito um com o outro.

      • habilitado booleano
      • Organização objeto
        Ocultar atributos da organização Mostrar atributos da organização objeto
        • habilitado booleano
        • int_value inteiro
        • string_list array[string]
      • projeto, projeto objeto
        Ocultar atributos do projeto Mostrar atributos do projeto objeto
        • habilitado booleano
        • id string
        • int_value inteiro
        • string_list array[string]
      • Fonte string

        organização | projeto | ambos | none

      • type string

        Os valores são MAX_TOOL_CALLS_PER_EXECUTION, MAX_LLM_CALLS_PER_EXECUTION, MAX_EXECUTION_DURATION_MS, MAX_TOKENS_PER_EXECUTION, MAX_TOKENS_PER_SESSION, AUTHORIZED_TOOLS ou AUTHORIZED_MODELS.

    Ocultar atributo de resposta Mostrar atributo de resposta objeto
    • políticas array[objeto]
      Ocultar atributos das políticas Mostrar atributos das políticas objeto
      • eficaz_int_value inteiro
      • eficaz_string_list array[string]

        A lista de permissões forçada. Uma array vazia significa que nada é permitido, o que acontece quando as listas de organizações e projeto são separadas; nulo significa que nenhuma lista de permissões é imposta. Os dois não devem entrar em conflito um com o outro.

      • habilitado booleano
      • Organização objeto
        Ocultar atributos da organização Mostrar atributos da organização objeto
        • habilitado booleano
        • int_value inteiro
        • string_list array[string]
      • projeto, projeto objeto
        Ocultar atributos do projeto Mostrar atributos do projeto objeto
        • habilitado booleano
        • id string
        • int_value inteiro
        • string_list array[string]
      • Fonte string

        organização | projeto | ambos | none

      • type string

        Os valores são MAX_TOOL_CALLS_PER_EXECUTION, MAX_LLM_CALLS_PER_EXECUTION, MAX_EXECUTION_DURATION_MS, MAX_TOKENS_PER_EXECUTION, MAX_TOKENS_PER_SESSION, AUTHORIZED_TOOLS ou AUTHORIZED_MODELS.

  • 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
  • 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
GET /api/v1/projects/{id}/policies/quality
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/policies/effective' \
 --header "Authorization: $API_KEY"
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)
{
  "policies": [
    {
      "effective_int_value": 42,
      "effective_string_list": [
        "string"
      ],
      "enabled": true,
      "organization": {
        "enabled": true,
        "int_value": 42,
        "string_list": [
          "string"
        ]
      },
      "project": {
        "enabled": true,
        "id": "string",
        "int_value": 42,
        "string_list": [
          "string"
        ]
      },
      "source": "string",
      "type": "MAX_TOOL_CALLS_PER_EXECUTION"
    }
  ]
}
Exemplos de resposta (200)
{
  "policies": [
    {
      "effective_int_value": 42,
      "effective_string_list": [
        "string"
      ],
      "enabled": true,
      "organization": {
        "enabled": true,
        "int_value": 42,
        "string_list": [
          "string"
        ]
      },
      "project": {
        "enabled": true,
        "id": "string",
        "int_value": 42,
        "string_list": [
          "string"
        ]
      },
      "source": "string",
      "type": "MAX_TOOL_CALLS_PER_EXECUTION"
    }
  ]
}
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 (500)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500)
{
  "code": "string",
  "error": "string",
  "success": true
}