Get a change

Get detailed information of a pending change. Below is a sample where allowedInput[].type has the value third-party-csr. The acceptable Accept header depends on the value of the allowedInput.type for the Change instance. See Change control for details.

Path Params
string
required

Enum Found as the last part of Change.allowedInput[].update hypermedia URL. See Change control for details. Currently supported values include change-management-info, lets-encrypt-challenges, post-verification-warnings, pre-verification-warnings, third-party-csr.

integer
required

The change for this enrollment on which to perform the desired operation.

integer
required

Enrollment on which to perform the desired operation.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Headers
string
required

Enum Specifies the response type.

Response

Accept header.

Response body
object
string | null

ISO 8601 timestamp for the user's deadline to acknowledge the change management validation result, before CPS deploys the pending state to the live network. The value is null if there's no existing certificate on the network for the current enrollment.

pendingState
object
required

The snapshot of the pending state for the enrollment when this change takes effect.

pendingCertificate
object

The snapshot of the pending certificate for the enrollment when this change takes effect.

pendingNetworkConfiguration
object
required

The snapshot of the pending network configuration for the enrollment when this change takes effect.

validationResult
object

Provides information about the hash's most recent validation check, indicating the change's current job state. This object appears in the response, even when its value is null. Before you run the Update a change operation, review the change's validation results and resolve any issues.

array of objects | null
required

Validation errors of the current job state. Errors prevent a change from proceeding until you resolve them. They are optional and only appear if there are any errors.

errors*
object
string
required
length ≥ 1

Descriptive text for the error.

string
required
length ≥ 1

Unique code for the error.

warnings
array of objects
required
length ≥ 0

Validation warnings of the current job state. Warnings suspend the execution of a change. You can acknowledge or deny warnings. If you acknowledge them, the change proceeds with its operation. They are optional and only appear if there are any warnings.

warnings*
object
string
required
length ≥ 1

Descriptive text for the warning.

string
required
length ≥ 1

Unique code for the warning.

string
required
length ≥ 1

The hash of the validation result.

Language
Authentication
URL