Docs Menu

Get the Status of One Project IP Access List Entryicons/link.png

On this page

  • Syntax
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response Elements
  • Example Request
  • Example Response
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.

The Atlas Administration API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. To learn how to configure API access for an Atlas project, see Get Started with the Atlas Administration API.

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

This resource checks whether one project IP access list entry from the specified project is active on relevant cloud providers.

GET /groups/{GROUP-ID}/accessList/{ACCESS-LIST-ENTRY}/status
Path Element
Type
Necessity
Description
GROUP-ID
string
Required
Unique 24-hexadecimal digit string that identifies the project from which you want to return an access list entry status.
ACCESS-LIST-ENTRY
string
Required

String that identifies the access list entry in one of the following forms:

  • AWS security group ID
  • IP address
  • CIDR address

If the entry includes a subnet mask, use the URL-encoded value %2F for the forward slash /.

This endpoint might use any of the HTTP request query parameters available to all Atlas Administration API resources. All of these are optional.

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

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:

status
HTTP response code
envelope
Expected response body
false

This endpoint doesn't use HTTP request body parameters.

Name
Type
Description
Status
string

State of the access list entry when Atlas made this request:

ACTIVE
Access list entry is live on all relevant cloud providers.
PENDING
Atlas is adding the access list entry. The access list entry is not yet active.
FAILED
Atlas couldn't successfully add the access list entry.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
--digest \
--header "Content-Type: application/json" \
--include \
--request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/accessList/{ACCESS-LIST-ENTRY}/status?pretty=true"
{
"STATUS": "ACTIVE"
}
Give Feedback
MongoDB logo
© 2021 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.