Press CTRL+K to open search

Bulk upsert Replication Targets

Prev Next
Post
/replication-targets/bulk-upsert

Create or update multiple replication targets in a single request.

Security
HTTP
Type bearer
Body parameters

Bulk upsert request.

Expand All
object
data
Array of object (ReplicationTarget) Required
object

Represents a Replication Target.

id
string (uuid)

ID of the object.

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

Name of the object.

Exampleobject
notes
string

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.
replicationTags
Array of string

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

string
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

Bulk upsert report.

Expand All
object
created
Array of object (BulkUpsertEntityRef)
object
id
string (uuid)

ID of the entity.

name
string

Name of the entity.

updated
Array of object (BulkUpsertEntityRef)
object
id
string (uuid)

ID of the entity.

name
string

Name of the entity.

unchanged
Array of object (BulkUpsertEntityRef)
object
id
string (uuid)

ID of the entity.

name
string

Name of the entity.

failures
Array of object (BulkUpsertFailure)
object
id
string (uuid) | null

ID from the request item, if available.

name
string | null

Name from the request item, if available.

error
object (ValidationError)

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.
deleted
Array of object (BulkUpsertEntityRef)

List of deleted entities. It's an internal field to be used by the local replication service.

object
id
string (uuid)

ID of the entity.

name
string

Name of the entity.

400

JSON error. Check the JSON format.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

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.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

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.