RootApi.md

\RootApi

All URIs are relative to https://cloud.mongodb.com

Method	HTTP request	Description
GetSystemStatus	Get /api/atlas/v1.0	Return the status of this MongoDB application

GetSystemStatus

ApiSystemStatusView GetSystemStatus(ctx).Envelope(envelope).Pretty(pretty).Execute()

Return the status of this MongoDB application

Example

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.RootApi.GetSystemStatus(context.Background()).Envelope(envelope).Pretty(pretty).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RootApi.GetSystemStatus``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSystemStatus`: ApiSystemStatusView
    fmt.Fprintf(os.Stdout, "Response from `RootApi.GetSystemStatus`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetSystemStatusRequest 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]

Return type

ApiSystemStatusView

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]