Obter o link do projeto Atlas do chamador

OBTER /api/v1/projects/{id}/atlas-link

Retorna o link de saída do Atlas do projeto e o status de sincronização. Requer uma função de leitura do projeto . A topologia do cluster (hosts/IPs) é omitida — somente o status. egress_sync.cluster_count é o número de clusters no último snapshot armazenado bem-sucedido (0 significa que o Atlas não retornou nenhum - geralmente pausado, sem servidor ou um projeto vazio).

parâmetros de caminho

id string Obrigatório

ID do Projeto

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
- atlas_project objeto
  
  Ocultar atributos atlas_project Mostrar atributos atlas_project objeto
  
  ambiente string
  
  PROJECT_ID string
- egress_sync objeto
  
  Ocultar atributos egress_sync Mostrar atributos egress_sync objeto
  
  cluster_count inteiro
  
  Número de clusters no último snapshot armazenado bem-sucedido. Zero significa que o Atlas não retornou nenhum (geralmente pausado ou vazio). As respostas do atlas-link do cliente incluem essa contagem e omitem hosts/IPs de cluster.
  
  clusters array[objeto]
  
  Ocultar atributos dos clusters Mostrar atributos dos clusters objeto
  
  hosts array[string]
  
  name string
  
  publicIpv4Addresses array[string]
  
  type string
  
  uniqueId string
  
  clusters_differ booleano
  
  last_success_at string
  
  last_sync_at string
  
  live_clusters array[objeto]
  
  Ocultar atributos live_clusters Mostrar atributos live_clusters objeto
  
  hosts array[string]
  
  name string
  
  publicIpv4Addresses array[string]
  
  type string
  
  uniqueId string
  
  live_fetch_error string
  
  sync_error string
  
  sync_status string
- name string
- org_id string
- PROJECT_ID string
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- atlas_project objeto
  
  Ocultar atributos atlas_project Mostrar atributos atlas_project objeto
  
  ambiente string
  
  PROJECT_ID string
- egress_sync objeto
  
  Ocultar atributos egress_sync Mostrar atributos egress_sync objeto
  
  cluster_count inteiro
  
  Número de clusters no último snapshot armazenado bem-sucedido. Zero significa que o Atlas não retornou nenhum (geralmente pausado ou vazio). As respostas do atlas-link do cliente incluem essa contagem e omitem hosts/IPs de cluster.
  
  clusters array[objeto]
  
  Ocultar atributos dos clusters Mostrar atributos dos clusters objeto
  
  hosts array[string]
  
  name string
  
  publicIpv4Addresses array[string]
  
  type string
  
  uniqueId string
  
  clusters_differ booleano
  
  last_success_at string
  
  last_sync_at string
  
  live_clusters array[objeto]
  
  Ocultar atributos live_clusters Mostrar atributos live_clusters objeto
  
  hosts array[string]
  
  name string
  
  publicIpv4Addresses array[string]
  
  type string
  
  uniqueId string
  
  live_fetch_error string
  
  sync_error string
  
  sync_status string
- name string
- org_id string
- PROJECT_ID string
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
404

aplicação/json

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

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
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}/atlas-link

curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/atlas-link' \
 --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)

{
  "atlas_project": {
    "environment": "string",
    "project_id": "string"
  },
  "egress_sync": {
    "cluster_count": 42,
    "clusters": [
      {
        "hosts": [
          "string"
        ],
        "name": "string",
        "publicIpv4Addresses": [
          "string"
        ],
        "type": "string",
        "uniqueId": "string"
      }
    ],
    "clusters_differ": true,
    "last_success_at": "string",
    "last_sync_at": "string",
    "live_clusters": [
      {
        "hosts": [
          "string"
        ],
        "name": "string",
        "publicIpv4Addresses": [
          "string"
        ],
        "type": "string",
        "uniqueId": "string"
      }
    ],
    "live_fetch_error": "string",
    "sync_error": "string",
    "sync_status": "string"
  },
  "name": "string",
  "org_id": "string",
  "project_id": "string"
}

Exemplos de resposta (200)

{
  "atlas_project": {
    "environment": "string",
    "project_id": "string"
  },
  "egress_sync": {
    "cluster_count": 42,
    "clusters": [
      {
        "hosts": [
          "string"
        ],
        "name": "string",
        "publicIpv4Addresses": [
          "string"
        ],
        "type": "string",
        "uniqueId": "string"
      }
    ],
    "clusters_differ": true,
    "last_success_at": "string",
    "last_sync_at": "string",
    "live_clusters": [
      {
        "hosts": [
          "string"
        ],
        "name": "string",
        "publicIpv4Addresses": [
          "string"
        ],
        "type": "string",
        "uniqueId": "string"
      }
    ],
    "live_fetch_error": "string",
    "sync_error": "string",
    "sync_status": "string"
  },
  "name": "string",
  "org_id": "string",
  "project_id": "string"
}

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 (500)

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

Exemplos de resposta (500)

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