Listar políticas da plataforma

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

Lista as políticas de plataforma com escopo de projeto. O escopo do projeto é realizado pelo parâmetro route id path e a organização é derivada desse projeto.

parâmetros de caminho

id string Obrigatório

ID do Projeto

parâmetros de query

escopo string

Escopo da política (se fornecido, deve ser projeto)
PROJECT_ID string

ID do Projeto (se fornecido, deve corresponder ao projeto da rota)

Respostas

406

aplicação/json

aplicação/json aplicação/vnd.agent-engine-2026-09-20-preview+json

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

aplicação/vnd.agent-engine-2026-09-20-preview+json

aplicação/vnd.agent-engine-2026-09-20-preview+json aplicação/json

OK
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- políticas array[objeto]
  
  Ocultar atributos das políticas Mostrar atributos das políticas objeto
  
  created_at string
  
  created_by string
  
  habilitado booleano
  
  id string
  
  int_value inteiro
  
  org_id string
  
  PROJECT_ID string
  
  escopo string
  
  Os valores são org ou project.
  
  string_list array[string]
  
  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.
  
  updated_at string
  
  updated_by string
- Total inteiro
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- políticas array[objeto]
  
  Ocultar atributos das políticas Mostrar atributos das políticas objeto
  
  created_at string
  
  created_by string
  
  habilitado booleano
  
  id string
  
  int_value inteiro
  
  org_id string
  
  PROJECT_ID string
  
  escopo string
  
  Os valores são org ou project.
  
  string_list array[string]
  
  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.
  
  updated_at string
  
  updated_by string
- Total inteiro
400

aplicação/json

aplicação/json aplicação/vnd.agent-engine-2026-09-20-preview+json

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
403

aplicação/json

aplicação/json aplicação/vnd.agent-engine-2026-09-20-preview+json

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
500

aplicação/json

aplicação/json aplicação/vnd.agent-engine-2026-09-20-preview+json

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

curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/policies' \
 --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": [
    {
      "created_at": "string",
      "created_by": "string",
      "enabled": true,
      "id": "string",
      "int_value": 42,
      "org_id": "string",
      "project_id": "string",
      "scope": "org",
      "string_list": [
        "string"
      ],
      "type": "MAX_TOOL_CALLS_PER_EXECUTION",
      "updated_at": "string",
      "updated_by": "string"
    }
  ],
  "total": 42
}

Exemplos de resposta (200)

{
  "policies": [
    {
      "created_at": "string",
      "created_by": "string",
      "enabled": true,
      "id": "string",
      "int_value": 42,
      "org_id": "string",
      "project_id": "string",
      "scope": "org",
      "string_list": [
        "string"
      ],
      "type": "MAX_TOOL_CALLS_PER_EXECUTION",
      "updated_at": "string",
      "updated_by": "string"
    }
  ],
  "total": 42
}

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
}