Snapshot Entity
Use snapshot in conjunction with Connect’s deploy commands to migrate Connect domain objects from one environment to another.
| The following are the attributes in the body of a deploy service. | |||
| Attribute | Type | Updatable | Comments |
|---|---|---|---|
| id | UUID | no | (Required for PUT only)
For PUT the ID in body must valid ID and must match step on the URL. For POST this is ignored. |
| version | no | This may be shown to the user for informational purposes only. (Deployment is immutable and it’s version would never change.) | |
| name | string | yes | Unique among other variables |
| description | string | yes | |
| snapshot_type | enum | no | Deploy(0), Revert(1), User(2); |
| content_in_json | string | no | Deployment in JSON string. |
| createdInstant | datetime | no | |
| createdBy | string | no | Username associated with session |
| modifiedInstant | datetime | no | |
| modifiedBy | string | no | Username associated with session |
List of APIs
Note: We have tried to keep this list up to date. However, for the most up to date list, see the interactive docs: https://connect-i1.xactlycorp.com/connect/docs/swagger-ui.html
POST /connect/v1/snapshotscreateSnapshot
GET /connect/v1/snapshotsGet a paginated list of all Snapshot definitions. You can provide a page number (default 0) and a page size (default 100, max 1000). A description of the pagination pattern and metadata can be found here: [LINK]
GET /connect/v1/snapshots/{id}Get a snapshot definition. You have to provide a valid snapshot ID.
POST /connect/v1/snapshots/{id}/restoreRestore the state of the domain objects to a this snapshot. This replaces deprecated /v1/revert API. Deployment will be restored to exactly how it was as of this snapshot ID.This is an asynchronous call that causes an invocation to be kicked off. The resulting invocation resource location is returned in the Location header.