projects
Creates, updates, deletes, gets or lists a projects
resource.
Overview
Name | projects |
Type | Resource |
Id | datadog.service_management.projects |
Fields
The following fields are returned by SELECT
queries:
- get_project
- get_projects
Name | Datatype | Description |
---|---|---|
id | string | The Project's identifier (example: aeadc05e-98a8-11ec-ac2c-da7ad0900001) |
attributes | object | Project attributes |
relationships | object | Project relationships |
type | string | Project resource type (default: project, example: project) |
Name | Datatype | Description |
---|---|---|
id | string | The Project's identifier (example: aeadc05e-98a8-11ec-ac2c-da7ad0900001) |
attributes | object | Project attributes |
relationships | object | Project relationships |
type | string | Project resource type (default: project, example: project) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_project | select | project_id , region | Get the details of a project by project_id . | |
get_projects | select | region | Get all projects. | |
create_project | insert | region , data__data | Create a project. | |
delete_project | delete | project_id , region | Remove a project using the project's id . |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
project_id | string | Project UUID (example: e555e290-ed65-49bd-ae18-8acbfcf18db7) |
region | string | (default: datadoghq.com) |
SELECT
examples
- get_project
- get_projects
Get the details of a project by project_id
.
SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.projects
WHERE project_id = '{{ project_id }}' -- required
AND region = '{{ region }}' -- required
;
Get all projects.
SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.projects
WHERE region = '{{ region }}' -- required
;
INSERT
examples
- create_project
- Manifest
Create a project.
INSERT INTO datadog.service_management.projects (
data__data,
region
)
SELECT
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data
;
# Description fields are for documentation purposes
- name: projects
props:
- name: region
value: string
description: Required parameter for the projects resource.
- name: data
value: object
description: |
Project create
DELETE
examples
- delete_project
Remove a project using the project's id
.
DELETE FROM datadog.service_management.projects
WHERE project_id = '{{ project_id }}' --required
AND region = '{{ region }}' --required
;