App Search - Read-only | Elasticsearch Service Documentation

› › ›

App Search - Read-onlyedit

Set AppSearch read-only statusedit

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

Requestedit

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

Path parametersedit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment.
`ref_id`	`string`	Y	User-specified RefId for the Resource (or '_main' if there is only one).

Responsesedit

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

Request exampleedit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode \
-H "Authorization: ApiKey $EC_API_KEY"

Set AppSearch read-only statusedit

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

Requestedit

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

Path parametersedit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment.
`ref_id`	`string`	Y	User-specified RefId for the Resource (or '_main' if there is only one).

Request bodyedit

(ReadOnlyRequest) (required) read-only request body

Responsesedit

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 exampleedit

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

« Accounts Authentication »