Navigation

Create and Assign One Organization API Key to One Project

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

POST /groups/{PROJECT-ID}/apiKeys
NameTypeDescription
PROJECT-IDstringUnique identifier for the Project whose API keys you want to retrieve. Use the /groups endpoint to retrieve all organizations to which the authenticated user has access.

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

NameTypeNecessityDescriptionDefault
pageNumintegerOptionalPage number (1-based).1
itemsPerPageintegerOptionalMaximum number of items to return, up to a maximum of 100.100
includeCountbooleanOptionalSpecifies whether the response returns the totalCount field.true
prettybooleanOptionalIndicates whether the response body should be in a prettyprint format.false
envelopebooleanOptional

Flag indicating if Atlas should wrap the response in a JSON envelope.

Some API 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:

statusHTTP response code
envelopeExpected response body

For endpoints that return a list of results, the results object is an envelope. Atlas adds the status field to the response body.

false

At least one of the two body parameters are required.

NameTypeNecessityDescription
descstringConditionalDescription of the API key. Must be between 1 and 250 characters in length, inclusive.
rolesarray of stringsConditional

List of roles that the API Key needs to have. If you include the roles array:

  • Provide at least one role
  • Make sure all roles must be valid for the Project

Project roles include:

  • GROUP_CLUSTER_MANAGER
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_OWNER
  • GROUP_READ_ONLY
NameTypeDescription
descstringDescription of this Organization API key assigned to this Project.
idstringUnique identifier for this Organization API key assigned to this Project.
privateKeystring

Redacted Private key for this Organization API key assigned to this Project.

Info With Circle IconCreated with Sketch.Note
This key displays unredacted when first created.
publicKeystringPublic key for this Organization API key assigned to this Project.
rolesarray of objectsRoles that this Organization API key assigned to this Project has. This array returns all the Organization and Project roles the user has in Atlas.
roles.groupIdstringUnique identifier of the Project to which this role belongs.
roles.orgIdstringUnique identifier of the Organization to which this role belongs.
roles.roleNamestring

Name of the role. This resource returns all the roles the user has in Atlas. Possible values are:

Organization Roles

If this is an roles.orgId (Organization), values include:

  • ORG_OWNER
  • ORG_MEMBER
  • ORG_GROUP_CREATOR
  • ORG_BILLING_ADMIN
  • ORG_READ_ONLY

Project Roles

If this is an roles.groupId (Project), values include:

  • GROUP_CLUSTER_MANAGER
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_OWNER
  • GROUP_READ_ONLY
Info With Circle IconCreated with Sketch.Note

The user who makes the request can be formatted either as {USERNAME}:{APIKEY} or {PUBLIC-KEY}:{PRIVATE-KEY}.

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include \
5 --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true" \
6 --data '{
7 "desc" : "New API key for test purposes",
8 "roles": ["GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN"]
9 }'
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
1{
2 "desc" : "New API key for test purposes",
3 "id" : "{API-KEY}",
4 "links" : [ {
5 "href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY}",
6 "rel" : "self"
7 } ],
8 "privateKey" : "********-****-****-db2c132ca78d",
9 "publicKey" : "{PUBLIC-KEY}",
10 "roles" : [ {
11 "groupId" : "{PROJECT-ID}",
12 "roleName" : "GROUP_READ_ONLY"
13 }, {
14 "groupId" : "{PROJECT-ID}",
15 "roleName" : "GROUP_DATA_ACCESS_ADMIN"
16 }, {
17 "orgId" : "{ORG-ID}",
18 "roleName" : "ORG_BILLING_ADMIN"
19 } ]
20}
Give Feedback