Difference between revisions of "Dog --help"
Jump to navigation
Jump to search
(Created page with "{{lc}} {{dog}}") |
|||
| Line 1: | Line 1: | ||
{{lc}} | {{lc}} | ||
| + | <pre> | ||
| + | dog --help | ||
| + | usage: dog [-h] [--config CONFIG] [--api-key API_KEY] [--application-key APP_KEY] [--pretty] [--raw] | ||
| + | [--timeout TIMEOUT] [-v] [--api_host API_HOST] | ||
| + | {comment,search,metric,tag,event,monitor,timeboard,dashboard,screenboard,dashboard_list,host,downtime,service_check,service_level_objective} | ||
| + | ... | ||
| + | Interact with the Datadog API | ||
| + | options: | ||
| + | -h, --help show this help message and exit | ||
| + | --config CONFIG location of your dogrc file (default ~/.dogrc) (default: /Users/qs/.dogrc) | ||
| + | --api-key API_KEY your API key, from https://app.datadoghq.com/account/settings#api. You can also | ||
| + | set the environment variables DATADOG_API_KEY or DD_API_KEY (default: None) | ||
| + | --application-key APP_KEY | ||
| + | your Application key, from https://app.datadoghq.com/account/settings#api. You | ||
| + | can also set the environment variables DATADOG_APP_KEY or DD_APP_KEY (default: | ||
| + | None) | ||
| + | --pretty pretty-print output (suitable for human consumption, less useful for scripting) | ||
| + | (default: None) | ||
| + | --raw raw JSON as returned by the HTTP service (default: None) | ||
| + | --timeout TIMEOUT time to wait in seconds before timing out an API call (default 10) (default: 10) | ||
| + | -v, --version Dog API version | ||
| + | --api_host API_HOST Datadog site to send data, us (datadoghq.com), eu (datadoghq.eu), us3 | ||
| + | (us3.datadoghq.com), us5 (us5.datadoghq.com), ap1 (ap1.datadoghq.com), gov (ddog- | ||
| + | gov.com), or custom url. default: us (default: None) | ||
| − | {{dog}} | + | Modes: |
| + | {comment,search,metric,tag,event,monitor,timeboard,dashboard,screenboard,dashboard_list,host,downtime,service_check,service_level_objective} | ||
| + | comment Post, update, and delete comments. | ||
| + | search search datadog | ||
| + | metric Post metrics. | ||
| + | tag View and modify host tags. | ||
| + | event Post events, get event details, and view the event stream. | ||
| + | monitor Create, edit, and delete monitors | ||
| + | timeboard Create, edit, and delete timeboards | ||
| + | dashboard Create, edit, and delete dashboards | ||
| + | screenboard Create, edit, and delete screenboards. | ||
| + | dashboard_list Create, edit, and delete dashboard lists | ||
| + | host Mute, unmute hosts | ||
| + | downtime Create, edit, and delete downtimes | ||
| + | service_check Perform service checks | ||
| + | service_level_objective | ||
| + | Create, edit, and delete service level objectives | ||
| + | </pre> | ||
| + | |||
| + | == See also == | ||
| + | * {{dog}} | ||
Latest revision as of 14:54, 1 August 2024
dog --help
usage: dog [-h] [--config CONFIG] [--api-key API_KEY] [--application-key APP_KEY] [--pretty] [--raw]
[--timeout TIMEOUT] [-v] [--api_host API_HOST]
{comment,search,metric,tag,event,monitor,timeboard,dashboard,screenboard,dashboard_list,host,downtime,service_check,service_level_objective}
...
Interact with the Datadog API
options:
-h, --help show this help message and exit
--config CONFIG location of your dogrc file (default ~/.dogrc) (default: /Users/qs/.dogrc)
--api-key API_KEY your API key, from https://app.datadoghq.com/account/settings#api. You can also
set the environment variables DATADOG_API_KEY or DD_API_KEY (default: None)
--application-key APP_KEY
your Application key, from https://app.datadoghq.com/account/settings#api. You
can also set the environment variables DATADOG_APP_KEY or DD_APP_KEY (default:
None)
--pretty pretty-print output (suitable for human consumption, less useful for scripting)
(default: None)
--raw raw JSON as returned by the HTTP service (default: None)
--timeout TIMEOUT time to wait in seconds before timing out an API call (default 10) (default: 10)
-v, --version Dog API version
--api_host API_HOST Datadog site to send data, us (datadoghq.com), eu (datadoghq.eu), us3
(us3.datadoghq.com), us5 (us5.datadoghq.com), ap1 (ap1.datadoghq.com), gov (ddog-
gov.com), or custom url. default: us (default: None)
Modes:
{comment,search,metric,tag,event,monitor,timeboard,dashboard,screenboard,dashboard_list,host,downtime,service_check,service_level_objective}
comment Post, update, and delete comments.
search search datadog
metric Post metrics.
tag View and modify host tags.
event Post events, get event details, and view the event stream.
monitor Create, edit, and delete monitors
timeboard Create, edit, and delete timeboards
dashboard Create, edit, and delete dashboards
screenboard Create, edit, and delete screenboards.
dashboard_list Create, edit, and delete dashboard lists
host Mute, unmute hosts
downtime Create, edit, and delete downtimes
service_check Perform service checks
service_level_objective
Create, edit, and delete service level objectives
See also[edit]
Advertising:
