Change Environment

PATCH

https://api.runcaptain.com/v2/collections/:collection_name/environment

Move a collection between environments without reindexing.

collection_namestringRequired

This endpoint expects an object.

new_environmentenumRequired

Successful Response

collection_namestring

files_movedinteger

messagestring

new_environmentstring

previous_environmentstring

successboolean

1	import json
2	import requests
3	import uuid
4
5	BASE_URL = "https://api.runcaptain.com"
6	API_KEY = "your_api_key"
7	COLLECTION_NAME = "my_documents"
8
9	headers = {
10	"Authorization": f"Bearer {API_KEY}",
11	"Content-Type": "application/json",
12	"Idempotency-Key": str(uuid.uuid4()),
13	}
14
15	response = requests.patch(
16	f"{BASE_URL}/v2/collections/{COLLECTION_NAME}/environment",
17	headers=headers,
18	json={
19	"new_environment": "development"
20	},
21	timeout=30.0
22	)
23
24	print(json.dumps(response.json(), indent=2))