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:
  • Development
  • Staging
  • Production
 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:
  • 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 project
  digitalocean.cloud.project:
    token: "{{ token }}"
    state: present
    name: my-web-api
    description: My Website API
    purpose: Service or API
    environment: Production

Return Values

KeyReturnedDescription
error
dict		 failure DigitalOcean API error.
Sample:
{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}
msg
str		 always Droplet result information.
Sample:
[
  "Created project my-website-api (9cc10173-e9ea-4176-9dbc-a4cee4c4ff30)",
  "Deleted project my-website-api (9cc10173-e9ea-4176-9dbc-a4cee4c4ff30)",
  "Project my-website-api would be created",
  "Project my-website-api (9cc10173-e9ea-4176-9dbc-a4cee4c4ff30) exists",
  "Project my-website-api does not exist",
  "Project my-website-api (9cc10173-e9ea-4176-9dbc-a4cee4c4ff30) would be deleted"
]
project
dict		 always Project information.
Sample:
{
  "created_at": "2018-09-27T20:10:35Z",
  "description": "My website API",
  "environment": "Production",
  "id": "4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679",
  "is_default": false,
  "name": "my-web-api",
  "owner_id": 258992,
  "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7",
  "purpose": "Service or API",
  "updated_at": "2018-09-27T20:10:35Z"
}

We can't find any results for your search.

Try using different keywords or simplifying your search terms.