projects
Overview
Name | projects |
Type | Resource |
Id | digitalocean.projects.projects |
Fields
Name | Datatype | Description |
---|---|---|
id | string | The unique universal identifier of this project. |
name | string | The human-readable name for the project. The maximum length is 175 characters and the name must be unique. |
description | string | The description of the project. The maximum length is 255 characters. |
created_at | string | A time value given in ISO8601 combined date and time format that represents when the project was created. |
environment | string | The environment of the project's resources. |
is_default | boolean | If true, all resources will be added to this project if no project is specified. |
owner_id | integer | The integer id of the project owner. |
owner_uuid | string | The unique universal identifier of the project owner. |
purpose | string | 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 . |
updated_at | string | A time value given in ISO8601 combined date and time format that represents when the project was updated. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | project_id | To get a project, send a GET request to /v2/projects/$PROJECT_ID . |
list | SELECT | To list all your projects, send a GET request to /v2/projects . | |
create | INSERT | data__name, data__purpose | To create a project, send a POST request to /v2/projects . |
delete | DELETE | project_id | To delete a project, send a DELETE request to /v2/projects/$PROJECT_ID . Tobe 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. |
_get | EXEC | project_id | To get a project, send a GET request to /v2/projects/$PROJECT_ID . |
_list | EXEC | To list all your projects, send a GET request to /v2/projects . | |
patch | EXEC | project_id | To 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. |
update | EXEC | project_id, data__description, data__environment, data__is_default, data__name, data__purpose | To update a project, send a PUT request to /v2/projects/$PROJECT_ID . All of the following attributes must be sent. |