PingOne Platform APIs - Early Access

Snapshots

A snapshot is a point in time representation of any configuration resource in PingOne. A snapshot is triggered when the request POST {{apiPath}}/environments/{{envID}}/snapshots is called. The configuration resource, and optionally all of its dependencies, are then stored by the Snapshot service. The snapshots are stored and indexed using the original identifier (ID) of the configuration resource. For example, an applications snapshot will be stored using the ID of the application. Subsequent calls to the request POST {{apiPath}}/environments/{{envID}}/snapshots for the same configuration resource generates a new version of the configuration resource each time the request is called. You can retrieve the version history of any configuration resource using the original identifier of the resource. You’ll use the snapshot created for a configuration resource to promote (apply) the configuration resource from the source environment to another environment.

You need to create a snapshot if you want to assign promotion variables.

Snapshots data model

Property Type Required? Mutable? Description

baseResourceURL

String

Required

Mutable

The URL of the resource to use. The form is: "https://api.pingone.com/v1/environments/{{envId}}/{{resourceName}}/{{resourceId}}", where "resourceName" is the name of the configuration resource to snapshot.

createdAt

Date

N/A

Read-only

The date and time at which the resource was created (ISO 8601 format).

completedAt

Date

N/A

Read-only

The date and time at which the snapshot creation was completed (ISO 8601 format).

configuration

Object

N/A

Read-only

The JSON representation of the configuration resource. Any attributes containing sensitive information in plain text (such as, display names, client secrets, passwords) are masked in the responses, and aren’t available to any caller, even administrators. If the configuration resource has been deleted, this will be empty (null).

error

String

N/A

Read-only

If an error occurs while creating the snapshot, it’s returned here.

id

String

Required

Immutable

The identifier of the configuration resource.

resourceId

String

Optional

Mutable

The identifier of the configuration resource.

resourceUrl

String

Optional

Mutable

The URL of the configuration resource.

referencedResources

String[]

Optional

Mutable

The list of identifiers for any dependent or referenced configuration resources. The dependent or referenced resources can be only one level down in the possible tree of such resources.

snapshotId

String

N/A

Read-only

The identifier of the snapshot.

startedAt

Date

N/A

Read-only

The date and time at which the snapshot creation was started (ISO 8601 format).

status

String

N/A

Read-only

The status of the snapshot creation process. This can be any one of: COMPLETE, WAITING, IN_PROGRESS, ERROR.

updatedAt

Date

N/A

Read-only

The date and time at which the resource was last updated (ISO 8601 format).

versionedAt

Date

N/A

Read-only

The date and time of the updatedAt property on the original resource. For deleted events, this will be the date and time the event was published.