Set AppSearch read-only status

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Set AppSearch read-only status

edit

Enable/Disable read-only mode on the given App Search resource.

Request

edit

PUT /api/v1/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment.
`ref_id`	`string`	Y	User-specified RefId for the Resource.

Request body

edit

(ReadOnlyRequest) (required) read-only request body

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

449

(BasicFailedReply)

Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]): 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

Request example

edit

curl -XPUT https://{{hostname}}/api/v1/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "enabled" : true
}
'

« Set AppSearch read-only status Authentication »