Resynchronize Deployment

POST /deployments/{deployment_id}/_resync

Immediately resynchronizes the search index for the selected deployment.

Path parameters

deployment_id string Required

Identifier for the Deployment

Responses

200

The deployment 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
500

The deployment resync operation failed for deployment {deployment_id}. (code: deployments.resync_failed)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  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/{deployment_id}/_resync

curl \
 -X POST https://{{hostname}}/api/v1/deployments/{deployment_id}/_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"
      ]
    }
  ]
}