API
Start typing to search…

Get change status

get https://{hostname}/cps/v2/enrollments//changes/

Gets the status of a pending change.

Path Params
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.

Response

Response body
object
allowedInput
array of objects
required
length ≥ 0

The resource path locations of data inputs allowed by this change. These could be required or optional for this change to proceed.

allowedInput*
object
string
required
length ≥ 1

The resource location for the allowed input's description.

boolean
required

If true, this input is required for the change to proceed.

string
required
length ≥ 1

The type input. For more information, see the Change control.

string
required
length ≥ 1

The resource path location that you can use to make a call for this input.

statusInfo
object
required

The status for this change at this time.

deploymentSchedule
object
required

The schedule for when you want this change to deploy.

string
required
length ≥ 1

A description of the change's current status.

object | null

Error information for this change.

string
required

The change request's state. A value of new means the certificate is processed but the renewal process is not started. A running value means CPS is preparing to send your certificate to Let's Encrypt. An awaiting-input value means the process is waiting on a user input, for example the approval or denial of a change management item. A suspended value indicates the process didn't complete. A value of cancelled means the process has been cancelled permanently, A completed value means the change request is finished. An error value means there's an issue with the domain.

new running awaiting-input suspended cancelled completed error

string
required
length ≥ 1

The general status of the change. This is a high level of description of the status for the change. See Status values and descriptions for the list of possible status values this operation may return.

Updated 6 months ago

Did this page help you?
Language
Authentication
Remember to add your authentication credentials to run this code.
URL

Updated 6 months ago

Did this page help you?