Akamai · Example Payload

Akamai Put Enrollment Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Put Enrollment 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": "put-enrollment",
  "method": "PUT",
  "path": "/enrollments/{enrollmentId}",
  "summary": "Update an enrollment",
  "requestExamples": [
    {
      "contentType": "application/vnd.akamai.cps.enrollment.v11+json",
      "example": {
        "autoRenewalStartTime": null,
        "certificateChainType": "default",
        "certificateType": "third-party",
        "changeManagement": true,
        "enableMultiStackedCertificates": false,
        "id": "10001",
        "location": "/cps-api/enrollments/10001",
        "maxAllowedSanNames": 100,
        "maxAllowedWildcardSanNames": 100,
        "orgId": "645263546",
        "ra": "third-party",
        "signatureAlgorithm": null,
        "validationType": "third-party",
        "assignedSlots": [
          1234
        ],
        "productionSlots": [
          1234
        ],
        "stagingSlots": [
          1234
        ],
        "adminContact": {
          "addressLineOne": "150 Broadway",
          "addressLineTwo": null,
          "city": "Cambridge",
          "country": "US",
          "email": "email@example.com",
          "firstName": "R1",
          "lastName": "D1",
          "organizationName": "Akamai",
          "phone": "617-555-0111",
          "postalCode": "02142",
          "region": "MA",
          "title": "Adminstrator"
        },
        "csr": {
          "c": "US",
          "cn": "www.example.com",
          "l": "Cambridge",
          "o": "Akamai",
          "ou": "WebEx",
          "preferredTrustChain": "dst-root-ca-x3",
          "st": "MA",
          "sans": [
            "san1.example.com",
            "san2.example.com",
            "san3.example.com",
            "www.example.com"
          ]
        },
        "networkConfiguration": {
          "geography": "core",
          "mustHaveCiphers": "ak-akamai-2020q1",
          "ocspStapling": "on",
          "preferredCiphers": "ak-akamai-2020q1",
          "quicEnabled": false,
          "secureNetwork": "enhanced-tls",
          "sniOnly": true,
          "disallowedTlsVersions": [
            "TLSv1",
            "TLSv1_1"
          ],
          "clientMutualAuthentication": {
            "setId": "Custom_CPS-6134b_B-3-1AHBENT.xml",
            "authenticationOptions": {
              "sendCaListToClient": false,
              "ocsp": {
                "enabled": false
              }
            }
          },
          "dnsNameSettings": {
            "cloneDnsNames": false,
            "dnsNames": [
              "san2.example.com",
              "san1.example.com"
            ]
          }
        },
        "org": {
          "addressLineOne": "150 Broadway",
          "addressLineTwo": null,
          "city": "Cambridge",
          "country": "US",
          "name": "Akamai Technologies",
          "phone": "617-555-0111",
          "postalCode": "02142",
          "region": "MA"
        },
        "techContact": {
          "addressLineOne": "150 Broadway",
          "addressLineTwo": null,
          "city": "Cambridge",
          "country": "US",
          "email": "email@example.com",
          "firstName": "R2",
          "lastName": "D2",
          "organizationName": "Akamai",
          "phone": "617-555-0111",
          "postalCode": "02142",
          "region": "MA",
          "title": "Technical Engineer"
        },
        "thirdParty": {
          "excludeSans": false
        },
        "pendingChanges": [
          {
            "changeType": "new-certificate",
            "location": "/cps-api/enrollments/10001/changes/10002"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/vnd.akamai.cps.enrollment-status.v1+json",
      "example": {
        "enrollment": "/cps/v2/enrollments/10002",
        "changes": [
          "/cps/v2/enrollments/10002/changes/10002"
        ]
      }
    },
    {
      "status": "202",
      "contentType": "application/vnd.akamai.cps.enrollment-status.v1+json",
      "example": {
        "enrollment": "/cps/v2/enrollments/10002",
        "changes": [
          "/cps/v2/enrollments/10002/changes/10002"
        ]
      }
    }
  ]
}