Get One Team by Name¶
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
Syntax¶
GET /orgs/{ORG-ID}/teams/byName/{TEAM-NAME}
Request Path Parameters¶
Path Element | Required/Optional | Description |
|---|---|---|
ORG-ID | Required. | The unique identifier for the
organization
associated with the team. |
TEAM-NAME | Required | The name of the team whose
information you want to retrieve. |
Request Query Parameters¶
This endpoint might use any of the HTTP request query parameters available to all Atlas 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:
| false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Name | Type | Description |
|---|---|---|
id | string | The unique identifier for the team. |
name | string | The name of the organization associated with the team. |
links | object array | One or more uniform resource locators that link to sub-resources and/or related resources. The Web Linking Specification explains the relation-types between URLs. |
Example Request¶
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}"" --digest -i \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/teams/byName/{TEAM-NAME}?pretty=true"
Example Response¶
{ "id": "{TEAM-ID}", "links": [ { "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}", "rel": "self" } ], "name": "myNewTeam" }