Akamai · Example Payload

Akamai Get Change Allowed Input Param Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Change Allowed Input Param Example is an example object payload from Akamai, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "get-change-allowed-input-param",
  "method": "GET",
  "path": "/enrollments/{enrollmentId}/changes/{changeId}/input/info/{allowedInputTypeParam}",
  "summary": "Get a change",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/vnd.akamai.cps.change-management-info.v1+json",
      "example": {
        "acknowledgementDeadline": null,
        "validationResultHash": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
        "pendingState": {
          "pendingCertificate": {
            "certificateType": "third-party",
            "fullCertificate": "-----BEGIN CERTIFICATE-----\nMIID2DCCAsCgAwIBAgIQ661To2+zTDiFLyyARAaFXTANBgkqhkiG9w0BAQsFADBn\nMSowKAYDVQQDDCFBS0FNQUkgVEVTVCBJTlRFUk1FRElBVEUgQ0VSVCBbMV0xDjAM\nBgNVBAsMBVdlYkV4MQ8wDQYDVQQKDAZBa2FtYWkxCzAJBgNVBAgMAk1BMQswCQYD\nVQQGEwJVUzAeFw0xNzA1MTgyMTEwMTFaFw0xODA1MTkyMTEwMTFaMG0xHDAaBgNV\nBAMME3d3dy5jcHMtZXhhbXBsZS5jb20xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJN\nQTESMBAGA1UEBwwJQ2FtYnJpZGdlMQ8wDQYDVQQKDAZBa2FtYWkxDjAMBgNVBAsM\nBVdlYkV4MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvQeIJ2yfOC8P\nYQp6NjiCYSCkuS0z9a61v+k+KTDYQKIa8jDkwP0OITzvTnjMHuUd8JbSz5jNb22Z\nWxH/1F2p71rlSdBReBkZGLMLcQZPt5ju7ea7ZPz+MOWrwuc6YUafRMQk3qMeo3Sz\nIZQbmLKXkZeYriqy9s9yHJSUnWX1jOa51w6YM/Xar/2pZp2pyguaCNVGp7AAo38R\nAepaGcFwyjJse6dc+7dHOvDnjQ+Cg2lO8DSc12sFLllOhdOULldZRWbtfTLs9uet\niR8ZVpHJ1TtzEz3X9RqBBCvnqykQvMmiQKOkfYEd6LN4Tk6/HJw2/MZhIgAEXtUU\ndQMnD6OMcwIDAQABo3oweDB2BgNVHREEbzBtghRzYW4xLmNwcy1leGFtcGxlLmNv\nbYIUc2FuMi5jcHMtZXhhbXBsZS5jb22CFHNhbjMuY3BzLWV4YW1wbGUuY29tghRz\nYW40LmNwcy1leGFtcGxlLmNvbYITd3d3LmNwcy1leGFtcGxlLmNvbTANBgkqhkiG\n9w0BAQsFAAOCAQEAm9krrTxqDwUaO8J7P7CcrHfwXeWiDG3d9uHqCvHRGrcs46pI\ny8umThgOEba0QHi6CwM6O0+chcHsn6qf+uVKg2u1SKlE6qMIJ1Ppc8MJky1xo0M5\ncrtRpSXjaoF9S2zZZK1lwOJoK93BtC/lNfRc682TxlQ58jtBI6qnmLXUhF8Yo67v\n0UfHiBIv1pZFPIdk90/48vjWM54haNxm/PhxNb6AdzawR4zImUhMKsISP7uOTURQ\nfFfeNgMvHyI8Id1VPLN+e2y4FtnTVdW2e+PTBvOJ1M+YoFU7M04/2SmKJHqnHljh\nVQBpto9JgDmt0yqsdFdLrZlpsIQwpLqdgKZlSw==\n-----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"
            }
          ]
        }
      }
    },
    {
      "status": "200",
      "contentType": "application/vnd.akamai.cps.change-management-info.v2+json",
      "example": {
        "acknowledgementDeadline": null,
        "validationResultHash": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
        "pendingState": {
          "pendingCertificate": {
            "certificateType": "third-party",
            "fullCertificate": "-----BEGIN CERTIFICATE-----\nMIID2DCCAsCgAwIBAgIQ661To2+zTDiFLyyARAaFXTANBgkqhkiG9w0BAQsFADBn\nMSowKAYDVQQDDCFBS0FNQUkgVEVTVCBJTlRFUk1FRElBVEUgQ0VSVCBbMV0xDjAM\nBgNVBAsMBVdlYkV4MQ8wDQYDVQQKDAZBa2FtYWkxCzAJBgNVBAgMAk1BMQswCQYD\nVQQGEwJVUzAeFw0xNzA1MTgyMTEwMTFaFw0xODA1MTkyMTEwMTFaMG0xHDAaBgNV\nBAMME3d3dy5jcHMtZXhhbXBsZS5jb20xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJN\nQTESMBAGA1UEBwwJQ2FtYnJpZGdlMQ8wDQYDVQQKDAZBa2FtYWkxDjAMBgNVBAsM\nBVdlYkV4MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvQeIJ2yfOC8P\nYQp6NjiCYSCkuS0z9a61v+k+KTDYQKIa8jDkwP0OITzvTnjMHuUd8JbSz5jNb22Z\nWxH/1F2p71rlSdBReBkZGLMLcQZPt5ju7ea7ZPz+MOWrwuc6YUafRMQk3qMeo3Sz\nIZQbmLKXkZeYriqy9s9yHJSUnWX1jOa51w6YM/Xar/2pZp2pyguaCNVGp7AAo38R\nAepaGcFwyjJse6dc+7dHOvDnjQ+Cg2lO8DSc12sFLllOhdOULldZRWbtfTLs9uet\niR8ZVpHJ1TtzEz3X9RqBBCvnqykQvMmiQKOkfYEd6LN4Tk6/HJw2/MZhIgAEXtUU\ndQMnD6OMcwIDAQABo3oweDB2BgNVHREEbzBtghRzYW4xLmNwcy1leGFtcGxlLmNv\nbYIUc2FuMi5jcHMtZXhhbXBsZS5jb22CFHNhbjMuY3BzLWV4YW1wbGUuY29tghRz\nYW40LmNwcy1leGFtcGxlLmNvbYITd3d3LmNwcy1leGFtcGxlLmNvbTANBgkqhkiG\n9w0BAQsFAAOCAQEAm9krrTxqDwUaO8J7P7CcrHfwXeWiDG3d9uHqCvHRGrcs46pI\ny8umThgOEba0QHi6CwM6O0+chcHsn6qf+uVKg2u1SKlE6qMIJ1Ppc8MJky1xo0M5\ncrtRpSXjaoF9S2zZZK1lwOJoK93BtC/lNfRc682TxlQ58jtBI6qnmLXUhF8Yo67v\n0UfHiBIv1pZFPIdk90/48vjWM54haNxm/PhxNb6AdzawR4zImUhMKsISP7uOTURQ\nfFfeNgMvHyI8Id1VPLN+e2y4FtnTVdW2e+PTBvOJ1M+YoFU7M04/2SmKJHqnHljh\nVQBpto9JgDmt0yqsdFdLrZlpsIQwpLqdgKZlSw==\n-----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"
            }
          ]
        }
      }
    },
    {
      "status": "200",
      "contentType": "application/vnd.akamai.cps.change-management-info.v4+json",
      "example": {
        "acknowledgementDeadline": null,
        "validationResultHash": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
        "pendingState": {
          "pendingCertificate": {
            "certificateType": "third-party",
            "fullCertificate": "-----BEGIN CERTIFICATE-----\nMIID2DCCAsCgAwIBAgIQ661To2+zTDiFLyyARAaFXTANBgkqhkiG9w0BAQsFADBn\nMSowKAYDVQQDDCFBS0FNQUkgVEVTVCBJTlRFUk1FRElBVEUgQ0VSVCBbMV0xDjAM\nBgNVBAsMBVdlYkV4MQ8wDQYDVQQKDAZBa2FtYWkxCzAJBgNVBAgMAk1BMQswCQYD\nVQQGEwJVUzAeFw0xNzA1MTgyMTEwMTFaFw0xODA1MTkyMTEwMTFaMG0xHDAaBgNV\nBAMME3d3dy5jcHMtZXhhbXBsZS5jb20xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJN\nQTESMBAGA1UEBwwJQ2FtYnJpZGdlMQ8wDQYDVQQKDAZBa2FtYWkxDjAMBgNVBAsM\nBVdlYkV4MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvQeIJ2yfOC8P\nYQp6NjiCYSCkuS0z9a61v+k+KTDYQKIa8jDkwP0OITzvTnjMHuUd8JbSz5jNb22Z\nWxH/1F2p71rlSdBReBkZGLMLcQZPt5ju7ea7ZPz+MOWrwuc6YUafRMQk3qMeo3Sz\nIZQbmLKXkZeYriqy9s9yHJSUnWX1jOa51w6YM/Xar/2pZp2pyguaCNVGp7AAo38R\nAepaGcFwyjJse6dc+7dHOvDnjQ+Cg2lO8DSc12sFLllOhdOULldZRWbtfTLs9uet\niR8ZVpHJ1TtzEz3X9RqBBCvnqykQvMmiQKOkfYEd6LN4Tk6/HJw2/MZhIgAEXtUU\ndQMnD6OMcwIDAQABo3oweDB2BgNVHREEbzBtghRzYW4xLmNwcy1leGFtcGxlLmNv\nbYIUc2FuMi5jcHMtZXhhbXBsZS5jb22CFHNhbjMuY3BzLWV4YW1wbGUuY29tghRz\nYW40LmNwcy1leGFtcGxlLmNvbYITd3d3LmNwcy1leGFtcGxlLmNvbTANBgkqhkiG\n9w0BAQsFAAOCAQEAm9krrTxqDwUaO8J7P7CcrHfwXeWiDG3d9uHqCvHRGrcs46pI\ny8umThgOEba0QHi6CwM6O0+chcHsn6qf+uVKg2u1SKlE6qMIJ1Ppc8MJky1xo0M5\ncrtRpSXjaoF9S2zZZK1lwOJoK93BtC/lNfRc682TxlQ58jtBI6qnmLXUhF8Yo67v\n0UfHiBIv1pZFPIdk90/48vjWM54haNxm/PhxNb6AdzawR4zImUhMKsISP7uOTURQ\nfFfeNgMvHyI8Id1VPLN+e2y4FtnTVdW2e+PTBvOJ1M+YoFU7M04/2SmKJHqnHljh\nVQBpto9JgDmt0yqsdFdLrZlpsIQwpLqdgKZlSw==\n-----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"
            }
          ]
        }
      }
    },
    {
      "status": "200",
      "contentType": "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-----\nMIID2 ... <sample - removed for readability> .... KZlSw==\n-----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"
            }
          ]
        }
      }
    },
    {
      "status": "200",
      "contentType": "application/vnd.akamai.cps.csr.v1+json",
      "example": {
        "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDPT ... <sample - removed for readability> .... hA9jc=\n-----END CERTIFICATE REQUEST-----"
      }
    },
    {
      "status": "200",
      "contentType": "application/vnd.akamai.cps.csr.v2+json",
      "example": {
        "csrs": [
          {
            "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDPT ... <sample - removed for readability> .... hA9jc=\n-----END CERTIFICATE REQUEST-----",
            "keyAlgorithm": "RSA"
          }
        ]
      }
    },
    {
      "status": "200",
      "contentType": "application/vnd.akamai.cps.deployment.v3+json",
      "example": {
        "certificate": "-----BEGIN CERTIFICATE-----\nMIID2 ... <sample - removed for readability> .... ZlSw==\n-----END CERTIFICATE-----",
        "signatureAlgorithm": "SHA-256",
        "trustChain": "-----BEGIN CERTIFICATE-----\nMIIDT ... <sample - removed for readability> .... JuAIQ=\n-----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"
            ]
          }
        }
      }
    },
    {
      "status": "200",
      "contentType": "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-----\nMIID2 ... <sample - removed for readability> .... ZlSw==\n-----END CERTIFICATE-----",
          "expiry": "2021-06-10T12:00:00Z",
          "signatureAlgorithm": "SHA-256",
          "trustChain": "-----BEGIN CERTIFICATE-----\nMIIDT ... <sample - removed for readability> .... JuAIQ=\n-----END CERTIFICATE-----"
        },
        "multiStackedCertificates": [
          {
            "certificate": "-----BEGIN CERTIFICATE-----\nMIID2 ... <sample - removed for readability> .... ZlSw==\n-----END CERTIFICATE-----",
            "expiry": "2021-06-10T12:00:00Z",
            "signatureAlgorithm": "SHA-256",
            "trustChain": "-----BEGIN CERTIFICATE-----\nMIIDT ... <sample - removed for readability> .... JuAIQ=\n-----END CERTIFICATE-----"
          }
        ]
      }
    },
    {
      "status": "200",
      "contentType": "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-----\nMIID2 ... <sample - removed for readability> .... ZlSw==\n-----END CERTIFICATE-----",
            "expiry": "2021-06-10T12:00:00Z",
            "keyAlgorithm": "RSA",
            "signatureAlgorithm": "SHA-256",
            "trustChain": "-----BEGIN CERTIFICATE-----\nMIIDT ... <sample - removed for readability> .... JuAIQ=\n-----END CERTIFICATE-----"
          },
          "multiStackedCertificates": [
            {
              "certificate": "-----BEGIN CERTIFICATE-----\nMIID2 ... <sample - removed for readability> .... ZlSw==\n-----END CERTIFICATE-----",
              "expiry": "2021-06-10T12:00:00Z",
              "keyAlgorithm": "ECDSA",
              "signatureAlgorithm": "SHA-256",
              "trustChain": "-----BEGIN CERTIFICATE-----\nMIIDT ... <sample - removed for readability> .... JuAIQ=\n-----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-----\nMIID2 ... <sample - removed for readability> .... ZlSw==\n-----END CERTIFICATE-----",
            "expiry": "2021-06-10T12:00:00Z",
            "keyAlgorithm": "RSA",
            "signatureAlgorithm": "SHA-256",
            "trustChain": "-----BEGIN CERTIFICATE-----\nMIIDT ... <sample - removed for readability> .... JuAIQ=\n-----END CERTIFICATE-----"
          },
          "multiStackedCertificates": [
            {
              "certificate": "-----BEGIN CERTIFICATE-----\nMIID2 ... <sample - removed for readability> .... ZlSw==\n-----END CERTIFICATE-----",
              "expiry": "2021-06-10T12:00:00Z",
              "keyAlgorithm": "ECDSA",
              "signatureAlgorithm": "SHA-256",
              "trustChain": "-----BEGIN CERTIFICATE-----\nMIIDT ... <sample - removed for readability> .... JuAIQ=\n-----END CERTIFICATE-----"
            }
          ]
        }
      }
    },
    {
      "status": "200",
      "contentType": "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"
          }
        ]
      }
    },
    {
      "status": "200",
      "contentType": "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": []
              }
            ]
          }
        ]
      }
    },
    {
      "status": "200",
      "contentType": "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."
      }
    }
  ]
}