ssh_keys_info

Generated on 20 Jun 2025 from digitalocean.cloud version v1.2.1

Synopsis

List all of the keys in your account. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#operation/sshKeys_list.

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.
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: Get SSH keys
  digitalocean.cloud.ssh_keys_info:
    token: "{{ token }}"

Return Values

KeyReturnedDescription
error
dict
failure DigitalOcean API error.
Sample:
{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}
msg
str
always SSH keys result information.
Sample:
[
  "Current SSH keys",
  "No SSH keys"
]
ssh_keys
list
always SSH keys.
Sample:
[
  {
    "fingerprint": "3b:16:e4:bf:8b:00:8b:b8:59:8c:a9:d3:f0:19:fa:45",
    "id": 289794,
    "name": "Other Public Key",
    "public_key": "ssh-rsa ANOTHEREXAMPLEaC1yc2EAAAADAQABAAAAQ...owLh64b72pxekALga2oi4GvT+TlWNhzPH4V anotherexample"
  }
]

We can't find any results for your search.

Try using different keywords or simplifying your search terms.