Vincula el proyecto Atlas del emisor para la sincronización de salida.

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

Vincula un proyecto a un proyecto de Atlas para la sincronización de salida. Requiere el rol de propietario del proyecto. Cuando la plataforma exige la prueba de acceso a Atlas (opción predeterminada), la solicitud debe incluir un encabezado X-Atlas-Service-Account-Token cuya cuenta de servicio pueda leer el proyecto de Atlas, y este debe pertenecer a la organización Atlas de la organización. La respuesta solo informa el estado de sincronización; se omiten la topología del clúster de Atlas (hosts/direcciones IP) y los errores de sincronización sin procesar.

Encabezados

Token de cuenta de servicio de X-Atlas string

Token de acceso a la cuenta de servicio de Atlas de corta duración utilizado como prueba de acceso de grupo (nunca el secreto del cliente SA); requerido cuando la plataforma exige la prueba de acceso de Atlas, que es la predeterminada.

Parámetros de path

ID string Requerido

ID del proyecto

application/json

Cuerpo Requerido

Enlace al proyecto Atlas

entorno string
project_id string

Respuestas

406

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

Versión de API no compatible o con formato incorrecto, operación no disponible en el contrato publicado seleccionado o representación inaceptable (incluidos parámetros de tipo de medio no compatibles o SSE excluidos). Los fallos de autenticación, autorización y límite de velocidad existentes tienen prioridad.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Campos con errores de validación.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Un campo y su fallo de validación.
  
  Descripción string Requerido
  
  Fallo en la validación legible para humanos.
  
  Campo string Requerido
  
  Nombre o ruta del campo de solicitud no válido.
- detalle string Requerido
  
  Detalles de errores legibles para humanos.
- Error entero Requerido
  
  HTTP status code.
- errorCode string Requerido
  
  Código de error legible por máquina.
- Parámetros array[string]
  
  Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.
- motivo string Requerido
  
  Frase que indica el motivo del estado HTTP.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Campos con errores de validación.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Un campo y su fallo de validación.
  
  Descripción string Requerido
  
  Fallo en la validación legible para humanos.
  
  Campo string Requerido
  
  Nombre o ruta del campo de solicitud no válido.
- detalle string Requerido
  
  Detalles de errores legibles para humanos.
- Error entero Requerido
  
  HTTP status code.
- errorCode string Requerido
  
  Código de error legible por máquina.
- Parámetros array[string]
  
  Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.
- motivo string Requerido
  
  Frase que indica el motivo del estado HTTP.
200

aplicación/vnd.agent-engine-2026-09-20-preview+json

aplicación/vnd.agent-engine-2026-09-20-preview+json application/json

OK
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- proyecto atlas Objeto
  
  Ocultar atributos de atlas_project Mostrar atributos de atlas_project Objeto
  
  entorno string
  
  project_id string
- sincronización de salida Objeto
  
  Ocultar atributos de egress_sync Mostrar atributos de sincronización de salida Objeto
  
  recuento_de_clúster entero
  
  Número de clústeres en la última instantánea almacenada correctamente. Cero significa que Atlas no devolvió ninguno (a menudo estaba en pausa o vacío). Las respuestas de atlas-link para clientes incluyen este recuento y omiten los hosts/direcciones IP de los clústeres.
  
  Clústeres arreglo[objeto]
  
  Ocultar atributos de clústeres Mostrar los atributos de los clústeres Objeto
  
  host array[string]
  
  Nombre string
  
  Direcciones IP públicas4 array[string]
  
  tipo string
  
  uniqueId string
  
  clústeres_diferentes booleano
  
  último_éxito_en string
  
  última_sincronización_en string
  
  live_clusters arreglo[objeto]
  
  Ocultar atributos de live_clusters Mostrar atributos de live_clusters Objeto
  
  host array[string]
  
  Nombre string
  
  Direcciones IP públicas4 array[string]
  
  tipo string
  
  uniqueId string
  
  error_de_obtención_en_vivo string
  
  error_de_sincronización string
  
  sync_status string
- Nombre string
- org_id string
- project_id string
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- proyecto atlas Objeto
  
  Ocultar atributos de atlas_project Mostrar atributos de atlas_project Objeto
  
  entorno string
  
  project_id string
- sincronización de salida Objeto
  
  Ocultar atributos de egress_sync Mostrar atributos de sincronización de salida Objeto
  
  recuento_de_clúster entero
  
  Número de clústeres en la última instantánea almacenada correctamente. Cero significa que Atlas no devolvió ninguno (a menudo estaba en pausa o vacío). Las respuestas de atlas-link para clientes incluyen este recuento y omiten los hosts/direcciones IP de los clústeres.
  
  Clústeres arreglo[objeto]
  
  Ocultar atributos de clústeres Mostrar los atributos de los clústeres Objeto
  
  host array[string]
  
  Nombre string
  
  Direcciones IP públicas4 array[string]
  
  tipo string
  
  uniqueId string
  
  clústeres_diferentes booleano
  
  último_éxito_en string
  
  última_sincronización_en string
  
  live_clusters arreglo[objeto]
  
  Ocultar atributos de live_clusters Mostrar atributos de live_clusters Objeto
  
  host array[string]
  
  Nombre string
  
  Direcciones IP públicas4 array[string]
  
  tipo string
  
  uniqueId string
  
  error_de_obtención_en_vivo string
  
  error_de_sincronización string
  
  sync_status string
- Nombre string
- org_id string
- project_id string
400

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

Solicitud incorrecta
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
403

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

Forbidden
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
404

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

No encontrado
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
500

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

Error interno del servidor
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
502

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

Puerta de enlace incorrecta
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano

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

curl \
 --request PUT 'https://agentengine.mongodb.com/api/v1/projects/{id}/atlas-link' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "X-Atlas-Service-Account-Token: string" \
 --data '{
  "environment": "string",
  "project_id": "string"
}'

Solicitar ejemplos

# Headers
X-Atlas-Service-Account-Token: string

# Payload
{
  "environment": "string",
  "project_id": "string"
}

Ejemplos de respuesta (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"
}

Ejemplos de respuesta (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"
}

Ejemplos de respuesta (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"
}

Ejemplos de respuesta (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"
}

Ejemplos de respuesta (400)

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

Ejemplos de respuesta (400)

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

Ejemplos de respuesta (403)

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

Ejemplos de respuesta (403)

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

Ejemplos de respuesta (404)

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

Ejemplos de respuesta (404)

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

Ejemplos de respuesta (500)

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

Ejemplos de respuesta (500)

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

Ejemplos de respuesta (502)

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

Ejemplos de respuesta (502)

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