It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Set AppSearch read-only status
editSet AppSearch read-only status
editEnable/Disable read-only mode on the given App Search resource.
Request
editGET /api/v1/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
User-specified RefId for the Resource. |
Responses
edit-
200 -
(
ReadOnlyResponse) Standard response -
404 -
(
BasicFailedReply) The Resource specified by ref_id cannot be found. (code:deployments.deployment_resource_not_found)Headers
-
x-cloud-error-codes(string; allowed values: [deployments.deployment_resource_not_found]) - The error codes associated with the response
-
-
500 -
(
BasicFailedReply) We have failed you. (code:deployments.deployment_resource_no_longer_exists)Headers
-
x-cloud-error-codes(string; allowed values: [deployments.deployment_resource_no_longer_exists]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XGET https://{{hostname}}/api/v1/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode \
-H "Authorization: ApiKey $ECE_API_KEY"