Replication

List replication rules

List all replication rules

Securityx-api-key

Request

query Parameters

space_ref

string

Reference to the scope in which the registry exists.

Format depends on the scope:

Account-level: account_id/+
Organization-level: account_id/org/+
Project-level: account_id/org/project/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Examples:

Account-level registry

Only account ID, scoped at account level

space_ref=acc123/+

Organization-level registry

Account and org, scoped at org level

space_ref=acc123/org456/+

Project-level registry

Account, org, and project, scoped at project level

space_ref=acc123/org456/proj789/+

Responses

200

Response for list replication rules

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/replication/rules

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"itemCount": 1,
"pageCount": 100,
"pageIndex": 0,
"pageSize": 10,
"rules": [{"allowedPatterns": ["string"
],
"blockedPatterns": ["string"
],
"createdAt": "string",
"destination": {"registryIdentifier": "string"
},
"destinationType": "Local",
"identifier": "string",
"modifiedAt": "string",
"parentRef": "string",
"source": {"registryIdentifier": "string"
},
"sourceType": "Local"
}
]
},
"status": "SUCCESS"
}

Create a replication rule

Securityx-api-key

Request

query Parameters

space_ref

string

Reference to the scope in which the registry exists.

Format depends on the scope:

Account-level: account_id/+
Organization-level: account_id/org/+
Project-level: account_id/org/project/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Examples:

Account-level registry

Only account ID, scoped at account level

space_ref=acc123/+

Organization-level registry

Account and org, scoped at org level

space_ref=acc123/org456/+

Project-level registry

Account, org, and project, scoped at project level

space_ref=acc123/org456/proj789/+

Request Body schema: application/json

request for create and update replication rule

allowedPatterns required	Array of strings
blockedPatterns required	Array of strings
required	LocalReplicationRegistry (object) or JfrogReplicationRegistry (object) (ReplicationRegistry)
destinationType required	string Enum: "Local" "Jfrog" "GCP"
required	LocalReplicationRegistry (object) or JfrogReplicationRegistry (object) (ReplicationRegistry)
sourceType required	string Enum: "Local" "Jfrog" "GCP"

Responses

200

Response for replication rule update

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

post/har/api/v1/replication/rules

Request samples

Payload
curl
Java
Go

application/json

{"allowedPatterns": ["string"
],
"blockedPatterns": ["string"
],
"destination": {"registryIdentifier": "string"
},
"destinationType": "Local",
"source": {"registryIdentifier": "string"
},
"sourceType": "Local"
}

Response samples

application/json

{"data": {"allowedPatterns": ["string"
],
"blockedPatterns": ["string"
],
"createdAt": "string",
"destination": {"registryIdentifier": "string"
},
"destinationType": "Local",
"identifier": "string",
"modifiedAt": "string",
"parentRef": "string",
"source": {"registryIdentifier": "string"
},
"sourceType": "Local"
},
"status": "SUCCESS"
}

Delete a replication rule

Securityx-api-key

Request

path Parameters

required

string

Responses

200

Success Response

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

delete/har/api/v1/replication/rules/{id}

Request samples

curl
Java
Go

Response samples

application/json

{"status": "SUCCESS"
}

Get a replication rule

Securityx-api-key

Request

path Parameters

required

string

Responses

200

Response for replication rule update

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/replication/rules/{id}

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"allowedPatterns": ["string"
],
"blockedPatterns": ["string"
],
"createdAt": "string",
"destination": {"registryIdentifier": "string"
},
"destinationType": "Local",
"identifier": "string",
"modifiedAt": "string",
"parentRef": "string",
"source": {"registryIdentifier": "string"
},
"sourceType": "Local"
},
"status": "SUCCESS"
}

Update a replication rule

Securityx-api-key

Request

path Parameters

required

string

Request Body schema: application/json

request for create and update replication rule

allowedPatterns required	Array of strings
blockedPatterns required	Array of strings
required	LocalReplicationRegistry (object) or JfrogReplicationRegistry (object) (ReplicationRegistry)
destinationType required	string Enum: "Local" "Jfrog" "GCP"
required	LocalReplicationRegistry (object) or JfrogReplicationRegistry (object) (ReplicationRegistry)
sourceType required	string Enum: "Local" "Jfrog" "GCP"

Responses

200

Response for replication rule update

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

put/har/api/v1/replication/rules/{id}

Request samples

Payload
curl
Java
Go

application/json

{"allowedPatterns": ["string"
],
"blockedPatterns": ["string"
],
"destination": {"registryIdentifier": "string"
},
"destinationType": "Local",
"source": {"registryIdentifier": "string"
},
"sourceType": "Local"
}

Response samples

application/json

{"data": {"allowedPatterns": ["string"
],
"blockedPatterns": ["string"
],
"createdAt": "string",
"destination": {"registryIdentifier": "string"
},
"destinationType": "Local",
"identifier": "string",
"modifiedAt": "string",
"parentRef": "string",
"source": {"registryIdentifier": "string"
},
"sourceType": "Local"
},
"status": "SUCCESS"
}

List migration images

List migration images given an id

Securityx-api-key

Request

path Parameters

required

string

query Parameters

page	integer <int64> Default: 1 Current page number
size	integer <int64> Default: 20 Number of items per page
sort_order	string sortOrder
sort_field	string sortField

Responses

200

Response for list migration images

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/replication/rules/{id}/migration/images

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"images": [{"imageId": "string",
"imageTag": "string",
"progress": 0,
"status": "string"
}
],
"itemCount": 1,
"pageCount": 100,
"pageIndex": 0,
"pageSize": 1
},
"status": "SUCCESS"
}

Get migration logs for an image

Securityx-api-key

Request

path Parameters

id required	string
image_id required	string

Responses

200

A plain text response

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/replication/rules/{id}/migration/images/{image_id}/logs

Request samples

curl
Java
Go

Response samples

application/json

{"code": "404",
"details": { },
"message": "string"
}

Start migration

Start migration given an id

Securityx-api-key

Request

path Parameters

required

string

Responses

200

Success Response

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

post/har/api/v1/replication/rules/{id}/migration/start

Request samples

curl
Java
Go

Response samples

application/json

{"status": "SUCCESS"
}

Stop migration

Stop migration given an id

Securityx-api-key

Request

path Parameters

required

string

Responses

200

Success Response

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

post/har/api/v1/replication/rules/{id}/migration/stop

Request samples

curl
Java
Go

Response samples

application/json

{"status": "SUCCESS"
}

➔ Next to Spaces