Navigation

Rename an 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

PATCH /orgs/{ORG-ID}
NameTypeDescription
ORG-IDstringThe id of the organization that you want to rename.

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
NameTypeDescription
namestringThe new name for the organization.
NameTypeDescription
idObjectIdUnique identifier for the organization.
linksdocument arrayOne or more links to sub-resources and/related resources. The relations between URLs are explained in the Web Linking Specification.
namestringNew name of the organization.
curl -X PATCH --include --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --header "Content-Type: application/json" \
"https://cloud.mongodb.com/api/atlas/v1.0/orgs/6001f2c580eef55aedbc6bb1?pretty=true" \
--data '{"name":"MyAtlasCluster"}'
{
"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"
}
Give Feedback