stack kb synthetics get-synthetic-monitors cli command

elastic stack kb synthetics get-synthetic-monitors [options]

Get monitors

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--filter string

Additional filtering criteria.

--locations string

The locations to filter by.

Repeatable: pass --locations multiple times to supply more than one value

--monitor-types string

The monitor types to filter.

Repeatable: pass --monitor-types multiple times to supply more than one value

--page number

The page number for paginated results.

--per-page number

The number of items to return per page.

--projects string

The projects to filter by.

Repeatable: pass --projects multiple times to supply more than one value

--query string

A free-text query string.

--schedules string

The schedules to filter by.

Repeatable: pass --schedules multiple times to supply more than one value

--sort-field enum

The field to sort the results by.

Values: name, createdAt, updatedAt, status

--sort-order enum

The sort order.

Values: asc, desc

--status string

The status to filter by.

Repeatable: pass --status multiple times to supply more than one value

--tags string

Tags to filter monitors.

Repeatable: pass --tags multiple times to supply more than one value

--use-logical-and-for string

Specifies whether to apply logical AND filtering for specific fields. Accepts either a string with values "tags" or "locations" or an array containing both.

Repeatable: pass --use-logical-and-for multiple times to supply more than one value

--input-file string

path to a JSON file to use as command input

--dry-run

validate all inputs and exit without performing any action (preview changes without applying them)

--no-validate

skip input validation and send the request as-is

--output-fields string

comma-separated list of fields to include in output (dot-notation supported)

--output-template string

Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")

--json

output as JSON