Listar predefinições de fornecedor de rastreamento

OBTER /api/v1/projects/{id}/trace-export/presets
Autenticação do portador

Retorna o catálogo de predefinições ocultas do fornecedor que orienta a interface do usuário de configurações (modelo de endpoint, protocolo, campos de cabeçalho não secretos obrigatórios, link de documentos). Não contém segredos. O escopo do projeto é suportado pelo parâmetro de caminho de ID de rota.

parâmetros de caminho

  • id string Obrigatório

    ID do Projeto

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 atributo de resposta Mostrar atributo de resposta objeto
    • presets array[objeto]
      Ocultar atributos de predefinidos Mostrar atributos de predefinidos objeto
      • exibição_name string
      • docs_url string
      • endpoint_template string
      • cabeçalhos objeto

        Os cabeçalhos são os campos NON-SECRET que um cliente preenche para esse destino (por exemplo, um ID de espaço de trabalho). Mapa de chaves para nomes de cabeçalho; os valores são espaços reservados.

        Ocultar atributo de cabeçalhos Mostrar atributo de cabeçalhos objeto
        • * string Propriedades adicionais
      • id string
      • protocolo string
      • resource_attributes objeto

        ResourceAttributes nomeia o(s) atributo(s) de recurso OTLP que esse destino exige (por exemplo, um identificador de projeto ), como chaves de espaço reservado com valores vazios. Ao contrário dos cabeçalhos, esses atributos estão contidos nos próprios dados de extensão, não em uma linha de cabeçalho HTTP; um cliente sempre fornece o valor, pois normalmente ele nomeia um projeto no próprio lado do destino.

        Ocultar atributo resource_attributes Mostrar atributo resource_attributes objeto
        • * string Propriedades adicionais
      • secret_header_keys array[string]

        SecretHeaderKeys nomeia o(s) cabeçalho(s) fornecido(s) via headers_secret_ref. Eles nunca são armazenados in-line.

    Ocultar atributo de resposta Mostrar atributo de resposta objeto
    • presets array[objeto]
      Ocultar atributos de predefinidos Mostrar atributos de predefinidos objeto
      • exibição_name string
      • docs_url string
      • endpoint_template string
      • cabeçalhos objeto

        Os cabeçalhos são os campos NON-SECRET que um cliente preenche para esse destino (por exemplo, um ID de espaço de trabalho). Mapa de chaves para nomes de cabeçalho; os valores são espaços reservados.

        Ocultar atributo de cabeçalhos Mostrar atributo de cabeçalhos objeto
        • * string Propriedades adicionais
      • id string
      • protocolo string
      • resource_attributes objeto

        ResourceAttributes nomeia o(s) atributo(s) de recurso OTLP que esse destino exige (por exemplo, um identificador de projeto ), como chaves de espaço reservado com valores vazios. Ao contrário dos cabeçalhos, esses atributos estão contidos nos próprios dados de extensão, não em uma linha de cabeçalho HTTP; um cliente sempre fornece o valor, pois normalmente ele nomeia um projeto no próprio lado do destino.

        Ocultar atributo resource_attributes Mostrar atributo resource_attributes objeto
        • * string Propriedades adicionais
      • secret_header_keys array[string]

        SecretHeaderKeys nomeia o(s) cabeçalho(s) fornecido(s) via headers_secret_ref. Eles nunca são armazenados in-line.
  • 401

    Credenciais ausentes ou inválidas

    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

    O chamador não tem permissão de leitura

    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}/trace-export/presets 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/trace-export/presets' \
 --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) 
{
  "presets": [
    {
      "display_name": "string",
      "docs_url": "string",
      "endpoint_template": "string",
      "headers": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "id": "string",
      "protocol": "string",
      "resource_attributes": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "secret_header_keys": [
        "string"
      ]
    }
  ]
}
Exemplos de resposta (200) 
{
  "presets": [
    {
      "display_name": "string",
      "docs_url": "string",
      "endpoint_template": "string",
      "headers": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "id": "string",
      "protocol": "string",
      "resource_attributes": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "secret_header_keys": [
        "string"
      ]
    }
  ]
}
Exemplos de resposta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (401) 
{
  "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
}