Get One Organization¶
The Atlas 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 Configure Atlas API Access.
https://cloud.mongodb.com/api/atlas/v1.0
Resource¶
GET /orgs/{ORG-ID}
Request Path Parameters¶
| Path Element | Required/Optional | Description |
|---|---|---|
ORG-ID | Required. | The unique identifier for the Atlas organization whose information you want to retrieve. |
Request Query Parameters¶
The following query parameters are optional:
| Query Parameter | Type | Description | Default |
|---|---|---|---|
pretty | boolean | Displays response in a prettyprint format. | false |
envelope | boolean | Specifies whether or not to wrap the response in an envelope. | false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects, and a count of the total number of result objects retrieved.
| Name | Type | Description |
|---|---|---|
results | object array | Includes one object for each item detailed in the results array section. |
links | object array | Includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
totalCount | number | Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated. |
results array¶
| Name | Type | Description |
|---|---|---|
id | ObjectId | Unique identifier for the organization. |
isDeleted | boolean | Flag indicating if the organization is deleted. |
name | string | Name of the organization. |
links | document array | One or more links to sub-resources and/or related resources. The relation-types between URL s are explained in the Web Linking Specification. |
Example Request¶
curl --include --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}?pretty=true"
Example Response¶
{ "id" : "5a2add1cfd9f3cfb17053318", "isDeleted": false, "links": [{ "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5a2add1cfd9f3cfb17053318", "rel": "self" }, { "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5a2add1cfd9f3cfb17053318/groups", "rel": "http://mms.mongodb.com/groups" }, { "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5a2add1cfd9f3cfb17053318/teams", "rel": "http://mms.mongodb.com/teams" }, { "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5a2add1cfd9f3cfb17053318/users", "rel": "http://mms.mongodb.com/users" }], "name" : "Customer Application Support" }
Give Feedback