Skip to main content

projects

Overview

Nameprojects
TypeResource
Iddigitalocean.projects.projects

Fields

NameDatatypeDescription
idstringThe unique universal identifier of this project.
namestringThe human-readable name for the project. The maximum length is 175 characters and the name must be unique.
descriptionstringThe description of the project. The maximum length is 255 characters.
created_atstringA time value given in ISO8601 combined date and time format that represents when the project was created.
environmentstringThe environment of the project's resources.
is_defaultbooleanIf true, all resources will be added to this project if no project is specified.
owner_idintegerThe integer id of the project owner.
owner_uuidstringThe unique universal identifier of the project owner.
purposestringThe 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.
updated_atstringA time value given in ISO8601 combined date and time format that represents when the project was updated.

Methods

NameAccessible byRequired ParamsDescription
getSELECTproject_idTo get a project, send a GET request to /v2/projects/$PROJECT_ID.
listSELECTTo list all your projects, send a GET request to /v2/projects.
createINSERTdata__name, data__purposeTo create a project, send a POST request to /v2/projects.
deleteDELETEproject_idTo delete a project, send a DELETE request to /v2/projects/$PROJECT_ID. To
be deleted, a project must not have any resources assigned to it. Any existing
resources must first be reassigned or destroyed, or you will receive a 412 error.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
_getEXECproject_idTo get a project, send a GET request to /v2/projects/$PROJECT_ID.
_listEXECTo list all your projects, send a GET request to /v2/projects.
patchEXECproject_idTo update only specific attributes of a project, send a PATCH request to /v2/projects/$PROJECT_ID. At least one of the following attributes needs to be sent.
updateEXECproject_id, data__description, data__environment, data__is_default, data__name, data__purposeTo update a project, send a PUT request to /v2/projects/$PROJECT_ID. All of the following attributes must be sent.