Docs Menu
Docs Home
Docs Home
Docs Home

Claves SSH

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.

El recurso sshKeys muestra las claves públicas disponibles al aprovisionar servidores mediante la integración de Cloud Manager con un proveedor de servicios en la nube. Al aprovisionar un nuevo servidor, Cloud Manager añade la clave pública a la lista de claves autorizadas del servidor. Debe tener la clave privada correspondiente para iniciar sesión en el servidor aprovisionado.

Para obtener más información sobre la integración de Cloud Manager con proveedores de servicios en la nube, consulte Servidores de aprovisionamiento.

URL base: https://cloud.mongodb.com/api/public/v1.0

Puntos finales

Obtenga todas las claves SSH para el proyecto

GET /groups/{PROJECT-ID}/sshKeys

Obtener una clave SSH por ID

GET /groups/{PROJECT-ID}/sshKeys/KEY-ID

Obtener una clave SSH por nombre

GET /groups/{PROJECT-ID}/sshKeys/byName/KEY-NAME

Agregar una clave SSH

POST /groups/{PROJECT-ID}/sshKeys

Eliminar una clave SSH

DELETE /groups/{PROJECT-ID}/sshKeys/KEY-ID

Entidad de muestra

{
  "id" : "545e3e3ae4b08a04fbc21005",
  "name" : "myKey",
  "publicKey" : "<ssh-key>",
  "links" : []
}

Campos de entidad

Nombre
Tipo
Descripción

ID.

string

Unique identifier.

Nombre

string

El nombre de la clave pública tal como aparece en Cloud Manager Provisioning SettingsPara obtener más información sobre el aprovisionamiento, consulte Aprovisionamiento de servidores.

publicKey

string

El contenido de la clave pública.

Enlaces

Relación
Descripción

yo

Me

http://mms.mongodb.com/group

El proyecto al que pertenece la clave SSH

Ejemplos

Obtener todas las llaves SSH

Solicitud

curl -u "username:apiKey" --digest -i "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/sshKeys"

Respuesta

Encabezado de respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Cuerpo de respuesta

{
  "totalCount" : 1,
  "results" : [ {
    "id" : "545e3e3ae4b08a04fbc21005",
    "name" : "myKey",
    "publicKey" : "<ssh-key>",
    "links" : []
  }, { ...} ],
  "links" : []
}

Obtener una clave SSH por ID

Solicitud

curl -u "username:apiKey" --digest -i "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/sshKeys/545e3e3ae4b08a04fbc21005"

Respuesta

Encabezado de respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Cuerpo de respuesta

{
  "id" : "545e3e3ae4b08a04fbc21005",
  "name" : "myKey",
  "publicKey" : "<ssh-key>",
  "links" : []
}

Agregar una clave SSH

Solicitud

curl -u "username:apiKey" --digest -i -H "Content-Type: application/json" -X POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/sshKeys" --data '
{
  "name" : "myKey",
  "publicKey" : "<ssh-key>"
}'

Respuesta

HTTP/1.1 201 Created
{
  "id" : "54c7a8bee4b0b5a9451be44e",
  "name" : "myKey",
  "publicKey" : "<ssh-key>",
  "links" : []
}

Eliminar una clave SSH

Solicitud

curl -u "username:apiKey" --digest -i -X DELETE "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/sshKeys/545e3e3ae4b08a04fbc21005"

Respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Este punto final no devuelve un cuerpo de respuesta.

En esta página