Get a change

get https://{hostname}/cps/v2/enrollments/{enrollmentId}/changes/{changeId}/input/info/{allowedInputTypeParam}

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

allowedInputTypeParam

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.

changeId

integer

required

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

enrollmentId

integer

required

Enrollment on which to perform the desired operation.

Query Params

accountSwitchKey

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

acknowledgementDeadline

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.

errors

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

message

string

required

length ≥ 1

Descriptive text for the error.

messageCode

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

message

string

required

length ≥ 1

Descriptive text for the warning.

messageCode

string

required

length ≥ 1

Unique code for the warning.

validationResultHash

string

required

length ≥ 1

The hash of the validation result.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/cps/v2/enrollments/enrollmentId/changes/changeId/input/info/change-management-info \
3
     --header 'Accept: application/vnd.akamai.cps.csr.v2+json'


xxxxxxxxxx
26
}
1
{
2
  "acknowledgementDeadline": null,
3
  "pendingState": {
4
    "pendingCertificate": {
5
      "certificateType": "third-party",
6
      "fullCertificate": "-----BEGIN CERTIFICATE-----\nMIID2DCCAsCgAwIBAgIQ661T ... qsdFdLrZlpsIQwpLqdgKZlSw==\n-----END CERTIFICATE-----",
7
      "signatureAlgorithm": "SHA-256"
8
    },
9
    "pendingNetworkConfiguration": {
10
      "mustHaveCiphers": "ak-akamai-2020q1",
11
      "networkType": null,
12
      "preferredCiphers": "ak-akamai-2020q1",
13
      "sni": null
14
    }
15
  },
16
  "validationResult": {
17
    "errors": null,
18
    "warnings": [
19
      {
20
        "message": "[SAN name [san9.example.com] removed from certificate is still live on the network., SAN name [san8.example.com] removed from certificate is still live on the network.]",
21
        "messageCode": "no-code"
22
      }
23
    ]
24
  },
25
  "validationResultHash": "da39a3ee5e6b4b0d3255bfef95601890afd80709"

200The response reflects the change's details requested in the Accept header.

`Accept` header.