-
Notifications
You must be signed in to change notification settings - Fork 84
/
Copy pathatlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt
95 lines (72 loc) · 3.22 KB
/
atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
.. _atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames:
======================================================================
atlas api alertConfigurations listAlertConfigurationMatchersFieldNames
======================================================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
You can successfully call this endpoint with any assigned role.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames.
For more information and examples, see the referenced API documentation linked above.
Syntax
------
.. code-block::
:caption: Command Syntax
atlas api alertConfigurations listAlertConfigurationMatchersFieldNames [options]
.. Code end marker, please don't delete this comment
Options
-------
.. list-table::
:header-rows: 1
:widths: 20 10 10 60
* - Name
- Type
- Required
- Description
* - --envelope
- envelope
- false
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
* - -h, --help
-
- false
- help for listAlertConfigurationMatchersFieldNames
* - --output
- string
- false
- preferred api format, can be ["json", go-template] This value defaults to "json".
* - --output-file
- string
- false
- file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
* - --pretty
-
- false
- Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
* - --version
- string
- false
- api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".
Inherited Options
-----------------
.. list-table::
:header-rows: 1
:widths: 20 10 10 60
* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
Examples
-----------------
Run the command below.
.. code-block::
atlas api alertConfigurations listAlertConfigurationMatchersFieldNames --version 2023-01-01 --envelope false --pretty false
.. Code end marker, please don't delete this comment