Set AppSearch read-only status

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

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

Body Required

read-only request body

  • enabled boolean Required

    Enabled or disabled read-only mode

Responses

  • 200

    Standard response

    Hide response attribute Show response attribute object
    • enabled boolean Required

      Whether read-only mode is enabled or disabled
  • 404

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

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is deployments.deployment_resource_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • 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 array[string]

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

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

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is deployments.deployment_resource_no_longer_exists.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • 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 array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
PUT /deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode 
curl \
 -X PUT https://{{hostname}}/api/v1/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode \
 -d '{"enabled":true}'
Request examples 
{
  "enabled": true
}
Response examples (200) 
{
  "enabled": true
}
Response examples (404) 
# Headers
x-cloud-error-codes: deployments.deployment_resource_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (500) 
# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists

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