Press CTRL+K to open search

Update replication target state

Prev Next
Post
/replication-targets/status

Update replication status and/or last replication timestamp for a Replication Target. This API endpoint can only be used by target collectives.

Security
HTTP
Type bearer
Body parameters

Replication Target status update request. It's an internal API to be used by the replication service of the target collective.

Expand All
object

Update status and details for the last replication attempt.

status
string Required

Replication status.

Valid values[ "notConnected", "error", "warning", "healthy" ]
lastReplicationTime
string (date-time) Required

Last replication timestamp.

nextReplicationTime
string (date-time) Required

Scheduled timestamp for the next replication attempt.

lastReplicationDetails
object (ReplicationDetails)
error
string

Error message from the last replication attempt that failed.

items
object (ReplicationItems)
administrativeRoles
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

clientProfiles
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

conditions
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

criteriaScripts
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

deviceClaimScripts
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

entitlementScripts
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

entitlements
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

identityProviders
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

ipPools
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

mfaProviders
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

policies
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

ringfenceRules
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

sites
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

tags
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

userClaimScripts
object (ReplicationReportItem)
successCount
number Required

Number of successful replications for this object type.

failureCount
number Required

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError) Required

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string Required

Name of the object that failed to replicate.

message
string Required

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

Responses
200
Expand All
object

Represents a Replication Target.

id
string (uuid)

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
name
string

Name of the object.

Exampleobject
notes
string

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.
created
string (date-time)

Create date.

updated
string (date-time)

Last update date.

replicationTags
Array of string

Tags used for selecting items to replicate to this target. The tag builtin is not permitted.

string
status
string

Replication status.

Valid values[ "notConnected", "healthy", "warning", "error" ]
lastReplicationTime
string (date-time)

Last replication timestamp.

sourceHealthMessage
string

Source-side health check message that explains a controller-detected issue affecting this target’s status.

lastReplicationDetails
object (ReplicationDetails)
error
string

Error message from the last replication attempt that failed.

items
object (ReplicationItems)
administrativeRoles
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

clientProfiles
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

conditions
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

criteriaScripts
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

deviceClaimScripts
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

entitlementScripts
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

entitlements
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

identityProviders
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

ipPools
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

mfaProviders
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

policies
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

ringfenceRules
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

sites
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

tags
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

userClaimScripts
object (ReplicationReportItem)
successCount
number

Number of successful replications for this object type.

failureCount
number

Number of failed replications for this object type.

errors
Array of object (ReplicationReportError)

Errors for individual objects that failed to replicate.

object
id
string (uuid)

ID of the object that failed, if available.

name
string

Name of the object that failed to replicate.

message
string

Failure reason.

field
string

Optional field name that caused the failure, if applicable.

401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

404

The requested resource can not be found.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

422

Request validation error. Check "errors" array for details.

Expand All
object

Http 422 error for object validation.

id
string

Machine readable error code.

message
string

Human readable error details.

errors
Array of object

List of fields with validation errors.

object
field
string

Name of the field that failed validation.

Examplename
message
string

Failure reason.

Examplemay not be null
displayField
string

Name of the field that should be displayed in the UI. It's an internal field to be used by the local replication service.

ExampleName
replicationMessage
string

Message to be displayed in the replication UI. It's an internal field to be used by the local replication service.

ExampleName is required.
500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

©AppGate 2026. All Rights Reserved.