Set AppSearch read-only status

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

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

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

application/json

View as Markdown

Examples

Request curl 1 / 1 language

curl Shell

curl -X PUT "${API_URL}/deployments/${DEPLOYMENT_ID}/appsearch/${REF_ID}/read_only_mode" \
  -u "${USERNAME}:${PASSWORD}" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false
  }'

Generated from the API spec

Response

{
  "enabled": false
}

Generated from the API spec

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

Generated from the API spec

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

Generated from the API spec

Set AppSearch read-only status

Path parameters

Request body

Responses

Response headers

Response headers

Path parameters

Request body { }

Responses

Response headers

Response headers

Request body