Change Environment | Captain Docs

Move a collection between environments without reindexing.

collection_namestringRequired

This endpoint expects an object.

new_environmentenumRequired

Allowed values:

Successful Response

collection_namestring

files_movedinteger

messagestring

new_environmentstring

previous_environmentstring

successboolean

1	import requests
2
3	url = "https://host.com/v2/collections/collection_name/environment"
4
5	payload = { "new_environment": "development" }
6	headers = {"Content-Type": "application/json"}
7
8	response = requests.patch(url, json=payload, headers=headers)
9
10	print(response.json())

1	{
2	"collection_name": "collection_name",
3	"files_moved": 1,
4	"message": "message",
5	"new_environment": "new_environment",
6	"previous_environment": "previous_environment",
7	"success": true
8	}