Menu
Amazon Lightsail
REST API Reference (API Version 2016-11-28)

CreateKeyPair

Creates sn SSH key pair.

Request Syntax

{
   "keyPairName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

keyPairName

The name for your new key pair.

Type: String

Pattern: \w[\w\-]*\w

Required: Yes

Response Syntax

{
   "keyPair": { 
      "arn": "string",
      "createdAt": number,
      "fingerprint": "string",
      "location": { 
         "availabilityZone": "string",
         "regionName": "string"
      },
      "name": "string",
      "resourceType": "string",
      "supportCode": "string"
   },
   "operation": { 
      "createdAt": number,
      "errorCode": "string",
      "errorDetails": "string",
      "id": "string",
      "isTerminal": boolean,
      "location": { 
         "availabilityZone": "string",
         "regionName": "string"
      },
      "operationDetails": "string",
      "operationType": "string",
      "resourceName": "string",
      "resourceType": "string",
      "status": "string",
      "statusChangedAt": number
   },
   "privateKeyBase64": "string",
   "publicKeyBase64": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

keyPair

An array of key-value pairs containing information about the new key pair you just created.

Type: KeyPair object

operation

An array of key-value pairs containing information about the results of your create key pair request.

Type: Operation object

privateKeyBase64

A base64-encoded RSA private key.

Type: String

publicKeyBase64

A base64-encoded public key of the ssh-rsa type.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

AccountSetupInProgressException

Lightsail throws this exception when an account is still in the setup in progress state.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

OperationFailureException

Lightsail throws this exception when an operation fails to execute.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: