Navigation

Get All Alert Configuration Matchers Field Names

Info With Circle IconCreated with Sketch.Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

https://cloud.mongodb.com/api/atlas/v1.0

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.

GET /alertConfigs/matchers/fieldNames

This endpoint does not use HTTP request path parameters.

NameTypeNecessityDescriptionDefault
prettybooleanOptionalFlag indicating whether the response body should be in a prettyprint format.false
envelopebooleanOptional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

statusHTTP response code
envelopeExpected response body
false

This endpoint does not use HTTP request body parameters.

The response returns an array of strings that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.

curl -X GET -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest "https://cloud.mongodb.com/api/atlas/v1.0/alertConfigs/matchers/fieldNames"
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
[
"TYPE_NAME",
"HOSTNAME",
"PORT",
"HOSTNAME_AND_PORT",
"REPLICA_SET_NAME",
"SHARD_NAME",
"CLUSTER_NAME"
]
Give Feedback