App Search - Read-only

Set AppSearch read-only status

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

Request

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

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment.

ref_id

string

Y

User-specified RefId for the Resource.

Responses

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

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 status

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

Request

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

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment.

ref_id

string

Y

User-specified RefId for the Resource.

Request body

(ReadOnlyRequest) (required) read-only request body

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

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