openapi: 3.0.0 info: title: 'Akamai: API Endpoint Definition Access tokens Changes API' version: '2' license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://{hostname}/api-definitions/v2 tags: - name: Changes paths: /enrollments/{enrollmentId}/changes/{changeId}: parameters: - description: The change for this enrollment on which to perform the desired operation. example: '{{changeId}}' in: path name: changeId required: true schema: example: 10000 type: integer x-akamai: file-path: parameters/changeId-path.yaml - description: Enrollment on which to perform the desired operation. example: '{{enrollmentId}}' in: path name: enrollmentId required: true schema: example: 10000 type: integer x-akamai: file-path: parameters/enrollmentId-path.yaml get: description: Gets the status of a pending change. operationId: get-enrollment-change summary: Get change status tags: - Changes externalDocs: description: See documentation for this operation in Akamai's Certificate Provisioning System API url: https://techdocs.akamai.com/cps/reference/get-enrollment-change responses: '200': description: Successful response. content: application/vnd.akamai.cps.change.v2+json: example: statusInfo: description: Waiting for you to upload and submit your third party certificate and trust chain. error: null state: awaiting-input status: wait-upload-third-party deploymentSchedule: notAfter: null notBefore: null allowedInput: - info: /cps/v2/enrollments/10002/changes/10002/input/info/third-party-csr requiredToProceed: true type: third-party-certificate update: /cps/v2/enrollments/10002/changes/10002/input/update/third-party-cert-and-trust-chain schema: additionalProperties: false description: Any change that you want to make to the network deployment of an enrollment. type: object required: - allowedInput - statusInfo properties: allowedInput: description: The resource path locations of data inputs allowed by this change. These could be required or optional for this change to proceed. type: array items: additionalProperties: false type: object required: - info - requiredToProceed - type - update properties: info: description: The resource location for the allowed input's description. type: string requiredToProceed: description: If `true`, this input is required for the change to proceed. type: boolean type: description: The type input. type: string update: description: The resource path location that you can use to make a call for this input. type: string statusInfo: additionalProperties: false description: The status for this change at this time. type: object required: - deploymentSchedule - description - state - status properties: deploymentSchedule: additionalProperties: false description: The schedule for when you want this change to deploy. type: object properties: notAfter: description: Don't deploy the certificate after this date. nullable: true type: string notBefore: description: Don't deploy the certificate before this date. nullable: true type: string description: description: A description of the current status of the change. type: string error: additionalProperties: false description: Error information for this change. nullable: true type: object required: - code - description - timestamp properties: code: description: The unique identifier code for this error. type: string description: description: The detailed description for this error. type: string timestamp: description: Indicates when this error occurred. type: string state: description: The change request's state. A value of `new` means the certificate is processed but the renewal process is not started. `awaiting-input` means the process is waiting on a user input, for example the approval or denial of a change management item. `suspended` indicates the process didn't complete. A value of `cancelled` means the process has been cancelled permanently. type: string enum: - new - running - awaiting-input - suspended - cancelled - completed - error status: description: The general status of the change. This is a high level of description of the status for the change. See [Status values and descriptions](https://techdocs.akamai.com/cps/reference/status-values-and-descriptions) for the list of possible status values this operation may return. type: string x-akamai: file-path: schemas/change.v2.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string delete: description: Cancels a pending change. operationId: delete-enrollment-change summary: Cancel a change tags: - Changes externalDocs: description: See documentation for this operation in Akamai's Certificate Provisioning System API url: https://techdocs.akamai.com/cps/reference/delete-enrollment-change responses: '200': description: Successful response. content: application/vnd.akamai.cps.change-id.v1+json: example: change: /cps/v2/enrollments/10002/changes/10002 schema: additionalProperties: false type: object required: - change properties: change: type: string x-akamai: file-path: schemas/change-id.v1.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /enrollments/{enrollmentId}/changes/{changeId}/deployment-schedule: parameters: - description: The change for this enrollment on which to perform the desired operation. example: '{{changeId}}' in: path name: changeId required: true schema: example: 10000 type: integer x-akamai: file-path: parameters/changeId-path.yaml - description: Enrollment on which to perform the desired operation. example: '{{enrollmentId}}' in: path name: enrollmentId required: true schema: example: 10000 type: integer x-akamai: file-path: parameters/enrollmentId-path.yaml get: description: Gets the current deployment schedule settings describing when a change deploys to the network. operationId: get-change-deployment-schedule summary: Get a deployment schedule tags: - Changes externalDocs: description: See documentation for this operation in Akamai's Certificate Provisioning System API url: https://techdocs.akamai.com/cps/reference/get-change-deployment-schedule responses: '200': description: Successful response. content: application/vnd.akamai.cps.deployment-schedule.v1+json: example: notAfter: null notBefore: '2017-05-19T16:00:00Z' schema: additionalProperties: false description: If you want CPS to automatically deploy your certificate, but you do not want the deployment to occur before a certain date and time, you can set a deploy after date. You can only set a deploy after date and time for the renewal of a certificate or for a certificate that is active on the network. The certificate may not deploy the certificate at the exact time and date you specify, but it will not deploy it before that time and date. type: object properties: notAfter: description: The time after when the change will no longer be in effect. This value is an ISO-8601 timestamp. nullable: true type: string notBefore: description: The time that you want change to take effect. If you do not set this, the change occurs immediately, although most changes take some time to take effect even when they are immediately effective. This value is an ISO-8601 timestamp. nullable: true type: string x-akamai: file-path: schemas/deployment-schedule.v1.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /enrollments/{enrollmentId}/changes/{changeId}/input/info/{allowedInputTypeParam}: parameters: - description: __Enum__ Found as the last part of `Change.allowedInput[].update` hypermedia URL. See [Change Input Content Type Mapping](https://techdocs.akamai.com/cps/reference/change-input-content-type-mapping) for details. Currently supported values include `change-management-info`, `lets-encrypt-challenges`, `post-verification-warnings`, `pre-verification-warnings`, `third-party-csr`. example: '{{allowedInputTypeParam}}' in: path name: allowedInputTypeParam required: true schema: example: third-party-csr type: string enum: - change-management-info - lets-encrypt-challenges - post-verification-warnings - pre-verification-warnings - third-party-csr x-akamai: file-path: parameters/allowedInputTypeParam-path.yaml - description: The change for this enrollment on which to perform the desired operation. example: '{{changeId}}' in: path name: changeId required: true schema: example: 10000 type: integer x-akamai: file-path: parameters/changeId-path.yaml - description: Enrollment on which to perform the desired operation. example: '{{enrollmentId}}' in: path name: enrollmentId required: true schema: example: 10000 type: integer x-akamai: file-path: parameters/enrollmentId-path.yaml get: description: 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 Input Content Type Mapping](https://techdocs.akamai.com/cps/reference/change-input-content-type-mapping) for details. operationId: get-change-allowed-input-param summary: Get a change tags: - Changes externalDocs: description: See documentation for this operation in Akamai's Certificate Provisioning System API url: https://techdocs.akamai.com/cps/reference/get-change-allowed-input-param responses: '200': description: Successful response. content: application/vnd.akamai.cps.change-management-info.v1+json: example: acknowledgementDeadline: null validationResultHash: da39a3ee5e6b4b0d3255bfef95601890afd80709 pendingState: pendingCertificate: certificateType: third-party fullCertificate: '-----BEGIN CERTIFICATE----- MIID2DCCAsCgAwIBAgIQ661To2+zTDiFLyyARAaFXTANBgkqhkiG9w0BAQsFADBn MSowKAYDVQQDDCFBS0FNQUkgVEVTVCBJTlRFUk1FRElBVEUgQ0VSVCBbMV0xDjAM BgNVBAsMBVdlYkV4MQ8wDQYDVQQKDAZBa2FtYWkxCzAJBgNVBAgMAk1BMQswCQYD VQQGEwJVUzAeFw0xNzA1MTgyMTEwMTFaFw0xODA1MTkyMTEwMTFaMG0xHDAaBgNV BAMME3d3dy5jcHMtZXhhbXBsZS5jb20xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJN QTESMBAGA1UEBwwJQ2FtYnJpZGdlMQ8wDQYDVQQKDAZBa2FtYWkxDjAMBgNVBAsM BVdlYkV4MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvQeIJ2yfOC8P YQp6NjiCYSCkuS0z9a61v+k+KTDYQKIa8jDkwP0OITzvTnjMHuUd8JbSz5jNb22Z WxH/1F2p71rlSdBReBkZGLMLcQZPt5ju7ea7ZPz+MOWrwuc6YUafRMQk3qMeo3Sz IZQbmLKXkZeYriqy9s9yHJSUnWX1jOa51w6YM/Xar/2pZp2pyguaCNVGp7AAo38R AepaGcFwyjJse6dc+7dHOvDnjQ+Cg2lO8DSc12sFLllOhdOULldZRWbtfTLs9uet iR8ZVpHJ1TtzEz3X9RqBBCvnqykQvMmiQKOkfYEd6LN4Tk6/HJw2/MZhIgAEXtUU dQMnD6OMcwIDAQABo3oweDB2BgNVHREEbzBtghRzYW4xLmNwcy1leGFtcGxlLmNv bYIUc2FuMi5jcHMtZXhhbXBsZS5jb22CFHNhbjMuY3BzLWV4YW1wbGUuY29tghRz YW40LmNwcy1leGFtcGxlLmNvbYITd3d3LmNwcy1leGFtcGxlLmNvbTANBgkqhkiG 9w0BAQsFAAOCAQEAm9krrTxqDwUaO8J7P7CcrHfwXeWiDG3d9uHqCvHRGrcs46pI y8umThgOEba0QHi6CwM6O0+chcHsn6qf+uVKg2u1SKlE6qMIJ1Ppc8MJky1xo0M5 crtRpSXjaoF9S2zZZK1lwOJoK93BtC/lNfRc682TxlQ58jtBI6qnmLXUhF8Yo67v 0UfHiBIv1pZFPIdk90/48vjWM54haNxm/PhxNb6AdzawR4zImUhMKsISP7uOTURQ fFfeNgMvHyI8Id1VPLN+e2y4FtnTVdW2e+PTBvOJ1M+YoFU7M04/2SmKJHqnHljh VQBpto9JgDmt0yqsdFdLrZlpsIQwpLqdgKZlSw== -----END CERTIFICATE-----' signatureAlgorithm: SHA-256 pendingNetworkConfiguration: mustHaveCiphers: ak-akamai-2020q1 networkType: null preferredCiphers: ak-akamai-2020q1 sni: null validationResult: errors: null warnings: - 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.]' messageCode: no-code schema: additionalProperties: false description: After you create an enrollment, you can have CPS halt deployment when the certificate becomes available, so that you can test and view the certificate on a staging server prior to deployment in the production network. If you do not want CPS to automatically deploy the certificate to the production network after it receives the signed certificate from the CA, you can turn change management on for the enrollment. This stops CPS from deploying the certificate to the network until you acknowledge that you are ready to deploy the certificate. A version label indicates this member is introduced in that version. A pre-version label indicates this member is removed in that version. No version label indicates this member is present in all versions. type: object required: - pendingState - validationResultHash properties: acknowledgementDeadline: nullable: true type: string pendingState: additionalProperties: false description: The snapshot of the pending state for the enrollment when this change takes effect. type: object required: - pendingNetworkConfiguration properties: pendingCertificate: additionalProperties: false description: The snapshot of the pending certificate for the enrollment when this change takes effect. type: object required: - certificateType - fullCertificate - signatureAlgorithm properties: certificateType: type: string fullCertificate: type: string signatureAlgorithm: nullable: true type: string pendingNetworkConfiguration: additionalProperties: false description: The snapshot of the pending network configuration for the enrollment when this change takes effect. type: object required: - mustHaveCiphers - preferredCiphers properties: mustHaveCiphers: type: string networkType: nullable: true type: string preferredCiphers: type: string sni: additionalProperties: false description: Server Name Indication (SNI) setting for this Enrollment. nullable: true type: object required: - cloneDnsNames properties: cloneDnsNames: type: boolean dnsNames: type: array items: type: string validationResult: additionalProperties: false description: The hash of `validationResult`. It always has a value, even when `validationResult` is `null`. The hash result of the validation result as of the time of the most recent validation check. It is used in the `change-management-ack` API call to further specify the state of the change that is being acknowledged. We recommend you use the `change-management-info` API call, review the `validationResult` with its hash, and then acknowledge change-management using the same hash retrieved when running the Change Management Acknowledgment operation. type: object properties: errors: description: 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. nullable: true type: array items: additionalProperties: false type: object required: - message - messageCode properties: message: type: string messageCode: type: string warnings: description: 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. type: array items: additionalProperties: false type: object required: - message - messageCode properties: message: type: string messageCode: type: string validationResultHash: type: string x-akamai: file-path: schemas/change-management-info.v1.yaml application/vnd.akamai.cps.change-management-info.v2+json: example: acknowledgementDeadline: null validationResultHash: da39a3ee5e6b4b0d3255bfef95601890afd80709 pendingState: pendingCertificate: certificateType: third-party fullCertificate: '-----BEGIN CERTIFICATE----- MIID2DCCAsCgAwIBAgIQ661To2+zTDiFLyyARAaFXTANBgkqhkiG9w0BAQsFADBn MSowKAYDVQQDDCFBS0FNQUkgVEVTVCBJTlRFUk1FRElBVEUgQ0VSVCBbMV0xDjAM BgNVBAsMBVdlYkV4MQ8wDQYDVQQKDAZBa2FtYWkxCzAJBgNVBAgMAk1BMQswCQYD VQQGEwJVUzAeFw0xNzA1MTgyMTEwMTFaFw0xODA1MTkyMTEwMTFaMG0xHDAaBgNV BAMME3d3dy5jcHMtZXhhbXBsZS5jb20xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJN QTESMBAGA1UEBwwJQ2FtYnJpZGdlMQ8wDQYDVQQKDAZBa2FtYWkxDjAMBgNVBAsM BVdlYkV4MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvQeIJ2yfOC8P YQp6NjiCYSCkuS0z9a61v+k+KTDYQKIa8jDkwP0OITzvTnjMHuUd8JbSz5jNb22Z WxH/1F2p71rlSdBReBkZGLMLcQZPt5ju7ea7ZPz+MOWrwuc6YUafRMQk3qMeo3Sz IZQbmLKXkZeYriqy9s9yHJSUnWX1jOa51w6YM/Xar/2pZp2pyguaCNVGp7AAo38R AepaGcFwyjJse6dc+7dHOvDnjQ+Cg2lO8DSc12sFLllOhdOULldZRWbtfTLs9uet iR8ZVpHJ1TtzEz3X9RqBBCvnqykQvMmiQKOkfYEd6LN4Tk6/HJw2/MZhIgAEXtUU dQMnD6OMcwIDAQABo3oweDB2BgNVHREEbzBtghRzYW4xLmNwcy1leGFtcGxlLmNv bYIUc2FuMi5jcHMtZXhhbXBsZS5jb22CFHNhbjMuY3BzLWV4YW1wbGUuY29tghRz YW40LmNwcy1leGFtcGxlLmNvbYITd3d3LmNwcy1leGFtcGxlLmNvbTANBgkqhkiG 9w0BAQsFAAOCAQEAm9krrTxqDwUaO8J7P7CcrHfwXeWiDG3d9uHqCvHRGrcs46pI y8umThgOEba0QHi6CwM6O0+chcHsn6qf+uVKg2u1SKlE6qMIJ1Ppc8MJky1xo0M5 crtRpSXjaoF9S2zZZK1lwOJoK93BtC/lNfRc682TxlQ58jtBI6qnmLXUhF8Yo67v 0UfHiBIv1pZFPIdk90/48vjWM54haNxm/PhxNb6AdzawR4zImUhMKsISP7uOTURQ fFfeNgMvHyI8Id1VPLN+e2y4FtnTVdW2e+PTBvOJ1M+YoFU7M04/2SmKJHqnHljh VQBpto9JgDmt0yqsdFdLrZlpsIQwpLqdgKZlSw== -----END CERTIFICATE-----' signatureAlgorithm: SHA-256 pendingNetworkConfiguration: mustHaveCiphers: ak-akamai-2020q1 networkType: null preferredCiphers: ak-akamai-2020q1 sni: null disallowedTlsVersions: - TLSv1_2 validationResult: errors: null warnings: - 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.]' messageCode: no-code schema: additionalProperties: false description: After you create an enrollment, you can have CPS halt deployment when the certificate becomes available, so that you can test and view the certificate on a staging server prior to deployment in the production network. If you do not want CPS to automatically deploy the certificate to the production network after it receives the signed certificate from the CA, you can turn change management on for the enrollment. This stops CPS from deploying the certificate to the network until you acknowledge that you are ready to deploy the certificate. type: object required: - pendingState - validationResultHash properties: acknowledgementDeadline: description: The timestamp of the deadline for the user to acknowledge the change management validation result, before CPS automatically proceeds with attempting to deploy the pending state to the live network. The format of the timestamp is ISO-8601. This field is only populated when there's an existing certificate on network for the current enrollment, it's `null` otherwise. nullable: true type: string pendingState: additionalProperties: false description: The snapshot of the pending state for the enrollment when this change takes effect. type: object required: - pendingNetworkConfiguration properties: pendingCertificate: additionalProperties: false description: The snapshot of the pending certificate for the enrollment when this change takes effect. type: object required: - certificateType - fullCertificate - signatureAlgorithm properties: certificateType: description: Either `san`, `single`, `wildcard`, `wildcard-san`, or `third-party`. type: string enum: - san - single - wildcard - wildcard-san - third-party fullCertificate: description: Displays the contents of the certificate. type: string signatureAlgorithm: description: Displays the signature algorithm. nullable: true type: string pendingNetworkConfiguration: additionalProperties: false description: The snapshot of the pending network configuration for the enrollment when this change takes effect. type: object required: - mustHaveCiphers - preferredCiphers properties: disallowedTlsVersions: description: Disallowed TLS protocols. type: array items: type: string mustHaveCiphers: description: Ciphers that you want to include for your enrollment while deploying it on the network. Defaults to `ak-akamai-default` when it is not set. type: string networkType: description: Enrollment network type. nullable: true type: string preferredCiphers: description: Ciphers that you preferably want to include for your enrollment while deploying it on the network. Defaults to `ak-akamai-default` when it is not set. type: string sni: additionalProperties: false description: Server Name Indication (SNI) setting for this Enrollment. nullable: true type: object required: - cloneDnsNames properties: cloneDnsNames: description: All certificate SANs are included in `dnsNames` when `cloneDnsNames` is true. type: boolean dnsNames: description: Names served by SNI-only enabled enrollments. type: array items: type: string validationResult: additionalProperties: false description: The hash of `validationResult`. It always has a value, even when `validationResult` is `null`. The hash result of the validation result as of the time of the most recent validation check. It is used in the `change-management-ack` API call to further specify the state of the change that is being acknowledged. We recommend you use the `change-management-info` API call, review the `validationResult` with its hash, and then acknowledge change-management using the same hash retrieved when running the Change Management Acknowledgment operation. type: object properties: errors: description: 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. nullable: true type: array items: additionalProperties: false type: object required: - message - messageCode properties: message: description: The description of the message. type: string messageCode: description: The unique code of the message. type: string warnings: description: 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. type: array items: additionalProperties: false type: object required: - message - messageCode properties: message: description: The description of the message. type: string messageCode: description: The unique code of the message. type: string validationResultHash: description: The hash of `validationResult`. type: string x-akamai: file-path: schemas/change-management-info.v2.yaml application/vnd.akamai.cps.change-management-info.v4+json: example: acknowledgementDeadline: null validationResultHash: da39a3ee5e6b4b0d3255bfef95601890afd80709 pendingState: pendingCertificate: certificateType: third-party fullCertificate: '-----BEGIN CERTIFICATE----- MIID2DCCAsCgAwIBAgIQ661To2+zTDiFLyyARAaFXTANBgkqhkiG9w0BAQsFADBn MSowKAYDVQQDDCFBS0FNQUkgVEVTVCBJTlRFUk1FRElBVEUgQ0VSVCBbMV0xDjAM BgNVBAsMBVdlYkV4MQ8wDQYDVQQKDAZBa2FtYWkxCzAJBgNVBAgMAk1BMQswCQYD VQQGEwJVUzAeFw0xNzA1MTgyMTEwMTFaFw0xODA1MTkyMTEwMTFaMG0xHDAaBgNV BAMME3d3dy5jcHMtZXhhbXBsZS5jb20xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJN QTESMBAGA1UEBwwJQ2FtYnJpZGdlMQ8wDQYDVQQKDAZBa2FtYWkxDjAMBgNVBAsM BVdlYkV4MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvQeIJ2yfOC8P YQp6NjiCYSCkuS0z9a61v+k+KTDYQKIa8jDkwP0OITzvTnjMHuUd8JbSz5jNb22Z WxH/1F2p71rlSdBReBkZGLMLcQZPt5ju7ea7ZPz+MOWrwuc6YUafRMQk3qMeo3Sz IZQbmLKXkZeYriqy9s9yHJSUnWX1jOa51w6YM/Xar/2pZp2pyguaCNVGp7AAo38R AepaGcFwyjJse6dc+7dHOvDnjQ+Cg2lO8DSc12sFLllOhdOULldZRWbtfTLs9uet iR8ZVpHJ1TtzEz3X9RqBBCvnqykQvMmiQKOkfYEd6LN4Tk6/HJw2/MZhIgAEXtUU dQMnD6OMcwIDAQABo3oweDB2BgNVHREEbzBtghRzYW4xLmNwcy1leGFtcGxlLmNv bYIUc2FuMi5jcHMtZXhhbXBsZS5jb22CFHNhbjMuY3BzLWV4YW1wbGUuY29tghRz YW40LmNwcy1leGFtcGxlLmNvbYITd3d3LmNwcy1leGFtcGxlLmNvbTANBgkqhkiG 9w0BAQsFAAOCAQEAm9krrTxqDwUaO8J7P7CcrHfwXeWiDG3d9uHqCvHRGrcs46pI y8umThgOEba0QHi6CwM6O0+chcHsn6qf+uVKg2u1SKlE6qMIJ1Ppc8MJky1xo0M5 crtRpSXjaoF9S2zZZK1lwOJoK93BtC/lNfRc682TxlQ58jtBI6qnmLXUhF8Yo67v 0UfHiBIv1pZFPIdk90/48vjWM54haNxm/PhxNb6AdzawR4zImUhMKsISP7uOTURQ fFfeNgMvHyI8Id1VPLN+e2y4FtnTVdW2e+PTBvOJ1M+YoFU7M04/2SmKJHqnHljh VQBpto9JgDmt0yqsdFdLrZlpsIQwpLqdgKZlSw== -----END CERTIFICATE-----' ocspStapled: 'false' ocspUris: null signatureAlgorithm: SHA-256 pendingNetworkConfiguration: dnsNameSettings: null mustHaveCiphers: ak-akamai-2020q1 networkType: null ocspStapling: not-set preferredCiphers: ak-akamai-2020q1 quicEnabled: 'false' sniOnly: 'false' disallowedTlsVersions: - TLSv1_2 validationResult: errors: null warnings: - 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.]' messageCode: no-code schema: additionalProperties: false description: After you create an enrollment, you can have CPS halt deployment when the certificate becomes available, so that you can test and view the certificate on a staging server prior to deployment in the production network. If you do not want CPS to automatically deploy the certificate to the production network after it receives the signed certificate from the CA, you can turn change management on for the enrollment. This stops CPS from deploying the certificate to the network until you acknowledge that you are ready to deploy the certificate. type: object required: - pendingState - validationResultHash properties: acknowledgementDeadline: description: The timestamp of the deadline for the user to acknowledge the change management validation result, before CPS automatically proceeds with attempting to deploy the pending state to the live network. The format of the timestamp is ISO-8601. This field is only populated when there's an existing certificate on network for the current enrollment, it's `null` otherwise. nullable: true type: string pendingState: additionalProperties: false description: The snapshot of the pending state for the enrollment when this change takes effect. type: object required: - pendingNetworkConfiguration properties: pendingCertificate: additionalProperties: false description: The snapshot of the pending certificate for the enrollment when this change takes effect. type: object required: - certificateType - fullCertificate - signatureAlgorithm properties: certificateType: description: Either `san`, `single`, `wildcard`, `wildcard-san`, or `third-party`. type: string enum: - san - single - wildcard - wildcard-san - third-party fullCertificate: description: Displays the contents of the certificate. type: string ocspStapled: description: OCSP Stapling improves performance by including a valid OCSP response in every TLS handshake. We recommend all customers enable this feature. type: boolean ocspUris: description: URI used for OCSP stapling validation. nullable: true type: array items: type: string signatureAlgorithm: description: Displays the signature algorithm. nullable: true type: string pendingNetworkConfiguration: additionalProperties: false description: The snapshot of the pending network configuration for the enrollment when this change takes effect. type: object required: - mustHaveCiphers - preferredCiphers - quicEnabled - sniOnly properties: disallowedTlsVersions: description: Disallowed TLS protocols. type: array items: type: string dnsNameSettings: additionalProperties: false description: DNS name settings. nullable: true type: object required: - cloneDnsNames properties: cloneDnsNames: description: All certificate SANs are included in `dnsNames` when `cloneDnsNames` is true. type: boolean dnsNames: description: Names served by SNI-only enabled enrollments. type: array items: type: string mustHaveCiphers: description: Ciphers included for your enrollment while deploying it on the network. type: string networkType: description: Enrollment network type. nullable: true type: string ocspStapling: description: OCSP stapling setting for the deployment. type: string preferredCiphers: description: Ciphers included for your enrollment while deploying it on the network. type: string quicEnabled: description: QUIC transport layer network protocol. type: boolean sniOnly: description: Server Name Indication (SNI) setting for this Enrollment. type: boolean validationResult: additionalProperties: false description: The hash of `validationResult`. It always has a value, even when `validationResult` is `null`. The hash result of the validation result as of the time of the most recent validation check. It is used in the `change-management-ack` API call to further specify the state of the change that is being acknowledged. We recommend you use the `change-management-info` API call, review the `validationResult` with its hash, and then acknowledge change-management using the same hash retrieved when running the Change Management Acknowledgment operation. type: object properties: errors: description: 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. nullable: true type: array items: additionalProperties: false type: object required: - message - messageCode properties: message: description: The description of the message. type: string messageCode: description: The unique code of the message. type: string warnings: description: 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. type: array items: additionalProperties: false type: object required: - message - messageCode properties: message: description: The description of the message. type: string messageCode: description: The unique code of the message. type: string validationResultHash: description: The hash of `validationResult`. type: string x-akamai: file-path: schemas/change-management-info.v4.yaml application/vnd.akamai.cps.change-management-info.v5+json: example: acknowledgementDeadline: null validationResultHash: da39a3ee5e6b4b0d3255bfef95601890afd80709 pendingState: pendingNetworkConfiguration: dnsNameSettings: null mustHaveCiphers: ak-akamai-2020q1 networkType: null ocspStapling: not-set preferredCiphers: ak-akamai-2020q1 quicEnabled: 'false' sniOnly: 'false' disallowedTlsVersions: - TLSv1_2 pendingCertificates: - certificateType: third-party fullCertificate: '-----BEGIN CERTIFICATE----- MIID2 ... .... KZlSw== -----END CERTIFICATE-----' keyAlgorithm: RSA ocspStapled: 'false' ocspUris: null signatureAlgorithm: SHA-256 validationResult: errors: null warnings: - 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.]' messageCode: no-code schema: additionalProperties: false description: After you create an enrollment, you can have CPS halt deployment when the certificate becomes available, so that you can test and view the certificate on a staging server prior to deployment in the production network. If you do not want CPS to automatically deploy the certificate to the production network after it receives the signed certificate from the CA, you can turn change management on for the enrollment. This stops CPS from deploying the certificate to the network until you acknowledge that you are ready to deploy the certificate. type: object required: - pendingState - validationResultHash properties: acknowledgementDeadline: description: The timestamp of the deadline for the user to acknowledge the change management validation result, before CPS automatically proceeds with attempting to deploy the pending state to the live network. The format of the timestamp is ISO-8601. This field is only populated when there's an existing certificate on network for the current enrollment, it's `null` otherwise. nullable: true type: string pendingState: additionalProperties: false description: The snapshot of the pending state for the enrollment when this change takes effect. type: object required: - pendingCertificates - pendingNetworkConfiguration properties: pendingCertificates: description: The snapshot of the pending certificate for the enrollment when this change takes effect. type: array items: additionalProperties: false type: object required: - certificateType - fullCertificate - signatureAlgorithm properties: certificateType: description: Either `san`, `single`, `wildcard`, `wildcard-san`, or `third-party`. type: string enum: - san - single - wildcard - wildcard-san - third-party fullCertificate: description: Displays the contents of the certificate. type: string keyAlgorithm: description: Displays the key algorithm of the certificate. type: string enum: - ECDSA - RSA ocspStapled: description: OCSP Stapling improves performance by including a valid OCSP response in every TLS handshake. We recommend all customers enable this feature. type: boolean ocspUris: description: URI used for OCSP stapling validation. nullable: true type: array items: type: string signatureAlgorithm: description: Displays the signature algorithm. nullable: true type: string pendingNetworkConfiguration: additionalProperties: false description: The snapshot of the pending network configuration for the enrollment when this change takes effect. type: object required: - mustHaveCiphers - preferredCiphers - quicEnabled - sniOnly properties: disallowedTlsVersions: description: Disallowed TLS protocols. type: array items: type: string dnsNameSettings: additionalProperties: false description: DNS name settings. nullable: true type: object required: - cloneDnsNames properties: cloneDnsNames: description: All certificate SANs are included in `dnsNames` when `cloneDnsNames` is true. type: boolean dnsNames: description: Names served by SNI-only enabled enrollments. type: array items: type: string mustHaveCiphers: description: Ciphers included for your enrollment while deploying it on the network. type: string networkType: description: Enrollment network type. nullable: true type: string ocspStapling: description: OCSP stapling setting for the deployment. type: string enum: - 'on' - 'off' - not-set preferredCiphers: description: Ciphers included for your enrollment while deploying it on the network. type: string quicEnabled: description: QUIC transport layer network protocol. type: boolean sniOnly: description: Server Name Indication (SNI) setting for this Enrollment. type: boolean validationResult: additionalProperties: false description: The hash of `validationResult`. It always has a value, even when `validationResult` is `null`. The hash result of the validation result as of the time of the most recent validation check. It is used in the `change-management-ack` API call to further specify the state of the change that is being acknowledged. We recommend you use the `change-management-info` API call, review the `validationResult` with its hash, and then acknowledge change-management using the same hash retrieved when running the Change Management Acknowledgment operation. type: object properties: errors: description: 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. nullable: true type: array items: additionalProperties: false type: object required: - message - messageCode properties: message: description: The description of the message. type: string messageCode: description: The unique code of the message. type: string warnings: description: 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. type: array items: additionalProperties: false type: object required: - message - messageCode properties: message: description: The description of the message. type: string messageCode: description: The unique code of the message. type: string validationResultHash: description: The hash of `validationResult`. type: string x-akamai: file-path: schemas/change-management-info.v5.yaml application/vnd.akamai.cps.csr.v1+json: example: csr: '-----BEGIN CERTIFICATE REQUEST----- MIIDPT ... .... hA9jc= -----END CERTIFICATE REQUEST-----' schema: additionalProperties: false description: Certificate Signing Request (CSR). type: object properties: csr: description: String with PEM formatted CSR. nullable: true type: string x-akamai: file-path: schemas/csr.v1.yaml application/vnd.akamai.cps.csr.v2+json: example: csrs: - csr: '-----BEGIN CERTIFICATE REQUEST----- MIIDPT ... .... hA9jc= -----END CERTIFICATE REQUEST-----' keyAlgorithm: RSA schema: additionalProperties: false description: Certificate Signing Request (CSR). type: object required: - csrs properties: csrs: description: Certificate Signing Request (CSR) objects. type: array items: additionalProperties: false type: object required: - csr properties: csr: description: String with PEM formatted CSR. type: string keyAlgorithm: description: Key algorithm of the certificate, either `ECDSA` or `RSA`. type: string enum: - ECDSA - RSA x-akamai: file-path: schemas/csr.v2.yaml application/vnd.akamai.cps.deployment.v3+json: example: certificate: '-----BEGIN CERTIFICATE----- MIID2 ... .... ZlSw== -----END CERTIFICATE-----' signatureAlgorithm: SHA-256 trustChain: '-----BEGIN CERTIFICATE----- MIIDT ... .... JuAIQ= -----END CERTIFICATE-----' networkConfiguration: geography: standard-worldwide mustHaveCiphers: ak-akamai-2020q1 preferredCiphers: ak-akamai-2020q1 secureNetwork: enhanced-tls disallowedTlsVersions: [] sni: cloneDnsNames: true dnsNames: - san2.example.com - san1.example.com schema: additionalProperties: false description: Deploys your certificate to a network. type: object required: - certificate - networkConfiguration - trustChain properties: certificate: description: The certificate text. nullable: true type: string networkConfiguration: additionalProperties: false description: Information about how you want to deploy your certificate. type: object properties: disallowedTlsVersions: description: Disallowed TLS versions. type: array items: type: string geography: description: Type of the network that you want to deploy your certificate. `core` is worldwide (includes China and Russia). `china+core` is worldwide and China. `russia+core` is worldwide and Russia. type: string enum: - core - china+core - russia+core mustHaveCiphers: description: Ciphers that you definitely want to include for your enrollment while deploying it on the network. Defaults to `ak-akamai-default` when it is not set. type: string preferredCiphers: description: Ciphers that you preferably want to include for your enrollment while deploying it on the network. Defaults to `ak-akamai-default` when it is not set. type: string secureNetwork: description: The type of deployment network you want to use. Specify Standard TLS as the enum `standard-tls` to deploy your certificate to Akamai's standard secure network. It is not PCI compliant. Specify Enhanced TLS as the enum `enhanced-tls` to deploy your certificate to Akamai's more secure network with PCI compliance capability. type: string sni: additionalProperties: false description: SNI settings for your enrollment. When set to `null`, the enrollment becomes non-SNI. When it is non-null, enrollment is SNI-only. This setting cannot be changed once an enrollment is created. nullable: true type: object required: - cloneDnsNames properties: cloneDnsNames: description: Enable if you want CPS to direct traffic using all the SANs listed in the SANs parameter when you created your enrollment. type: boolean dnsNames: description: Names served by SNI-only enabled enrollments. type: array items: type: string signatureAlgorithm: description: The SHA (Secure Hash Algorithm) function. Current values include `SHA-1` & `SHA-256`. nullable: true type: string enum: - SHA-1 - SHA-256 trustChain: description: The trust chain text. You may have any number of trust chains. nullable: true type: string x-akamai: file-path: schemas/deployment.v3.yaml application/vnd.akamai.cps.deployment.v6+json: example: ocspStapled: true ocspUris: - http://ocsp.example.com networkConfiguration: geography: core mustHaveCiphers: ak-akamai-2020q1 ocspStapling: not-set preferredCiphers: ak-akamai-2020q1 quicEnabled: false secureNetwork: standard-tls sniOnly: true disallowedTlsVersions: [] dnsNames: - san2.example.com - san1.example.com primaryCertificate: certificate: '-----BEGIN CERTIFICATE----- MIID2 ... .... ZlSw== -----END CERTIFICATE-----' expiry: '2021-06-10T12:00:00Z' signatureAlgorithm: SHA-256 trustChain: '-----BEGIN CERTIFICATE----- MIIDT ... .... JuAIQ= -----END CERTIFICATE-----' multiStackedCertificates: - certificate: '-----BEGIN CERTIFICATE----- MIID2 ... .... ZlSw== -----END CERTIFICATE-----' expiry: '2021-06-10T12:00:00Z' signatureAlgorithm: SHA-256 trustChain: '-----BEGIN CERTIFICATE----- MIIDT ... .... JuAIQ= -----END CERTIFICATE-----' schema: additionalProperties: false description: Deploys your certificate to a network. type: object required: - multiStackedCertificates - networkConfiguration - primaryCertificate properties: multiStackedCertificates: description: Dual-stacked certificates today include an ECDSA certificate in addition to an RSA certificate. type: array items: additionalProperties: false description: Deployment may include multiple dual-stacked certificates. type: object required: - certificate - trustChain properties: certificate: description: The certificate text. nullable: true type: string expiry: description: The expiration date for the certificate. type: string signatureAlgorithm: description: The SHA (Secure Hash Algorithm) function. Current values include `SHA-1` & `SHA-256`. nullable: true type: string enum: - SHA-1 - SHA-256 trustChain: description: The trust chain for the certificate. nullable: true type: string networkConfiguration: additionalProperties: false description: Network configuration properties. type: object required: - quicEnabled - sniOnly properties: disallowedTlsVersions: description: Disallowed TLS protocol. type: array items: type: string dnsNames: description: Names served by SNI-only enabled enrollments. type: array items: type: string geography: description: Type of the network that you want to deploy your certificate. `core` is worldwide (includes China and Russia). `china+core` is worldwide and China. `russia+core` is worldwide and Russia. type: string enum: - core - china+core - russia+core mustHaveCiphers: description: Ciphers that you definitely want to include for your enrollment while deploying it on the network. For more information on cipher profiles, see [Akamai community](https://community.akamai.com/customers/s/article/SSL-TLS-Cipher-Profiles-for-Akamai-Secure-CDNrxdxm). type: string ocspStapling: description: OCSP stapling setting for the deployment. type: string preferredCiphers: description: Ciphers that you preferably want to include for your enrollment while deploying it on the network. For more information on cipher profiles, see [Akamai community](https://community.akamai.com/customers/s/article/SSL-TLS-Cipher-Profiles-for-Akamai-Secure-CDNrxdxm). type: string quicEnabled: description: QUIC transport layer network protocol. type: boolean secureNetwork: description: The type of deployment network. `standard-tls` means Akamai's standard secure network, while `enhanced-tls` means Akamai's more secure network with PCI compliance capability. type: string sniOnly: description: Server Name Indication (SNI) is an extension of the Transport Layer Security (TLS) networking protocol. It allows a server to present multiple certificates on the same IP address. All modern web browsers support the SNI extension. If you have the same SAN on two or more certificates with the SNI-only option set, Akamai may serve traffic using any certificate which matches the requested SNI hostname. You should avoid multiple certificates with overlapping SAN names when using SNI-only. type: boolean ocspStapled: description: OCSP Stapling improves performance by including a valid OCSP response in every TLS handshake. We recommend all customers enable this feature. type: boolean ocspUris: description: URI used for OCSP stapling validation. nullable: true type: array items: type: string primaryCertificate: additionalProperties: false description: Primary certificate of the enrollment. nullable: true type: object required: - certificate - trustChain properties: certificate: description: The certificate text. nullable: true type: string expiry: description: The expiration date for the certificate. type: string signatureAlgorithm: description: The SHA (Secure Hash Algorithm) function. Current values include `SHA-1` & `SHA-256`. nullable: true type: string enum: - SHA-1 - SHA-256 trustChain: description: The trust chain for the certificate. nullable: true type: string x-akamai: file-path: schemas/deployment.v6.yaml application/vnd.akamai.cps.deployment.v7+json: example: production: ocspStapled: true ocspUris: - http://ocsp.example.com networkConfiguration: geography: core mustHaveCiphers: ak-akamai-2020q1 ocspStapling: not-set preferredCiphers: ak-akamai-2020q1 quicEnabled: false secureNetwork: standard-tls sniOnly: true disallowedTlsVersions: [] dnsNames: - san2.example.com - san1.example.com primaryCertificate: certificate: '-----BEGIN CERTIFICATE----- MIID2 ... .... ZlSw== -----END CERTIFICATE-----' expiry: '2021-06-10T12:00:00Z' keyAlgorithm: RSA signatureAlgorithm: SHA-256 trustChain: '-----BEGIN CERTIFICATE----- MIIDT ... .... JuAIQ= -----END CERTIFICATE-----' multiStackedCertificates: - certificate: '-----BEGIN CERTIFICATE----- MIID2 ... .... ZlSw== -----END CERTIFICATE-----' expiry: '2021-06-10T12:00:00Z' keyAlgorithm: ECDSA signatureAlgorithm: SHA-256 trustChain: '-----BEGIN CERTIFICATE----- MIIDT ... .... JuAIQ= -----END CERTIFICATE-----' staging: ocspStapled: true ocspUris: - http://ocsp.example.com networkConfiguration: geography: core mustHaveCiphers: ak-akamai-2020q1 ocspStapling: not-set preferredCiphers: ak-akamai-2020q1 quicEnabled: false secureNetwork: standard-tls sniOnly: true disallowedTlsVersions: [] dnsNames: - san2.example.com - san1.example.com primaryCertificate: certificate: '-----BEGIN CERTIFICATE----- MIID2 ... .... ZlSw== -----END CERTIFICATE-----' expiry: '2021-06-10T12:00:00Z' keyAlgorithm: RSA signatureAlgorithm: SHA-256 trustChain: '-----BEGIN CERTIFICATE----- MIIDT ... .... JuAIQ= -----END CERTIFICATE-----' multiStackedCertificates: - certificate: '-----BEGIN CERTIFICATE----- MIID2 ... .... ZlSw== -----END CERTIFICATE-----' expiry: '2021-06-10T12:00:00Z' keyAlgorithm: ECDSA signatureAlgorithm: SHA-256 trustChain: '-----BEGIN CERTIFICATE----- MIIDT ... .... JuAIQ= -----END CERTIFICATE-----' schema: additionalProperties: false description: Deploys your certificate to a network. type: object required: - multiStackedCertificates - networkConfiguration - primaryCertificate properties: multiStackedCertificates: description: Dual-stacked certificates today include an ECDSA certificate in addition to an RSA certificate. type: array items: additionalProperties: false description: Deployment may include multiple dual-stacked certificates. type: object required: - certificate - trustChain properties: certificate: description: The certificate text. nullable: true type: string expiry: description: The expiration date for the certificate. type: string keyAlgorithm: description: The key algorithm of the certificate. type: string enum: - ECDSA - RSA signatureAlgorithm: description: The SHA (Secure Hash Algorithm) function. Current values include `SHA-1` & `SHA-256`. nullable: true type: string enum: - SHA-1 - SHA-256 trustChain: description: The trust chain for the certificate. nullable: true type: string networkConfiguration: additionalProperties: false description: Network configuration properties. type: object required: - quicEnabled - sniOnly properties: disallowedTlsVersions: description: Disallowed TLS protocol. type: array items: type: string dnsNames: description: Names served by SNI-only enabled enrollments. type: array items: type: string geography: description: Type of the network that you want to deploy your certificate. `core` is worldwide (includes China and Russia). `china+core` is worldwide and China. `russia+core` is worldwide and Russia. type: string enum: - core - china+core - russia+core mustHaveCiphers: description: Ciphers that you definitely want to include for your enrollment while deploying it on the network. For more information on cipher profiles, see [Akamai community](https://community.akamai.com/customers/s/article/SSL-TLS-Cipher-Profiles-for-Akamai-Secure-CDNrxdxm). type: string ocspStapling: description: OCSP stapling setting for the deployment. type: string enum: - 'on' - 'off' - not-set preferredCiphers: description: Ciphers that you preferably want to include for your enrollment while deploying it on the network. For more information on cipher profiles, see [Akamai community](https://community.akamai.com/customers/s/article/SSL-TLS-Cipher-Profiles-for-Akamai-Secure-CDNrxdxm). type: string quicEnabled: description: QUIC transport layer network protocol. type: boolean secureNetwork: description: The type of deployment network. `standard-tls` means Akamai's standard secure network, while `enhanced-tls` means Akamai's more secure network with PCI compliance capability. type: string enum: - enhanced-tls - standard-tls sniOnly: description: Server Name Indication (SNI) is an extension of the Transport Layer Security (TLS) networking protocol. It allows a server to present multiple certificates on the same IP address. All modern web browsers support the SNI extension. If you have the same SAN on two or more certificates with the SNI-only option set, Akamai may serve traffic using any certificate which matches the requested SNI hostname. You should avoid multiple certificates with overlapping SAN names when using SNI-only. type: boolean ocspStapled: description: OCSP Stapling improves performance by including a valid OCSP response in every TLS handshake. We recommend all customers enable this feature. type: boolean ocspUris: description: URI used for OCSP stapling validation. nullable: true type: array items: type: string primaryCertificate: additionalProperties: false description: Primary certificate of the enrollment. nullable: true type: object required: - certificate - trustChain properties: certificate: description: The certificate text. nullable: true type: string expiry: description: The expiration date for the certificate. type: string keyAlgorithm: description: The key algorithm of the certificate. type: string enum: - ECDSA - RSA signatureAlgorithm: description: The SHA (Secure Hash Algorithm) function. Current values include `SHA-1` & `SHA-256`. nullable: true type: string enum: - SHA-1 - SHA-256 trustChain: description: The trust chain for the certificate. nullable: true type: string x-akamai: file-path: schemas/deployment.v7.yaml application/vnd.akamai.cps.dv-challenges.v1+json: example: challenges: - domain: www.cps-example-dv.com error: The domain is not ready for validation. expires: '2017-05-19T18:00:00Z' fullPath: http://www.cps-example-dv.com/.well-known/acme-challenge/abcdefghijklmno-KuzBi3q5Dr6TU8ViHSDSf-c9Iyg redirectFullPath: http://dcv.akamai.com/.well-known/acme-challenge/abcdefghijklmno-KuzBi3q5Dr6TU8ViHSDSf-c9Iyg requestTimestamp: '2017-05-19T17:20:00Z' responseBody: 12345-...-abcdef status: Awaiting user token: abcdefghijklmno-123453q5Dr6TU8ViHSDSf-c9Iyg validatedTimestamp: '2017-05-19T17:35:22Z' schema: additionalProperties: false description: When using certificates with domain validation, you prove that you have control over each of the domains listed in the certificate. When you create a new DV enrollment that generates a certificate signing request (CSR). CPS automatically sends it to Let's Encrypt for signing. Let's Encrypt sends back a challenge for each domain listed on your certificate. You prove that you have control over the domains listed in the CSR by redirecting your traffic to Akamai. This allows Akamai to complete the challenge process for you by detecting the redirect and answering Let's Encrypt's challenge. You must configure your web server to redirect your traffic to Akamai. If you do not have the ability to redirect traffic on your web server, you must instruct the person who can redirect traffic to do so. Let's Encrypt automatically verifies the domain after it receives an answer to the challenge, and marks the domain as validated. A version label indicates this member is introduced in that version. A pre-version label indicates this member is removed in that version. No version label indicates this member is present in all versions. type: object required: - challenges properties: challenges: description: Domains that need to be validated for this Enrollment. V1 only supports and displays http-01 challenge. type: array items: additionalProperties: false type: object properties: domain: description: Domain which is being validated. type: string error: description: Current validation status for domains not yet validated. nullable: true type: string expires: description: Timestamp when this token or validation will expire. Sample 2014-08-12T18:57:07z. type: string fullPath: description: URL where Let's Encrypt will request and expect to find 'token' as content. type: string redirectFullPath: description: The URL where Akamai publishes `responseBody` for Let's Encrypt to validate. The client can configure a redirect at `fullPath` to redirect requests to this `redirectFullPath` URL, keeping in mind that the token may change over time. type: string requestTimestamp: description: Timestamp Akamai received validation token from Let's Encrypt. Sample `2014-08-12T18:57:07z`. type: string responseBody: description: The data Let's Encrypt expects to find served at `fullPath` URL. type: string status: description: The domain validation status. type: string token: description: The validation token issued by Let's Encrypt. type: string validatedTimestamp: description: Timestamp when domain was successfully validated. Sample 2014-08-12T18:57:07z. type: string x-akamai: file-path: schemas/dv-challenges.v1.yaml application/vnd.akamai.cps.dv-challenges.v2+json: example: dv: - domain: www.cps-example-dv.com error: The domain is not ready for validation. expires: '2021-09-06T17:55:17Z' requestTimestamp: '2021-09-05T15:55:49Z' status: Awaiting user validatedTimestamp: '2021-09-05T17:53:22Z' validationStatus: RESPONSE_ERROR challenges: - error: null fullPath: http://www.cps-example-dv.com/.well-known/acme-challenge/abcdefghijklmno-123453q5Dr6TU8ViHSDSf-c9Iyg redirectFullPath: http://dcv.akamai.com/.well-known/acme-challenge/abcdefghijklmno-123453q5Dr6TU8ViHSDSf-c9Iyg responseBody: AAA-dvq11111CmSWBzwIFpc4G2OCh5YXoHK56VccGmU.-BBBBBD3eQiu1uf5vf4xp-ZJv71AiycGGMuLtf06BnA status: pending token: abcdefghijklmno-123453q5Dr6TU8ViHSDSf-c9Iyg type: http-01 validationRecords: [] - error: null fullPath: _acme-challenge.www.cps-example-dv.com. redirectFullPath: '' responseBody: 0yVISDJjpXR7BXzR5QgfA51tt-I6aKremGnPwK_lvH4 status: pending token: cGBnw-3YO7rUhq61EuuHqcGrYkaQWALAgi8szTqRoHA type: dns-01 validationRecords: [] schema: additionalProperties: false description: When using certificates with domain validation, you prove that you have control over each of the domains listed in the certificate. When you create a new DV enrollment that generates a certificate signing request (CSR). CPS automatically sends it to Let's Encrypt for signing. Let's Encrypt sends back a challenge for each domain listed on your certificate. You prove that you have control over the domains listed in the CSR by redirecting your traffic to Akamai, or placing a token in the domain's DNS zone. This allows Akamai to complete the challenge process for you by detecting the redirect or DNS token, and answering Let's Encrypt's challenge. You must complete one of the challenges for each domain to validate the certificate. To validate a domain, only one challenge for each domain must be complete. Let's Encrypt automatically verifies the domain after it receives an answer to the challenge, and marks the domain as validated. type: object required: - dv properties: dv: description: Array of Domain Validation entities. type: array items: additionalProperties: false type: object required: - challenges properties: challenges: description: Domains that need to be validated for this Enrollment. V1 only supports and displays http-01 challenge. V2 allows HTTP and DNS challenge types. Each domain in the enrollment can have multiple challenges and can use a different challenge types. To validate a domain, only one challenge for each domain must be complete. type: array items: additionalProperties: false type: object required: - validationRecords properties: error: description: Error message describing failure to validate domain control. nullable: true type: string fullPath: description: URL where Let's Encrypt will request and expect to find 'token' as content. type: string redirectFullPath: description: The URL where Akamai publishes `responseBody` for Let's Encrypt to validate. The client can configure a redirect at `fullPath` to redirect requests to this `redirectFullPath` URL, keeping in mind that the token may change over time. type: string responseBody: description: The data Let's Encrypt expects to find served at `fullPath` URL. type: string status: description: The domain validation status. Current values include `Preparing`, `Pending`, `Awaiting user`, `Valid`, `Invalid`, `Error` & `Ready for Validation`. type: string enum: - Preparing - Pending - Awaiting user - Valid - Invalid - Error - Ready for Validation token: description: The validation token issued by Let's Encrypt. type: string type: description: Validation type. Currently supported types include `dns-01` & `http-01`. type: string enum: - dns-01 - http-01 validationRecords: description: Validation attempts and status. type: array items: additionalProperties: false description: Validation attempt. type: object properties: authorities: description: Validation authorities. type: array items: type: string hostname: description: Domain name being validated. type: string port: description: Port used for validation. type: string resolvedIp: description: IPs resolved for name being validated. type: array items: type: string triedIp: description: IP from `resolvedIp` tried for this validation. type: string url: description: URL attempted validated. type: string usedIp: description: IP from `resolvedIp` used for this validation. type: string domain: description: Domain which is being validated. type: string error: description: Current validation status for domains not yet validated. nullable: true type: string expires: description: Timestamp when this token or validation will expire. Sample 2017-12-05T18:57:07z. type: string requestTimestamp: description: Timestamp Akamai received validation token from Let's Encrypt. Sample `2017-12-12T18:57:07z`. type: string status: description: Let's Encrypt validation status. Required `Valid` for certificate generation. type: string validatedTimestamp: description: Timestamp when domain was successfully validated. Sample 2017-12-12T18:57:07z. type: string validationStatus: description: Status of the domain validation process. type: string x-akamai: file-path: schemas/dv-challenges.v2.yaml application/vnd.akamai.cps.warnings.v1+json: example: warnings: Some of the domains being provisioned (%s) exist on another certificate. Akamai recommends against overlapping names on Enhanced TLS and Standard TLS certificates except during digital property migrations. Enhanced TLS traffic could be misdirected in the event of DNS misconfiguration and treated as Standard TLS until the overlap is eliminated. schema: additionalProperties: false description: Warnings generated by CPS. type: object properties: warnings: description: String with comma separated list of warnings. type: string x-akamai: file-path: schemas/warnings.v1.yaml parameters: - description: __Enum__ Specifies the response type. example: '{{Accept}}' in: header name: Accept required: true schema: example: application/vnd.akamai.cps.csr.v2+json type: string enum: - application/vnd.akamai.cps.csr.v2+json - application/vnd.akamai.cps.csr.v1+json - application/vnd.akamai.cps.change-management-info.v5+json - application/vnd.akamai.cps.change-management-info.v4+json - application/vnd.akamai.cps.change-management-info.v2+json - application/vnd.akamai.cps.change-management-info.v1+json - application/vnd.akamai.cps.deployment.v7+json - application/vnd.akamai.cps.deployment.v6+json - application/vnd.akamai.cps.deployment.v3+json - application/vnd.akamai.cps.dv-challenges.v2+json - application/vnd.akamai.cps.dv-challenges.v1+json - application/vnd.akamai.cps.warnings.v1+json x-akamai: file-path: headers/Accept-header-change.yaml - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /enrollments/{enrollmentId}/changes/{changeId}/input/update/{allowedInputTypeParam}: parameters: - description: __Enum__ Found as the last part of `Change.allowedInput[].update` hypermedia URL. See [Change Input Content Type Mapping](https://techdocs.akamai.com/cps/reference/change-input-content-type-mapping) for details. Currently supported values include `change-management-ack`, `lets-encrypt-challenges-completed`, `post-verification-warnings-ack`, `pre-verification-warnings-ack`, `third-party-cert-and-trust-chain`. example: '{{allowedInputTypeParam}}' in: path name: allowedInputTypeParam required: true schema: example: third-party-cert-and-trust-chain type: string enum: - change-management-ack - lets-encrypt-challenges-completed - post-verification-warnings-ack - pre-verification-warnings-ack - third-party-cert-and-trust-chain x-akamai: file-path: parameters/allowedInputUpdateTypeParam-path.yaml - description: The change for this enrollment on which to perform the desired operation. example: '{{changeId}}' in: path name: changeId required: true schema: example: 10000 type: integer x-akamai: file-path: parameters/changeId-path.yaml - description: Enrollment on which to perform the desired operation. example: '{{enrollmentId}}' in: path name: enrollmentId required: true schema: example: 10000 type: integer x-akamai: file-path: parameters/enrollmentId-path.yaml post: description: Updates a pending change. Below is a sample where `allowedInput[].type` has the value `third-party-cert-and-trust-chain`. The acceptable `Content-Type` and `Accept` headers depends on the value of the `allowedInput.type` for the Change instance. See [Change Input Content Type Mapping](https://techdocs.akamai.com/cps/reference/change-input-content-type-mapping) for details. operationId: post-change-allowed-input-param summary: Update a change tags: - Changes externalDocs: description: See documentation for this operation in Akamai's Certificate Provisioning System API url: https://techdocs.akamai.com/cps/reference/post-change-allowed-input-param requestBody: content: application/vnd.akamai.cps.acknowledgement-with-hash.v1+json: example: acknowledgement: acknowledge hash: 24fb6fb91d290370c13a39e76afc1b26 schema: additionalProperties: false description: Encapsulates information needed to acknowledge an enrollment change. type: object required: - acknowledgement - hash properties: acknowledgement: description: The state for which this Acknowledgment is submitted, either `acknowledge`, `deny`. type: string enum: - acknowledge - deny hash: description: A hash is the state that this request acknowledges. You use this when you want to be explicit about what state you're acknowledging in order to prevent race conditions, such as when the state changes while the acknowledgment POST operation is in progress. type: string x-akamai: file-path: schemas/acknowledgement-with-hash.v1.yaml application/vnd.akamai.cps.acknowledgement.v1+json: example: acknowledgement: acknowledge schema: additionalProperties: false description: Encapsulates information needed to acknowledge an enrollment change. type: object required: - acknowledgement properties: acknowledgement: description: The state for which this Acknowledgment is submitted, either `acknowledge`, `deny`. type: string enum: - acknowledge - deny x-akamai: file-path: schemas/acknowledgement.v1.yaml application/vnd.akamai.cps.certificate-and-trust-chain.v1+json: example: certificate: '-----BEGIN CERTIFICATE----- MIID2DCCAsCgAwIBAgIQ661To2+zTDiFLyyARAaFXTANBgkqhkiG9w0BAQsFADBn MSowKAYDVQQDDCFBS0FNQUkgVEVTVCBJTlRFUk1FRElBVEUgQ0VSVCBbMV0xDjAM BgNVBAsMBVdlYkV4MQ8wDQYDVQQKDAZBa2FtYWkxCzAJBgNVBAgMAk1BMQswCQYD VQQGEwJVUzAeFw0xNzA1MTgyMTEwMTFaFw0xODA1MTkyMTEwMTFaMG0xHDAaBgNV BAMME3d3dy5jcHMtZXhhbXBsZS5jb20xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJN QTESMBAGA1UEBwwJQ2FtYnJpZGdlMQ8wDQYDVQQKDAZBa2FtYWkxDjAMBgNVBAsM BVdlYkV4MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvQeIJ2yfOC8P YQp6NjiCYSCkuS0z9a61v+k+KTDYQKIa8jDkwP0OITzvTnjMHuUd8JbSz5jNb22Z WxH/1F2p71rlSdBReBkZGLMLcQZPt5ju7ea7ZPz+MOWrwuc6YUafRMQk3qMeo3Sz IZQbmLKXkZeYriqy9s9yHJSUnWX1jOa51w6YM/Xar/2pZp2pyguaCNVGp7AAo38R AepaGcFwyjJse6dc+7dHOvDnjQ+Cg2lO8DSc12sFLllOhdOULldZRWbtfTLs9uet iR8ZVpHJ1TtzEz3X9RqBBCvnqykQvMmiQKOkfYEd6LN4Tk6/HJw2/MZhIgAEXtUU dQMnD6OMcwIDAQABo3oweDB2BgNVHREEbzBtghRzYW4xLmNwcy1leGFtcGxlLmNv bYIUc2FuMi5jcHMtZXhhbXBsZS5jb22CFHNhbjMuY3BzLWV4YW1wbGUuY29tghRz YW40LmNwcy1leGFtcGxlLmNvbYITd3d3LmNwcy1leGFtcGxlLmNvbTANBgkqhkiG 9w0BAQsFAAOCAQEAm9krrTxqDwUaO8J7P7CcrHfwXeWiDG3d9uHqCvHRGrcs46pI y8umThgOEba0QHi6CwM6O0+chcHsn6qf+uVKg2u1SKlE6qMIJ1Ppc8MJky1xo0M5 crtRpSXjaoF9S2zZZK1lwOJoK93BtC/lNfRc682TxlQ58jtBI6qnmLXUhF8Yo67v 0UfHiBIv1pZFPIdk90/48vjWM54haNxm/PhxNb6AdzawR4zImUhMKsISP7uOTURQ fFfeNgMvHyI8Id1VPLN+e2y4FtnTVdW2e+PTBvOJ1M+YoFU7M04/2SmKJHqnHljh VQBpto9JgDmt0yqsdFdLrZlpsIQwpLqdgKZlSw== -----END CERTIFICATE-----' trustChain: '-----BEGIN CERTIFICATE----- MIIDTDCCAjQCEB1FmMGD0kjutSE218ho23wwDQYJKoZIhvcNAQELBQAwYjElMCMG A1UEAwwcd3d3LkNQUy1Ba2FtYWktVGVzdC1Sb290LmNvbTEOMAwGA1UECwwFV2Vi RXgxDzANBgNVBAoMBkFrYW1haTELMAkGA1UECAwCTUExCzAJBgNVBAYTAlVTMB4X DTE3MDUxODIxMTAxMVoXDTE4MDUxOTIxMTAxMVowZzELMAkGA1UEBhMCVVMxCzAJ BgNVBAgMAk1BMQ8wDQYDVQQKDAZBa2FtYWkxDjAMBgNVBAsMBVdlYkV4MSowKAYD VQQDDCFBS0FNQUkgVEVTVCBJTlRFUk1FRElBVEUgQ0VSVCBbMV0wggEiMA0GCSqG SIb3DQEBAQUAA4IBDwAwggEKAoIBAQCyxuHi0zL03f+3ZTKLV1lMHvS2LkUwCKEd ApJw/v+yPPBTuamvikHQ8L5QM1p7BevavdeBMUAoGGXXQkrRtotCkL4S6N9cgH47 +cUeXCT0D2BaOkR15N7qDVtkYeAtC7eKUI7+j99iZXAFr8Nel9wqNn/9804HyF+F Z/YS5oPBuJVGcTQhd8bmUx5wBgr3n6EhqvOHEEAa5whb5PoP/hFi0xO0SFG/LA/+ K2NMvaE/9Y9j48/ONAFavf80s/y55SudZyBsjowtnZLIeJ4bM6nCN5DMAljH5U3O PFjSFKlbPxQgIcP9wLbQTV6b47tNK8c9jPg+U4jK2xtncJ2ijxSXAgMBAAEwDQYJ KoZIhvcNAQELBQADggEBACVVWGcirfBhkDwIuNELh1rzKPmhxwhx9hAsYz2B2FDn 7q82c85hXLfFSZ/9I3bzotVDh4YucCV+vxUXQcYt5tEDbg96uHNzRzXQUTdJSNIe bQ5Yn86ELLrzaXAD3+t6ztj8Z9dIVfG7LrAOg3UX5GjfEUrjNfZaiiUcBqLKibJ5 OqOJcPlbjKZ1kOqrCqlOugcQrZPgpzHkwssUR7v0VtHBHWnzjDTGaMXmvy1LsULA 3N35SDGFI/Zpw56R4z95UwpmDYg3IKwAGY8XL/oMqTORWyYDUpy1dpcAln5HcZK3 thju6KdIwCwmthk1iIUAri6avIrh7Mg2SHFho/4p5mA= -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIDQzCCAi0CEO7lWBUwDEEclty6iX7gCMcwCwYJKoZIhvcNAQELMGIxCzAJBgNV BAYTAlVTMQswCQYDVQQIDAJNQTEPMA0GA1UECgwGQWthbWFpMQ4wDAYDVQQLDAVX ZWJFeDElMCMGA1UEAwwcd3d3LkNQUy1Ba2FtYWktVGVzdC1Sb290LmNvbTAeFw0x NzA1MTgyMTEwMTFaFw0yMjA1MTgyMTEwMTFaMGIxCzAJBgNVBAYTAlVTMQswCQYD VQQIDAJNQTEPMA0GA1UECgwGQWthbWFpMQ4wDAYDVQQLDAVXZWJFeDElMCMGA1UE Awwcd3d3LkNQUy1Ba2FtYWktVGVzdC1Sb290LmNvbTCCASIwDQYJKoZIhvcNAQEB BQADggEPADCCAQoCggEBAJCbd5QpPJr0I48G4VE0JF5N719Wsspc8lEEgf2oM4BL 6pAyxU6hm8YzSfCx/NBpU2MYMa96FDoYWUVfj4iilpV4IpLdsDtXjMJ2fnVXP4iI 9n5EhF3oKGx2bAgBKpXIWXwPo3fqg/MGsdwIgrYyab3xJuwHP3V/2MSxzcHpxQrU E8jaemBXv6v0oTx50Ph0zJP+wYwvaDf+KVFzM3E42Ww9VLuP3lt5RAtasNctqlRr SlpH3RrZ0Gkpmz6xGr2LvLw12nkTylws/bafCSFAs7+x2ip6pP3yEaYxKdMpeOIE WaVU1RsJiWVYgq+b6gc9wrRpfZLyJYdAa50DuEv8jm0CAwEAATALBgkqhkiG9w0B AQsDggEBAFbv9+6pQBXDiFOxoYmu1/xiI1/mSGqooJtzNZjoni6HsruGxSqRbbKa 3GdaPVInZwWY7p8T1RM8+YDTrRrjbfRuRPqdgUBv8iDbcldJNXsqD1CylxLi0lul dnHgQD9TmcrTs3ELeT277PE2f8AX3YjhYK8IIGBmDomc1KRTka3nZtexIwfiEQJr RzsFL+1vwPoSJFKb1NzeOGikkPNmipQvYKGY9A/q2XeqrEWKGHizPwvcIu7EC8wL RooQ3ztqAV3Wul5dI5+AEE8WQzUyzCq7BEgOgNaX403g8An5QueSjhogbYdRd3BM +OWJc8qePy3KgqY44s3kbrPR6sJuAIQ= -----END CERTIFICATE-----' schema: additionalProperties: false description: A digital certificate contains an electronic document that includes a company's identification information (such as the name of the company and address), a public key, and the digital signature of a certification authority (CA) based on that certification authority's private key. Digital certificates are verified using a chain of trust, which is a certificate hierarchy that allows individuals to verify the validity of a certificate's issuer. The latest BETA version allows for multiple certificates and trust chains submission (Dual-Stack enrollment). type: object required: - certificate properties: certificate: description: The certificate text. nullable: true type: string trustChain: description: The trust chain text. You may have no trust chains or multiple trust chains. nullable: true type: string x-akamai: file-path: schemas/certificate-and-trust-chain.v1.yaml application/vnd.akamai.cps.certificate-and-trust-chain.v2+json: example: certificatesAndTrustChains: - certificate: '-----BEGIN CERTIFICATE----- MIID ... .... KZlSw== -----END CERTIFICATE-----' keyAlgorithm: ECDSA trustChain: '-----BEGIN CERTIFICATE----- MIID ... .... 4p5mA= -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIDQ ... .... JuAIQ= -----END CERTIFICATE-----' - certificate: '-----BEGIN CERTIFICATE----- MIID ... .... ZKwSl== -----END CERTIFICATE-----' keyAlgorithm: RSA trustChain: '-----BEGIN CERTIFICATE----- MIID ... .... mA45p= -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIDQ ... .... QuIAJ= -----END CERTIFICATE-----' schema: additionalProperties: false description: A digital certificate contains an electronic document that includes a company's identification information (such as the name of the company and address), a public key, and the digital signature of a certification authority (CA) based on that certification authority's private key. Digital certificates are verified using a chain of trust, which is a certificate hierarchy that allows individuals to verify the validity of a certificate's issuer. The latest BETA version allows for multiple certificates and trust chains submission (Dual-Stack enrollment). type: object required: - certificatesAndTrustChains properties: certificatesAndTrustChains: description: Certificate and trust chains. type: array items: additionalProperties: false type: object required: - certificate - keyAlgorithm properties: certificate: description: The certificate text. nullable: true type: string keyAlgorithm: description: The key algorithm of the certificate , either `ECDSA` or `RSA`. type: string enum: - ECDSA - RSA trustChain: description: The trust chain text. You may have no trust chains or multiple trust chains. nullable: true type: string x-akamai: file-path: schemas/certificate-and-trust-chain.v2.yaml responses: '200': description: Successful response. content: application/vnd.akamai.cps.change-id.v1+json: example: change: /cps/v2/enrollments/10002/changes/10002 schema: additionalProperties: false type: object required: - change properties: change: type: string x-akamai: file-path: schemas/change-id.v1.yaml parameters: - description: __Enum__ Must be used to specify a request type. example: '{{Content-Type}}' in: header name: Content-Type required: true schema: example: application/vnd.akamai.cps.certificate-and-trust-chain.v2+json type: string enum: - application/vnd.akamai.cps.certificate-and-trust-chain.v2+json - application/vnd.akamai.cps.certificate-and-trust-chain.v1+json - application/vnd.akamai.cps.acknowledgement-with-hash.v1+json - application/vnd.akamai.cps.acknowledgement.v1+json x-akamai: file-path: headers/content-type-header-change.yaml - description: __Enum__ Specifies the response type. example: '{{Accept}}' in: header name: Accept required: true schema: example: application/vnd.akamai.cps.change-id.v1+json type: string enum: - application/vnd.akamai.cps.change-id.v1+json x-akamai: file-path: headers/Accept-header-changeId.yaml - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /enrollments/{enrollmentId}/history/changes: parameters: - description: Enrollment on which to perform the desired operation. example: '{{enrollmentId}}' in: path name: enrollmentId required: true schema: example: 10000 type: integer x-akamai: file-path: parameters/enrollmentId-path.yaml get: description: Change history of an enrollment. operationId: get-history-changes summary: Get change history tags: - Changes externalDocs: description: See documentation for this operation in Akamai's Certificate Provisioning System API url: https://techdocs.akamai.com/cps/reference/get-history-changes responses: '200': description: Successful response. content: application/vnd.akamai.cps.change-history.v5+json: example: changes: - action: renew actionDescription: Renew Certificate businessCaseId: 5005B00000XYZA1234 createdBy: mrossi createdOn: '2021-05-09T19:26:59Z' lastUpdated: '2021-06-12T12:56:55Z' ra: symantec status: completed primaryCertificate: certificate: '-----BEGIN CERTIFICATE----- MIIFH ... .... b+kIw== -----END CERTIFICATE-----' csr: '-----BEGIN CERTIFICATE REQUEST----- MIIC2 ... .... mdnsaw= -----END CERTIFICATE REQUEST-----' keyAlgorithm: RSA trustChain: '-----BEGIN CERTIFICATE----- MIIEdj ... .... oqzb5Ct -----END CERTIFICATE-----' primaryCertificateOrderDetails: orderId: abcdefM6Gw3WvN2p12345 multiStackedCertificates: - certificate: '-----BEGIN CERTIFICATE----- MIIDu ... .... 3JpAg== -----END CERTIFICATE-----' csr: '-----BEGIN CERTIFICATE REQUEST----- MIIC2 ... .... mdnsaw= -----END CERTIFICATE REQUEST-----' keyAlgorithm: ECDSA trustChain: '-----BEGIN CERTIFICATE----- MIIDzD ... .... F3+fA== -----END CERTIFICATE-----' - action: renew actionDescription: Renew Certificate businessCaseId: 5005B00000DEFG1234 createdBy: szhang createdOn: '2021-02-02T18:21:17Z' lastUpdated: '2021-02-05T19:57:14Z' ra: symantec status: cancelled primaryCertificate: certificate: '-----BEGIN CERTIFICATE----- MIIFH ... .... b+kIw== -----END CERTIFICATE-----' csr: '-----BEGIN CERTIFICATE REQUEST----- MIIC2 ... .... mdnsaw= -----END CERTIFICATE REQUEST-----' keyAlgorithm: RSA trustChain: '-----BEGIN CERTIFICATE----- MIIEdj ... .... oqzb5Ct -----END CERTIFICATE-----' primaryCertificateOrderDetails: orderId: abcdeHvg8F7caXW312345 multiStackedCertificates: - certificate: null csr: '-----BEGIN CERTIFICATE REQUEST----- MIIC2 ... .... mdnsaw= -----END CERTIFICATE REQUEST-----' keyAlgorithm: ECDSA trustChain: null - action: renew actionDescription: Renew Certificate businessCaseId: null createdBy: jperez createdOn: '2021-02-01T17:16:35Z' lastUpdated: null primaryCertificate: null primaryCertificateOrderDetails: null ra: symantec status: cancelled multiStackedCertificates: [] - action: new-certificate actionDescription: Create New Certificate businessCaseId: 5005B00000ABCD1234 createdBy: jsmith createdOn: '2021-02-01T16:30:58Z' lastUpdated: '2021-02-01T17:16:37Z' ra: symantec status: completed primaryCertificate: certificate: '-----BEGIN CERTIFICATE----- MIIFH ... .... b+kIw== -----END CERTIFICATE-----' csr: '-----BEGIN CERTIFICATE REQUEST----- MIIC2 ... .... mdnsaw= -----END CERTIFICATE REQUEST-----' keyAlgorithm: RSA trustChain: '-----BEGIN CERTIFICATE----- MIIEdj ... .... oqzb5Ct -----END CERTIFICATE-----' primaryCertificateOrderDetails: orderId: abcdex7zh8wspr4m12345 multiStackedCertificates: - certificate: '-----BEGIN CERTIFICATE----- MIIDu ... .... 3JpAg== -----END CERTIFICATE-----' csr: '-----BEGIN CERTIFICATE REQUEST----- MIIC2 ... .... mdnsaw= -----END CERTIFICATE REQUEST-----' keyAlgorithm: ECDSA trustChain: '-----BEGIN CERTIFICATE----- MIIDzD ... .... F3+fA== -----END CERTIFICATE-----' schema: additionalProperties: false description: You can view all the changes associated with a certificate as part of the change history. This is the equivalent of viewing the certificate activity in the CPS UI. You can view each change to your certificate, the status of your change, the last updated date, the date the change was created, and who created the change. You can also take actions on each change of the certificate, including viewing the CSR for the certificate, viewing the certificate, and viewing the trust chain for the certificate. type: object required: - changes properties: changes: description: Change history items. type: array items: additionalProperties: false type: object required: - action - actionDescription - createdBy - createdOn - multiStackedCertificates - ra - status properties: action: description: Show every change on the certificate. The possible changes are `import-certificate`, `renew`, `new-certificate`, `modify-san`, `update-network-configuration`. type: string enum: - import-certificate - renew - new-certificate - modify-san - update-network-configuration actionDescription: description: A description of each change. type: string businessCaseId: description: SalesForce ID associated with this change. nullable: true type: string createdBy: description: The username of the user who initiated the change. type: string createdOn: description: A date and timestamp when the change started. format: date-time type: string lastUpdated: description: A date and timestamp when the change was last updated. nullable: true type: string multiStackedCertificates: description: Dual-stacked certificates. type: array items: additionalProperties: false type: object properties: certificate: description: Certificate text. nullable: true type: string csr: description: Certificate CSR. type: string keyAlgorithm: description: Key algorithm of the certificate. type: string trustChain: description: Certificate trust chain. nullable: true type: string primaryCertificate: additionalProperties: false description: Primary Certificate. nullable: true type: object properties: certificate: description: Certificate text. nullable: true type: string csr: description: Certificate CSR. type: string keyAlgorithm: description: Key algorithm of the certificate. type: string trustChain: description: Certificate trust chain. nullable: true type: string primaryCertificateOrderDetails: additionalProperties: false description: CA order details for this Change. nullable: true type: object properties: orderId: description: Order ID. type: string ra: description: The certificate authority that issued the certificate. type: string status: description: The status of the change. The possible changes are `incomplete`, `cancelled`, `completed`. type: string enum: - incomplete - cancelled - completed x-akamai: file-path: schemas/change-history.v5.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string externalDocs: description: See documentation for Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference x-readme: samples-languages: - curl - python - node