Returns all control plane IP addresses.
Query parameters
-
Flag that indicates whether Application wraps the response in an
envelopeJSON 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 value is
false.
GET
/api/atlas/v2/unauth/controlPlaneIPAddresses
Atlas CLI
atlas api root listControlPlaneAddresses --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.ListControlPlaneIpAddressesApiParams{}
sdkResp, httpResp, err := client.RootApi.
ListControlPlaneIpAddressesWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true"
Response examples (200)
# Headers
# Payload
{
"inbound": {
"aws": {
"additionalProperty1": [
"string"
],
"additionalProperty2": [
"string"
]
},
"azure": {
"additionalProperty1": [
"string"
],
"additionalProperty2": [
"string"
]
},
"gcp": {
"additionalProperty1": [
"string"
],
"additionalProperty2": [
"string"
]
}
},
"outbound": {
"aws": {
"additionalProperty1": [
"string"
],
"additionalProperty2": [
"string"
]
},
"azure": {
"additionalProperty1": [
"string"
],
"additionalProperty2": [
"string"
]
},
"gcp": {
"additionalProperty1": [
"string"
],
"additionalProperty2": [
"string"
]
}
}
}
Response examples (429)
{
"error": 429,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Too Many Requests",
"errorCode": "RATE_LIMITED"
}
Response examples (500)
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}