---
type: api
title: Set AppSearch read-only status
description: Enable/Disable read-only mode on the given App Search resource.
url: https://www.elastic.co/elastic/docs-builder/docs/4641/api/doc/cloud-enterprise/operation/operation-get-appsearch-read-only-mode
resource: https://www.elastic.co/elastic/docs-builder/docs/4641/api/doc/cloud-enterprise/operation/operation-get-appsearch-read-only-mode
products:
  - Elastic Cloud Enterprise
---

# Set AppSearch read-only status

Authentication: required

## Paths

- `GET` `/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode`

#### 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).

## Description

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

## Responses

#### `200`

Standard response

`application/json`

- `enabled` (boolean)
  Whether read-only mode is enabled or disabled
#### `404`

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

`application/json`

- `errors` (object[])
  A list of errors that occurred in the failing request
  - `code` (string)
    A structured code representing the error type that occurred
  - `message` (string)
    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

#### `500`

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

`application/json`

- `errors` (object[])
  A list of errors that occurred in the failing request
  - `code` (string)
    A structured code representing the error type that occurred
  - `message` (string)
    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

## Code examples

#### curl

```curl
curl -X GET "${API_URL}/deployments/${DEPLOYMENT_ID}/appsearch/${REF_ID}/read_only_mode" \
  -u "${USERNAME}:${PASSWORD}"
```

## Response examples

#### 200

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "enabled": false
}
```

#### 404

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
```

#### 500

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
```