project
Generated on 12 Jun 2025
from digitalocean.cloud
version
v1.2.1
Synopsis
Create or delete projects. Projects allow you to organize your resources into groups that fit the way you work. You can group resources (like Droplets, Spaces, load balancers, domains, and floating IPs) in ways that align with the applications you host on DigitalOcean. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Projects.
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. | |
description str |
The description of the project. The maximum length is 255 characters. | |
environment str |
Choices:
|
The environment of the project’s resources. |
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 human-readable name for the project. The maximum length is 175 characters and the name must be unique. | |
purpose str |
The purpose of the project. The maximum length is 255 characters. It can have one of the following values: “Just trying out DigitalOcean”, “Class project / Educational purposes”, “Website or blog”, “Web Application”, “Service or API”, “Mobile Application”, “Machine learning / AI / Data processing”, “IoT”, “Operational / Developer tooling”. If another value for purpose is specified, for example, “your custom purpose”, your purpose will be stored as Other: your custom purpose . |
|
state str |
Choices:
|
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 project
digitalocean.cloud.project:
token: "{{ token }}"
state: present
name: my-web-api
description: My Website API
purpose: Service or API
environment: Production
Return Values
Key | Returned | Description |
---|---|---|
error dict |
failure | DigitalOcean API error. Sample:
|
msg str |
always | Droplet result information. Sample:
|
project dict |
always | Project information. Sample:
|