Set AppSearch read-only status

Base URL
https://api.elastic-cloud.com/api/v1
No auth

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

Path parameters

deployment_id string required

Identifier for the Deployment.

ref_id string required

User-specified RefId for the Resource (or '_main' if there is only one).

Request body

read-only request body

enabled boolean required

Enabled or disabled read-only mode

Responses

Standard response

application/json
enabled boolean required

Whether read-only mode is enabled or disabled

The Resource specified by ref_id cannot be found. (code: deployments.deployment_resource_not_found)

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

We have failed you. (code: deployments.deployment_resource_no_longer_exists)

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

Base URL
https://api.elastic-cloud.com/api/v1