|
| 1 | +## stackit argus scrape-config generate-payload |
| 2 | + |
| 3 | +Generates a payload to create/update scrape configurations for an Argus instance |
| 4 | + |
| 5 | +### Synopsis |
| 6 | + |
| 7 | +Generates a JSON payload with values to be used as --payload input for scrape configurations creation or update. |
| 8 | +This command can be used to generate a payload to update an existing scrape config or to create a new scrape config job. |
| 9 | +To update an existing scrape config job, provide the job name and the instance ID of the Argus instance. |
| 10 | +To obtain a default payload to create a new scrape config job, run the command with no flags. |
| 11 | +Note that some of the default values provided, such as the job name, the metrics path and URL of the targets, should be adapted to your use case. |
| 12 | +See https://docs.api.stackit.cloud/documentation/argus/version/v1#tag/scrape-config/operation/v1_projects_instances_scrapeconfigs_create for information regarding the payload structure. |
| 13 | + |
| 14 | + |
| 15 | +``` |
| 16 | +stackit argus scrape-config generate-payload [flags] |
| 17 | +``` |
| 18 | + |
| 19 | +### Examples |
| 20 | + |
| 21 | +``` |
| 22 | + Generate a Create payload with default values, and adapt it with custom values for the different configuration options |
| 23 | + $ stackit argus scrape-config generate-payload > ./payload.json |
| 24 | + <Modify payload in file, if needed> |
| 25 | + $ stackit argus scrape-config create my-config --payload @./payload.json |
| 26 | +
|
| 27 | + Generate an Update payload with the values of an existing configuration named "my-config" for Argus instance xxx, and adapt it with custom values for the different configuration options |
| 28 | + $ stackit argus scrape-config generate-payload --job-name my-config --instance-id xxx > ./payload.json |
| 29 | + <Modify payload in file> |
| 30 | + $ stackit argus scrape-config update my-config --payload @./payload.json |
| 31 | +``` |
| 32 | + |
| 33 | +### Options |
| 34 | + |
| 35 | +``` |
| 36 | + -h, --help Help for "stackit argus scrape-config generate-payload" |
| 37 | + --instance-id string Instance ID |
| 38 | + -n, --job-name string If set, generates an update payload with the current state of the given scrape config. If unset, generates a create payload with default values |
| 39 | +``` |
| 40 | + |
| 41 | +### Options inherited from parent commands |
| 42 | + |
| 43 | +``` |
| 44 | + -y, --assume-yes If set, skips all confirmation prompts |
| 45 | + --async If set, runs the command asynchronously |
| 46 | + -o, --output-format string Output format, one of ["json" "pretty" "none"] |
| 47 | + -p, --project-id string Project ID |
| 48 | + --verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info") |
| 49 | +``` |
| 50 | + |
| 51 | +### SEE ALSO |
| 52 | + |
| 53 | +* [stackit argus scrape-config](./stackit_argus_scrape-config.md) - Provides functionality for scrape configurations in Argus |
| 54 | + |
0 commit comments