API - Delete a Dedicated Environment

Cluster Management

Removes a dedicated environment of your account: its servers and everything on them.

Endpointhttps://opensolr.com/solr_manager/api/delete_environment
MethodGET
Authemail and api_key of your account, as GET or POST parameters: Authentication. A scoped key limited to some indexes is refused: this call acts on the whole account.
This cannot be undone. Make and download the backups you need first: create_backup.

01 · Parameters

env_nameRequired

The name of the environment.

02 · Example

curl -s "https://opensolr.com/solr_manager/api/delete_environment?email=YOUR_EMAIL&api_key=YOUR_API_KEY&env_name=YOUR_ENVIRONMENT"

03 · Answer

On success the body is empty: the removal is queued. When the environment is not yours, the body is plain text:

Not Owner!
Please fix the errors above!
ERROR_SCOPED_KEY_ACCOUNT_LEVEL_NOT_ALLOWEDHTTP 403

A scoped key limited to some indexes was used.

ERROR_AUTHENTICATION_FAILEDHTTP 403

The email and API key do not match.

04 · Related

Create a cluster index: create_cluster.

Every error code and HTTP status of the API: API errors. Calls per minute and per hour: Rate limits.