---
title: "Ready returns OK if the connection to Elasticsearch was successfully established."
url: "https://developer-qual.migros.ch/apis/content-search-api-qual-v1/versions/ced47038-88c7-4cc8-ad02-7627c04ce4d1/operations/ContentSearch_Ready"
---

> Full API specification: https://developer-qual.migros.ch/apis/content-search-api-qual-v1/versions/ced47038-88c7-4cc8-ad02-7627c04ce4d1.md

# Ready returns OK if the connection to Elasticsearch was successfully established.

`GET` `/migros/contentsearch/v1/health/readyz`

Operation ID: `ContentSearch_Ready`

## Responses

- `200` - A successful response.
- `default` - An unexpected error response.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: ContentSearch API QUAL
  version: v1.115.0
servers:
  - url: https://api-qual.migros.ch
paths:
  /migros/contentsearch/v1/health/readyz:
    get:
      operationId: ContentSearch_Ready
      responses:
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/contentsearchReadyResponse"
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/googlerpcStatus"
          description: An unexpected error response.
      security:
        - apiKeyAuth: []
      summary: |-
        Ready returns OK if the connection to Elasticsearch was successfully
        established.
      tags:
        - ContentSearch
security:
  - apiKeyAuth: []
components:
  schemas:
    contentsearchReadyResponse:
      properties:
        elasticsearch:
          description: Provides information on whether Elasticsearch is UP.
          type: string
      type: object
    googlerpcStatus:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            allOf:
              - $ref: "#/components/schemas/protobufAny"
            type: object
          type: array
        message:
          type: string
      type: object
    protobufAny:
      additionalProperties: {}
      properties:
        "@type":
          type: string
      type: object
  securitySchemes:
    apiKeyAuth:
      in: header
      name: X-Api-Key
      type: apiKey
```