powerpacks
Creates, updates, deletes, gets or lists a powerpacks
resource.
Overview
Name | powerpacks |
Type | Resource |
Id | datadog.dashboards.powerpacks |
Fields
The following fields are returned by SELECT
queries:
- get_powerpack
- list_powerpacks
Name | Datatype | Description |
---|---|---|
id | string | ID of the powerpack. |
attributes | object | Powerpack attribute object. |
relationships | object | Powerpack relationship object. |
type | string | Type of widget, must be powerpack. (example: powerpack) |
Name | Datatype | Description |
---|---|---|
id | string | ID of the powerpack. |
attributes | object | Powerpack attribute object. |
relationships | object | Powerpack relationship object. |
type | string | Type of widget, must be powerpack. (example: powerpack) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_powerpack | select | powerpack_id , region | Get a powerpack. | |
list_powerpacks | select | region | page[limit] , page[offset] | Get a list of all powerpacks. |
create_powerpack | insert | region | Create a powerpack. | |
update_powerpack | update | powerpack_id , region | Update a powerpack. | |
delete_powerpack | delete | powerpack_id , region | Delete a powerpack. |
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 |
---|---|---|
powerpack_id | string | Powerpack id |
region | string | (default: datadoghq.com) |
page[limit] | integer (int64) | Maximum number of powerpacks in the response. (example: 25) |
page[offset] | integer (int64) | Specific offset to use as the beginning of the returned page. |
SELECT
examples
- get_powerpack
- list_powerpacks
Get a powerpack.
SELECT
id,
attributes,
relationships,
type
FROM datadog.dashboards.powerpacks
WHERE powerpack_id = '{{ powerpack_id }}' -- required
AND region = '{{ region }}' -- required
;
Get a list of all powerpacks.
SELECT
id,
attributes,
relationships,
type
FROM datadog.dashboards.powerpacks
WHERE region = '{{ region }}' -- required
AND page[limit] = '{{ page[limit] }}'
AND page[offset] = '{{ page[offset] }}'
;
INSERT
examples
- create_powerpack
- Manifest
Create a powerpack.
INSERT INTO datadog.dashboards.powerpacks (
data__data,
region
)
SELECT
'{{ data }}',
'{{ region }}'
RETURNING
data,
included
;
# Description fields are for documentation purposes
- name: powerpacks
props:
- name: region
value: string
description: Required parameter for the powerpacks resource.
- name: data
value: object
description: |
Powerpack data object.
UPDATE
examples
- update_powerpack
Update a powerpack.
UPDATE datadog.dashboards.powerpacks
SET
data__data = '{{ data }}'
WHERE
powerpack_id = '{{ powerpack_id }}' --required
AND region = '{{ region }}' --required
RETURNING
data,
included;
DELETE
examples
- delete_powerpack
Delete a powerpack.
DELETE FROM datadog.dashboards.powerpacks
WHERE powerpack_id = '{{ powerpack_id }}' --required
AND region = '{{ region }}' --required
;