Give Feedback

project_resource

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

Synopsis

Assign or remove resources from a project. Projects allow you to organize your resources into groups that fit the way you work. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Project-Resources.

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.
`project_id` str / required		The UUID of the project.
`resources` list / elements=str / required		An array of uniform resource names (URNs) to assign to the project. Resource URNs have the format: do:resource_type:resource_id Examples: do:droplet:12345, do:kubernetes:cluster-uuid
`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: Assign resources to project
  digitalocean.cloud.project_resource:
    token: "{{ token }}"
    state: present
    project_id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4
    resources:
      - do:droplet:12345678
      - do:volume:87654321

- name: Remove resources from project (moves to default project)
  digitalocean.cloud.project_resource:
    token: "{{ token }}"
    state: absent
    project_id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4
    resources:
      - do:droplet:12345678

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	Project resource result information. Sample: `[ "Assigned resources to project", "Resources would be assigned to project" ]`
`resources` list	always	Resources assigned to the project. Sample: `[ { "assigned_at": "2020-03-13T19:20:47Z", "links": { "self": "https://api.digitalocean.com/v2/droplets/12345678" }, "status": "ok", "urn": "do:droplet:12345678" } ]`

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str

always

Project resource result information.
Sample:

[
  "Assigned resources to project",
  "Resources would be assigned to project"
]

resources
list