---
title: "Synchronize instances"
method: POST
path: "/api/v2/distributed-instances/local/synchronize"
tags: ["v2 distributed instances"]
---

# Synchronize instances

`POST /api/v2/distributed-instances/local/synchronize`

Synchronizes instances

## Request body

- LocalInstance
  - `id` string
  - `name` string
  - `lastSynchronizationDate` string, date-time
  - `createdOn` string, date-time
  - `createdBy` string
  - `updatedOn` string, date-time
  - `updatedBy` string
  - `status` 'CREATED' | 'ACTIVE' | 'INACTIVE' | 'APPLYINGIDENTIFIER' | 'SYNCHRONIZING'
  - `entitySummaryList` EntitySummary[]
    - `entityClass` string
    - `count` integer
    - `countAddedUpdated` integer
    - `countRemoved` integer
    - `countIssues` integer
  - `accessKey` string
  - `centralInstanceURL` string
  - `isSubscribed` boolean

## Response `201`

Created

- Job
  - `id` string
  - `name` string
  - `username` string
  - `startDate` string, date-time
  - `endDate` string, date-time
  - `state` 'CREATED' | 'STARTED' | 'COMPLETED' | 'FAILED_DURING_CREATION' | 'FAILED_TO_COMPLETE' | 'STOPPED' | 'STOPPING' | 'TO_BE_CLEANED' | 'PENDING_APPROVAL' | 'REJECTED' | 'SCHEDULED'
  - `stateDetails` string
  - `instanceId` string
  - `jobUsersDetails` JobUserDetails[]
    - `username` string
    - `fullname` string
    - `email` string
    - `role` string
  - `instanceName` string
  - `jobStats` JobStats
    - `completionPercentage` integer
    - `sourceObjectsCount` integer
    - `sourceObjectsBeingProcessed` integer
    - `sourceObjectsWaitingToBeProcessed` integer
    - `sourceObjectsProcessedWithSuccess` integer
    - `sourceObjectsProcessedWithPartialSuccess` integer
    - `sourceObjectsProcessedWithFailure` integer
    - `sourceObjectsProcessedWithSkipped` integer
    - `outcomeObjectsWithManualIntervention` integer
  - `plugin` string
  - `pluginType` 'INGEST' | 'INTERNAL' | 'SIP_TO_AIP' | 'AIP_TO_SIP' | 'AIP_TO_AIP' | 'MISC' | 'MULTI'
  - `pluginParameters` object
  - `sourceObjects` SelectedItemsObject
    - `selectedClass` string
    - `type` string, required
  - `outcomeObjectsClass` string
  - `attachmentsList` string[]
  - `fields` object
  - `priority` 'URGENT' | 'HIGH' | 'MEDIUM' | 'LOW'
  - `parallelism` 'LIMITED' | 'NORMAL'
  - `stopping` boolean
  - `inFinalState` boolean

## Other responses

- `404` — Not found

---

[API](https://skmtc.net/keeps/apis/roda-rest-api.md) · [All operations](https://skmtc.net/keeps/apis/roda-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/keeps/roda-rest-api/revisions/afc3c5bcc0d9/schema)