Navigation

Rename an Organization

The Atlas API uses HTTP Digest Authentication. Provide your Atlas username and API key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

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

Syntax

PATCH /orgs/{ORG-ID}

Request Path Parameters

Name Type Description
ORG-ID string The id of the organization that you want to rename.

Request Query Parameters

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

Name Type Description Default
pretty boolean Display response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

Name Type Description
name string The new name for the organization.

Response

Name Type Description
id ObjectId Unique identifier for the organization.
links document array One or more links to sub-resources and/related resources. The relations between URLs are explained in the Web Linking Specification.
name string New name of the organization.

Example

Example Request

curl -X PATCH --include --user "<username:apiKey>" --digest --header "Content-Type: application/json" \
     "https://cloud.mongodb.com/api/atlas/v1.0/orgs/6001f2c580eef55aedbc6bb1?pretty=true" \
     --data '{"name":"MyAtlasCluster"}'

Example Response

{
  "id" : "6001f2c580eef55aedbc6bb1",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/6001f2c580eef55aedbc6bb1",
    "rel" : "self"
  }, {
    "href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/6001f2c580eef55aedbc6bb1/groups",
    "rel" : "http://mms.mongodb.com/groups"
  }, {
    "href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/6001f2c580eef55aedbc6bb1/teams",
    "rel" : "http://mms.mongodb.com/teams"
  }, {
    "href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/6001f2c580eef55aedbc6bb1/users",
    "rel" : "http://mms.mongodb.com/users"
  } ],
  "name" : "MyAtlasCluster"
}