All URIs are relative to https://cloud.mongodb.com
| Method | HTTP request | Description |
|---|---|---|
| CreateOneAlertConfigurationInOneProject | Post /api/atlas/v1.0/groups/{groupId}/alertConfigs | Create One Alert Configuration in One Project |
| RemoveOneAlertConfigurationFromOneProject | Delete /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId} | Remove One Alert Configuration from One Project |
| ReturnAlertConfigMatchersFieldNames | Get /api/atlas/v1.0/alertConfigs/matchers/fieldNames | Get All Alert Configuration Matchers Field Names |
| ReturnAllAlertConfigurationsForOneProject | Get /api/atlas/v1.0/groups/{groupId}/alertConfigs | Return All Alert Configurations for One Project |
| ReturnAllOpenAlertsForAlertConfiguration | Get /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId}/alerts | Return All Open Alerts for Alert Configuration |
| ReturnOneAlertConfigurationFromOneProject | Get /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId} | Return One Alert Configuration from One Project |
| ToggleOneStateOfOneAlertConfigurationInOneProject | Patch /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId} | Toggle One State of One Alert Configuration in One Project |
| UpdateOneAlertConfigurationForOneProject | Put /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId} | Update One Alert Configuration for One Project |
ApiAlertConfigView CreateOneAlertConfigurationInOneProject(ctx, groupId).ApiAlertConfigView(apiAlertConfigView).Envelope(envelope).Pretty(pretty).Execute()
Create One Alert Configuration in One Project
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string | Unique 24-hexadecimal digit string that identifies your project.
apiAlertConfigView := *openapiclient.NewApiAlertConfigView("EventTypeName_example", []openapiclient.Link{*openapiclient.NewLink()}) // ApiAlertConfigView | Creates one alert configuration for the specified project.
envelope := false // bool | 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. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AlertConfigurationsApi.CreateOneAlertConfigurationInOneProject(context.Background(), groupId).ApiAlertConfigView(apiAlertConfigView).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.CreateOneAlertConfigurationInOneProject``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateOneAlertConfigurationInOneProject`: ApiAlertConfigView
fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.CreateOneAlertConfigurationInOneProject`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | Unique 24-hexadecimal digit string that identifies your project. |
Other parameters are passed through a pointer to a apiCreateOneAlertConfigurationInOneProjectRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiAlertConfigView | ApiAlertConfigView | Creates one alert configuration for the specified project. | envelope | bool | 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. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RemoveOneAlertConfigurationFromOneProject(ctx, groupId, alertConfigId).Envelope(envelope).Pretty(pretty).Execute()
Remove One Alert Configuration from One Project
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string | Unique 24-hexadecimal digit string that identifies your project.
alertConfigId := "adddde5af4ee4bd0b519375f" // string | Unique 24-hexadecimal digit string that identifies the alert configuration.
envelope := false // bool | 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. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AlertConfigurationsApi.RemoveOneAlertConfigurationFromOneProject(context.Background(), groupId, alertConfigId).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.RemoveOneAlertConfigurationFromOneProject``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | Unique 24-hexadecimal digit string that identifies your project. | |
| alertConfigId | string | Unique 24-hexadecimal digit string that identifies the alert configuration. |
Other parameters are passed through a pointer to a apiRemoveOneAlertConfigurationFromOneProjectRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
envelope | bool | 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. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]string ReturnAlertConfigMatchersFieldNames(ctx).Envelope(envelope).Pretty(pretty).Execute()
Get All Alert Configuration Matchers Field Names
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
envelope := false // bool | 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. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AlertConfigurationsApi.ReturnAlertConfigMatchersFieldNames(context.Background()).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.ReturnAlertConfigMatchersFieldNames``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ReturnAlertConfigMatchersFieldNames`: []string
fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.ReturnAlertConfigMatchersFieldNames`: %v\n", resp)
}Other parameters are passed through a pointer to a apiReturnAlertConfigMatchersFieldNamesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| envelope | bool | 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. | [default to false] |
| pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false] |
[]string
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedAlertConfigView ReturnAllAlertConfigurationsForOneProject(ctx, groupId).Envelope(envelope).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Pretty(pretty).Execute()
Return All Alert Configurations for One Project
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string | Unique 24-hexadecimal digit string that identifies your project.
envelope := false // bool | 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. (optional) (default to false)
includeCount := true // bool | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. (optional) (default to true)
itemsPerPage := int32(100) // int32 | Number of items that the response returns per page. (optional) (default to 100)
pageNum := int32(1) // int32 | Number of the page that displays the current set of the total objects that the response returns. (optional) (default to 1)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AlertConfigurationsApi.ReturnAllAlertConfigurationsForOneProject(context.Background(), groupId).Envelope(envelope).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.ReturnAllAlertConfigurationsForOneProject``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ReturnAllAlertConfigurationsForOneProject`: PaginatedAlertConfigView
fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.ReturnAllAlertConfigurationsForOneProject`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | Unique 24-hexadecimal digit string that identifies your project. |
Other parameters are passed through a pointer to a apiReturnAllAlertConfigurationsForOneProjectRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
envelope | bool | 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. | [default to false] includeCount | bool | Flag that indicates whether the response returns the total number of items (totalCount) in the response. | [default to true] itemsPerPage | int32 | Number of items that the response returns per page. | [default to 100] pageNum | int32 | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedAlertView ReturnAllOpenAlertsForAlertConfiguration(ctx, groupId, alertConfigId).Envelope(envelope).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Pretty(pretty).Execute()
Return All Open Alerts for Alert Configuration
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string | Unique 24-hexadecimal digit string that identifies your project.
alertConfigId := "adddde5af4ee4bd0b519375f" // string | Unique 24-hexadecimal digit string that identifies the alert configuration.
envelope := false // bool | 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. (optional) (default to false)
includeCount := true // bool | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. (optional) (default to true)
itemsPerPage := int32(100) // int32 | Number of items that the response returns per page. (optional) (default to 100)
pageNum := int32(1) // int32 | Number of the page that displays the current set of the total objects that the response returns. (optional) (default to 1)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AlertConfigurationsApi.ReturnAllOpenAlertsForAlertConfiguration(context.Background(), groupId, alertConfigId).Envelope(envelope).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.ReturnAllOpenAlertsForAlertConfiguration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ReturnAllOpenAlertsForAlertConfiguration`: PaginatedAlertView
fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.ReturnAllOpenAlertsForAlertConfiguration`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | Unique 24-hexadecimal digit string that identifies your project. | |
| alertConfigId | string | Unique 24-hexadecimal digit string that identifies the alert configuration. |
Other parameters are passed through a pointer to a apiReturnAllOpenAlertsForAlertConfigurationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
envelope | bool | 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. | [default to false] includeCount | bool | Flag that indicates whether the response returns the total number of items (totalCount) in the response. | [default to true] itemsPerPage | int32 | Number of items that the response returns per page. | [default to 100] pageNum | int32 | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiAlertConfigView ReturnOneAlertConfigurationFromOneProject(ctx, groupId, alertConfigId).Envelope(envelope).Pretty(pretty).Execute()
Return One Alert Configuration from One Project
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string | Unique 24-hexadecimal digit string that identifies your project.
alertConfigId := "adddde5af4ee4bd0b519375f" // string | Unique 24-hexadecimal digit string that identifies the alert configuration.
envelope := false // bool | 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. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AlertConfigurationsApi.ReturnOneAlertConfigurationFromOneProject(context.Background(), groupId, alertConfigId).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.ReturnOneAlertConfigurationFromOneProject``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ReturnOneAlertConfigurationFromOneProject`: ApiAlertConfigView
fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.ReturnOneAlertConfigurationFromOneProject`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | Unique 24-hexadecimal digit string that identifies your project. | |
| alertConfigId | string | Unique 24-hexadecimal digit string that identifies the alert configuration. |
Other parameters are passed through a pointer to a apiReturnOneAlertConfigurationFromOneProjectRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
envelope | bool | 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. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiAlertConfigView ToggleOneStateOfOneAlertConfigurationInOneProject(ctx, groupId, alertConfigId).Body(body).Envelope(envelope).Pretty(pretty).Execute()
Toggle One State of One Alert Configuration in One Project
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string | Unique 24-hexadecimal digit string that identifies your project.
alertConfigId := "adddde5af4ee4bd0b519375f" // string | Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert.
body := true // bool | Enables or disables the specified alert configuration in the specified project.
envelope := false // bool | 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. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AlertConfigurationsApi.ToggleOneStateOfOneAlertConfigurationInOneProject(context.Background(), groupId, alertConfigId).Body(body).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.ToggleOneStateOfOneAlertConfigurationInOneProject``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ToggleOneStateOfOneAlertConfigurationInOneProject`: ApiAlertConfigView
fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.ToggleOneStateOfOneAlertConfigurationInOneProject`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | Unique 24-hexadecimal digit string that identifies your project. | |
| alertConfigId | string | Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. |
Other parameters are passed through a pointer to a apiToggleOneStateOfOneAlertConfigurationInOneProjectRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
body | bool | Enables or disables the specified alert configuration in the specified project. | envelope | bool | 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. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiAlertConfigView UpdateOneAlertConfigurationForOneProject(ctx, groupId, alertConfigId).ApiAlertConfigView(apiAlertConfigView).Envelope(envelope).Pretty(pretty).Execute()
Update One Alert Configuration for One Project
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string | Unique 24-hexadecimal digit string that identifies your project.
alertConfigId := "adddde5af4ee4bd0b519375f" // string | Unique 24-hexadecimal digit string that identifies the alert configuration.
apiAlertConfigView := *openapiclient.NewApiAlertConfigView("EventTypeName_example", []openapiclient.Link{*openapiclient.NewLink()}) // ApiAlertConfigView | Updates one alert configuration in the specified project.
envelope := false // bool | 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. (optional) (default to false)
pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AlertConfigurationsApi.UpdateOneAlertConfigurationForOneProject(context.Background(), groupId, alertConfigId).ApiAlertConfigView(apiAlertConfigView).Envelope(envelope).Pretty(pretty).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.UpdateOneAlertConfigurationForOneProject``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateOneAlertConfigurationForOneProject`: ApiAlertConfigView
fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.UpdateOneAlertConfigurationForOneProject`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | string | Unique 24-hexadecimal digit string that identifies your project. | |
| alertConfigId | string | Unique 24-hexadecimal digit string that identifies the alert configuration. |
Other parameters are passed through a pointer to a apiUpdateOneAlertConfigurationForOneProjectRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiAlertConfigView | ApiAlertConfigView | Updates one alert configuration in the specified project. | envelope | bool | 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. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]