Claves SSH

Nota

Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, su ID del grupo sigue siendo el mismo. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El punto final permanece como se indica en el documento.

El sshKeys recurso muestra las llaves públicas disponibles para elegir al aprovisionar servidores a través de la integración de Cloud Manager con un proveedor de servicios en la nube. Cuando aprovisiones un nuevo servidor, Cloud Manager añade la llave pública a la lista de claves autorizadas del servidor. Debes tener la llave 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, consulta Provisionar servidores.

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

Extremos

Obtener 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

Borrar una clave SSH

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

Entidad de muestra

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

Campos de la entidad

Nombre	Tipo	Descripción
ID	string	Unique identifier.
Nombre	string	El nombre de la llave pública tal como aparece en Cloud Manager Provisioning Settings. Para obtener más información sobre el provisionamineto, consulte Servidores de provisionamineto.
publicKey	string	El contenido de la clave pública.

Enlaces

Relación	Descripción
sí mismo	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}

Respuesta del cuerpo

{
  "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}

Respuesta del cuerpo

{
  "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" : []
}

Borrar 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 endpoint no devuelve un cuerpo de respuesta.