Give Feedback

spaces_key

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

Synopsis

Create or delete Spaces access keys. 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
`access_key` str		The access key ID. Used for lookup when deleting.
`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.
`grants` list / elements=dict		The grants for the Spaces access key. Specifies which buckets and permissions the key has.
`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		The name of the Spaces access key.
`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 Spaces access key
  digitalocean.cloud.spaces_key:
    token: "{{ token }}"
    state: present
    name: my-spaces-key
    grants:
      - bucket: my-bucket
        permission: readwrite

- name: Delete Spaces access key
  digitalocean.cloud.spaces_key:
    token: "{{ token }}"
    state: absent
    name: my-spaces-key
    access_key: AKIAIOSFODNN7EXAMPLE

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 key result information. Sample: `[ "Created Spaces access key my-spaces-key", "Deleted Spaces access key my-spaces-key", "Spaces access key my-spaces-key would be created", "Spaces access key my-spaces-key exists", "Spaces access key my-spaces-key does not exist" ]`
`spaces_key` dict	always	Spaces access key information. Sample: `{ "access_key": "AKIAIOSFODNN7EXAMPLE", "created_at": "2020-03-13T19:20:47.442049222Z", "grants": [ { "bucket": "my-bucket", "permission": "readwrite" } ], "name": "my-spaces-key", "secret_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }`

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str

always

Spaces access key result information.
Sample:

[
  "Created Spaces access key my-spaces-key",
  "Deleted Spaces access key my-spaces-key",
  "Spaces access key my-spaces-key would be created",
  "Spaces access key my-spaces-key exists",
  "Spaces access key my-spaces-key does not exist"
]

spaces_key
dict