ec2.instances.add-key

Add a key pair to a running instance (root and its default user), no reboot

POST /ec2/api/instances/{id}/keysIAM ec2:AddInstanceKeyChanges state

Through Deutsche Cloud Connect: works while the instance is connected (`connect-status`). The line in authorized_keys ends in `ews-key:<keyPairId>`, so `remove-key` takes out exactly that line. On an instance without Connect: 409 with what is possible.

Depending on the resource, the call checks ec2:DescribeKeyPairs instead; hold all of them to be sure it is allowed.

Request syntax

POST /ec2/api/instances/{id}/keys
{
  "keyPairId": "string",
  "users": "enum"
}

Path parameters

  • idRequired

    string

    Constraints: /^i-[0-9a-f]{6,32}$/

Request body

  • keyPairIdRequired

    string

    The key pair to add (ec2 key pairs)

  • usersOptional

    enum

    Whose authorized_keys get it: root, the image’s default user, or both (the default)

    One of: root, default

Response

201: `data` is `{ key, results }`: the added key (id, keyPairId, keyPairName, fingerprint, users, status, addedAt) and, per login user, what the machine reported.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow ec2:AddInstanceKey on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud ec2 instances add-key id --key-pair-id example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_ec2_instances_add-key.