Resynchronize Deployments

POST /deployments/_resync

Resynchronizes the search index for all the deployments.

Query parameters

  • When true, skips the document indexing when the version matches the in-memory copy.

    Default value is true.

Responses

  • The deployments resync operation executed successfully.

    Hide response attributes Show response attributes object
    • created array[string] Required

      The ids of documents created in the index by index version

    • updated array[string] Required

      The ids of documents updated in the index by index version

    • deleted array[string] Required

      The ids of documents deleted from the index by index version

    • errors array[string] Required

      The regions where document synchronization may have failed

  • The deployments resync operation failed. (code: deployments.resync_failed)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is deployments.resync_failed.

    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

POST /deployments/_resync
curl \
 -X POST https://{{hostname}}/api/v1/deployments/_resync
Response examples (200)
{
  "created": [
    "string"
  ],
  "updated": [
    "string"
  ],
  "deleted": [
    "string"
  ],
  "errors": [
    "string"
  ]
}
Response examples (500)
# Headers
x-cloud-error-codes: deployments.resync_failed

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