Give Feedback

ssh_key

Generated on 3 Jul 2025 from digitalocean.cloud version v1.2.1

Synopsis

Create or delete SSH keys. View the create API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/SSH-Keys.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`name` str / required		A human-readable display name for this key, used to easily identify the SSH keys when they are displayed.
`public_key` str / required		The entire public key string that was uploaded. Embedded into the root user’s authorized_keys file if you include this key during Droplet creation.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Create SSH key
  digitalocean.cloud.ssh_key:
    token: "{{ token }}"
    state: present
    public_key: >-
      ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example
    name: "My SSH Public Key"

Return Values

Key Returned Description

Key	Returned	Description
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Droplet result information. Sample: `[ "Created SSH key My SSH Public Key (3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa)", "Deleted SSH key My SSH Public Key (3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa)", "SSH key My SSH Public Key would be created", "SSH key My SSH Public Key (3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa) exists", "SSH key My SSH Public Key does not exist", "SSH key My SSH Public Key (3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa) would be deleted" ]`
`ssh_key` dict	always	SSH key information. Sample: `{ "fingerprint": "3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa", "id": 512189, "name": "My SSH Public Key", "public_key": "ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example" }`

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
str

always

Droplet result information.
Sample:

[
  "Created SSH key My SSH Public Key (3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa)",
  "Deleted SSH key My SSH Public Key (3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa)",
  "SSH key My SSH Public Key would be created",
  "SSH key My SSH Public Key (3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa) exists",
  "SSH key My SSH Public Key does not exist",
  "SSH key My SSH Public Key (3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa) would be deleted"
]

ssh_key
dict