Navigation

Root

The root resource is the starting point for the Atlas API.

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

This endpoint does not use HTTP request path parameters.

The following query parameters are optional:

Query ParameterTypeDescriptionDefault
prettybooleanDisplays response in a prettyprint format.false
envelopebooleanSpecifies whether or not to wrap the response in an envelope.false

This endpoint does not use HTTP request body parameters.

The response includes the following elements:

FieldDescription
linksArray of links to related API resources. For more information on links, see Linking.
results

Array of documents, each representing one programmatic Api Key and the organization roles associated with it.

FieldDescription
descUser-supplied description of the programmatic API Key.
idUnique identifier of the programmatic API Key.
linksLinks to resources associated with the programmatic API Key.
privateKeyThe private key of the programmatic API Key used to query this resource.
publicKeyThe public key for the programmatic API Key used to query this resource.
roles[]Array of organization roles. assigned to the programmatic API Key used to query this resource.
roles[i].orgIdThe unique identifer of the project associated with the programmatic API Key.
roles[i].roleNameThe organization role associated with the programmatic API Key.
roles[i].groupIdThe Atlas project to which the organization role has privileges.
roles[i].roleName

The organization role assigned to the programmatic API Key. The users resource returns all roles assigned to the user in Atlas. Possible values are:

  • Organization Roles

    • ORG_OWNER
    • ORG_MEMBER
    • ORG_GROUP_CREATOR
    • ORG_BILLING_ADMIN
    • ORG_READ_ONLY
totalCountNumber of programmatic API Keys returned in the results array.
curl -X GET -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest -i "https://cloud.mongodb.com/api/atlas/v1.0"
{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/6002f2c580eef55aedbc7bb1/apiKeys?pageNum=1&itemsPerPage=100",
"rel": "self"
}
],
"results": [
{
"desc": "Programmatic Key 1",
"id": "6e1bac9587d9d62619dc45df",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/6002f2c580eef55aedbc7bb1/apiKeys/6e1bac9587d9d62619dc45df",
"rel": "self"
}
],
"privateKey": "********-****-****-8e902de02aa0",
"publicKey": "cvlqyfeo",
"roles": [
{
"orgId": "5991f2c580eef55aedbc6aa0",
"roleName": "ORG_MEMBER"
},
{
"groupId": "5d0aa5fb80eef50e5e4caf7d",
"roleName": "GROUP_OWNER"
}
]
},
{
"desc": "Programmatic API Key #2",
"id": "6df3f74980eef51f794938fe",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/6002f2c580eef55aedbc7bb1/apiKeys/6df3f74980eef51f794938fe",
"rel": "self"
}
],
"privateKey": "********-****-****-d54c11c7cce9",
"publicKey": "czqssgho",
"roles": [
{
"orgId": "5991f2c580eef55aedbc6aa0",
"roleName": "ORG_MEMBER"
},
{
"groupId": "5c6df63680eef54ad84bb90e",
"roleName": "GROUP_READ_ONLY"
}
]
}
],
"totalCount": 2
}
Give Feedback