Show examples in:
Javascript HTTP
Endpoint info
Available examples

Content Management API > Environment

Rename an environment

Body parameters

type string Required

Must be exactly "environment".

Returns

Returns a resource object of type environment.

Examples

1
PUT https://site-api.datocms.com/environments/:environment_id/rename HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3
5
Content-Type: application/vnd.api+json
6
7
{
8
"data": {
9
"type": "environment",
10
"id": "renamed-sandbox"
11
}
12
}
Terminal window
1
curl -g 'https://site-api.datocms.com/environments/:environment_id/rename' \
2
-X PUT \
3
-H "Authorization: Bearer YOUR-API-TOKEN" \
4
-H "Accept: application/json" \
5
-H "X-Api-Version: 3" \
6
-H "Content-Type: application/vnd.api+json" \
7
--data-binary '{"data":{"type":"environment","id":"renamed-sandbox"}}'
1
await fetch(
2
"https://site-api.datocms.com/environments/:environment_id/rename",
3
{
4
method: "PUT",
5
headers: {
6
Authorization: "Bearer YOUR-API-TOKEN",
7
Accept: "application/json",
8
"X-Api-Version": "3",
9
"Content-Type": "application/vnd.api+json",
10
},
11
body: JSON.stringify({
12
data: { type: "environment", id: "renamed-sandbox" },
13
}),
14
},
15
);
1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6
7
{
8
"data": {
9
"type": "environment",
10
"id": "main",
11
"meta": {
12
"status": "ready",
13
"created_at": "2020-04-21T07:57:11.124Z",
14
"read_only_mode": true,
15
"last_data_change_at": "2020-04-21T07:57:11.124Z",
16
"primary": true,
17
"forked_from": "main"
18
}
19
}
20
}