Give Feedback

spaces_keys_info

Generated on 11 Feb 2026 from digitalocean.cloud version v1.2.1

Synopsis

List all Spaces access keys on your account. Spaces access keys are used to authenticate with DigitalOcean Spaces, the S3-compatible object storage service. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Spaces-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.
`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 Spaces access keys
  digitalocean.cloud.spaces_keys_info:
    token: "{{ token }}"

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	Spaces access keys result information. Sample: `[ "Current Spaces access keys", "No Spaces access keys" ]`
`spaces_keys` list	always	Spaces access keys. Sample: `[ { "access_key": "AKIAIOSFODNN7EXAMPLE", "created_at": "2020-03-13T19:20:47.442049222Z", "grants": [ { "bucket": "my-bucket", "permission": "readwrite" } ], "name": "my-spaces-key" } ]`

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str

always

Spaces access keys result information.
Sample:

[
  "Current Spaces access keys",
  "No Spaces access keys"
]

spaces_keys
list