Secure Provisioning Service API

The Secure Provisioning Service (SPS), or Secure Domain Provisioning API, provides a method for provisioning certificates and secure Edge Hostnames.

API Summary

Operation Method Endpoint
Requests
Create a Request POST /config-secure-provisioning-service/v1/sps-requests{?contractId,groupId,after,information}
List SPS Requests GET /config-secure-provisioning-service/v1/sps-requests{?contractId,groupId,after,information}
Get an SPS Request GET /config-secure-provisioning-service/v1/sps-request/{spsId}{?contractId,groupId,after,information}
Secure Edge Hostnames
Create a Secure Edge Hostname POST /config-secure-provisioning-service/v1/secure-edge-hosts{?contractId,groupId}

Create a Request

POST /config-secure-provisioning-service/v1/sps-requests{?contractId,groupId,after,information}

Example: /config-secure-provisioning-service/v1/sps-requests?contractId=11754&groupId=1001&after=2014–07–08T16%3A27%3A06Z&information=false

Content-Type: application/x-www-form-urlencoded

Request:

cnameHostname=www.example.cname-hostname300.com&createType=san&csr.cn=www.example.com&csr.ou=IT&csr.sans=www.example.com&csr.sans=www.new-example.com&csr.sans=www.example.net&csr.sans=www.new-example.net&organization-information.organization-name=My+Example+Inc.&organization-information.address-line-one=8+Cambridge+Center&organization-information.city=Cambridge&organization-information.region=MA&organization-information.postal-code=02136&organization-information.country=US&organization-information.phone=18008008000&admin-contact.first-name=Mary&admin-contact.last-name=Jones&admin-contact.phone=18008008001&admin-contact.email=m.jones@akamai.com&product=alta&validationType=ov

Parameter Type Sample Description
Required
contractId Number 11754 For POST requests, the ID of the contract associated with the new policy. To retrieve the contractId you need, see the Property Manager API.
groupId Number 1001 For POST requests, the ID of the group associated with the new policy. To retrieve the groupId you need, see the Property Manager API.
Optional
after String 2014-07-08T16:27:06Z If specified for GET requests, returns only the SPS requests created after the date entered. Enter the combined date and time in UTC, using the ISO 8601 date format: yyyy-MM-dd'T'HH:mm:ss'Z'.
information Boolean false If specified for GET requests, returns parameters posted with the SPS request resource.

Status 202 application/json

Response:

{
    "spsId": 12345,
    "resourceLocation": "/config-secure-provisioning-service/v1/sps-requests/12345",
    "Results": {
        "data": [
            {
                "data": null,
                "code": null,
                "text": null,
                "results": {
                    "jobID": 67890,
                    "enrollmentId": 54321,
                    "type": "SUCCESS"
                },
                "message": null
            }
        ],
        "size": 1
    }
}

List SPS Requests

GET /config-secure-provisioning-service/v1/sps-requests{?contractId,groupId,after,information}

Example: /config-secure-provisioning-service/v1/sps-requests?contractId=11754&groupId=1001&after=2014–07–08T16%3A27%3A06Z&information=false

Parameter Type Sample Description
Required
contractId Number 11754 For POST requests, the ID of the contract associated with the new policy. To retrieve the contractId you need, see the Property Manager API.
groupId Number 1001 For POST requests, the ID of the group associated with the new policy. To retrieve the groupId you need, see the Property Manager API.
Optional
after String 2014-07-08T16:27:06Z If specified for GET requests, returns only the SPS requests created after the date entered. Enter the combined date and time in UTC, using the ISO 8601 date format: yyyy-MM-dd'T'HH:mm:ss'Z'.
information Boolean false If specified for GET requests, returns parameters posted with the SPS request resource.

Status 200 application/json

Response:

{
    "requestList": [
        {
            "status": "SPS Request Complete",
            "spsId": 7890,
            "jobId": 10110,
            "enrollmentId": 54321,
            "workflowProgress": "All of your requested changes are complete.",
            "resourceUrl": "/sps/v1/sps_request/7890",
            "lastStatusChange": "2014-07-08T16:27:06Z",
            "parameters": [
                {
                    "name": "cnameHostname",
                    "value": "www.example.com"
                },
                {
                    "name": "createType",
                    "value": "single"
                },
                {
                    "name": "csr.cn",
                    "value": "www.example.akamai.com"
                },
                {
                    "name": "csr.c",
                    "value": "US"
                },
                {
                    "name": "csr.st",
                    "value": "MA"
                },
                {
                    "name": "csr.l",
                    "value": "Boston"
                },
                {
                    "name": "csr.o",
                    "value": "Akamai"
                },
                {
                    "name": "csr.ou",
                    "value": "Engineering"
                },
                {
                    "name": "organization-information.organization-name",
                    "value": "Any Company, Inc."
                },
                {
                    "name": "organization-information.address-line-one",
                    "value": "1 Main Street"
                },
                {
                    "name": "organization-information.city",
                    "value": "Anytown"
                },
                {
                    "name": "organization-information.region",
                    "value": "MA"
                },
                {
                    "name": "organization-information.postal-code",
                    "value": "02125"
                },
                {
                    "name": "organization-information.country",
                    "value": "US"
                },
                {
                    "name": "organization-information.phone",
                    "value": "617-999-9999"
                },
                {
                    "name": "admin-contact.first-name",
                    "value": "John"
                },
                {
                    "name": "admin-contact.last-name",
                    "value": "Doe"
                },
                {
                    "name": "admin-contact.phone",
                    "value": "617-999-9999"
                },
                {
                    "name": "admin-contact.email",
                    "value": "jdoe@AnyCompany.com"
                },
                {
                    "name": "technical-contact.first-name",
                    "value": "Jane"
                },
                {
                    "name": "technical-contact.last-name",
                    "value": "Smith"
                },
                {
                    "name": "technical-contact.phone",
                    "value": "617-222-2222"
                },
                {
                    "name": "technical-contact.email",
                    "value": "jsmith@Akamai.com"
                },
                {
                    "name": "slot-deployment.klass",
                    "value": "esslType"
                },
                {
                    "name": "issuer",
                    "value": "geotrust"
                },
                {
                    "name": "contractId",
                    "value": "1-contract"
                },
                {
                    "name": "groupId",
                    "value": "987"
                },
                {
                    "name": "ipVersion",
                    "value": "ipv4"
                },
                {
                    "name": "product",
                    "value": "alta"
                }
            ]
        },
        {
            "status": "SPS Request Complete",
            "spsId": 2341,
            "jobId": 67541,
            "enrollmentId": 89765,
            "workflowProgress": "All of your requested changes are complete.",
            "resourceUrl": "/sps/v1/sps_request/2341",
            "lastStatusChange": "2014-07-08T16:27:06Z",
            "parameters": [
                {
                    "name": "cnameHostname",
                    "value": "www.example2.com"
                },
                {
                    "name": "createType",
                    "value": "single"
                },
                {
                    "name": "csr.cn",
                    "value": "www.example2.akamai.com"
                },
                {
                    "name": "csr.c",
                    "value": "US"
                },
                {
                    "name": "csr.st",
                    "value": "MA"
                },
                {
                    "name": "csr.l",
                    "value": "Boston"
                },
                {
                    "name": "csr.o",
                    "value": "Akamai"
                },
                {
                    "name": "csr.ou",
                    "value": "Engineering"
                },
                {
                    "name": "organization-information.organization-name",
                    "value": "Any Company, Inc."
                },
                {
                    "name": "organization-information.address-line-one",
                    "value": "1 Main Street"
                },
                {
                    "name": "organization-information.city",
                    "value": "Anytown"
                },
                {
                    "name": "organization-information.region",
                    "value": "MA"
                },
                {
                    "name": "organization-information.postal-code",
                    "value": "02125"
                },
                {
                    "name": "organization-information.country",
                    "value": "US"
                },
                {
                    "name": "organization-information.phone",
                    "value": "617-999-9999"
                },
                {
                    "name": "admin-contact.first-name",
                    "value": "John"
                },
                {
                    "name": "admin-contact.last-name",
                    "value": "Doe"
                },
                {
                    "name": "admin-contact.phone",
                    "value": "617-999-9999"
                },
                {
                    "name": "admin-contact.email",
                    "value": "jdoe@AnyCompany.com"
                },
                {
                    "name": "technical-contact.first-name",
                    "value": "Jane"
                },
                {
                    "name": "technical-contact.last-name",
                    "value": "Smith"
                },
                {
                    "name": "technical-contact.phone",
                    "value": "617-222-2222"
                },
                {
                    "name": "technical-contact.email",
                    "value": "jsmith@Akamai.com"
                },
                {
                    "name": "slot-deployment.klass",
                    "value": "esslType"
                },
                {
                    "name": "issuer",
                    "value": "geotrust"
                },
                {
                    "name": "contractId",
                    "value": "1-contract"
                },
                {
                    "name": "groupId",
                    "value": "987"
                },
                {
                    "name": "ipVersion",
                    "value": "ipv4"
                },
                {
                    "name": "product",
                    "value": "alta"
                }
            ]
        }
    ]
}

Get an SPS Request

View information about an existing SPS request.

GET /config-secure-provisioning-service/v1/sps-request/{spsId}{?contractId,groupId,after,information}

Example: /config-secure-provisioning-service/v1/sps-request/1406?contractId=11754&groupId=1001&after=2014–07–08T16%3A27%3A06Z&information=false

Parameter Type Sample Description
Required
contractId Number 11754 The ID of the contract associated with the new policy. To retrieve the contractId you need, see the Property Manager API.
groupId Number 1001 The ID of the group associated with the new policy. To retrieve the groupId you need, see the Property Manager API.
spsId Number 1406 The ID of a completed SPS request.
Optional
after Date 2014-07-08T16:27:06Z If specified, returns only the SPS requests created after the date entered. Enter the combined date and time in UTC, using the ISO 8601 date format: yyyy-MM-dd'T'HH:mm:ss'Z'.
information Boolean false If specified, will return parameters posted with the SPS request resource.

Status 200 application/json

Response:

{
    "requestList": [
        {
            "status": "SPS Request Complete",
            "spsId": 7890,
            "jobId": 10110,
            "enrollmentId": 54321,
            "workflowProgress": "All of your requested changes are complete.",
            "resourceUrl": "/sps/v1/sps_request/7890",
            "lastStatusChange": "2014-07-08T16:27:06Z"
        }
    ]
}

Create a Secure Edge Hostname

Create a secure edge hostname from an existing subscriptionId or jobId.

POST /config-secure-provisioning-service/v1/secure-edge-hosts{?contractId,groupId}

Example: /config-secure-provisioning-service/v1/secure-edge-hosts?contractId=11754&groupId=1001

Content-Type: application/x-www-form-urlencoded

Request:

cnameHostname=www.sehncreate.cname-hostname300.com&jobId=10110

Parameter Type Sample Description
Required
contractId Number 11754 The ID of the contract associated with the new policy. To retrieve the contractId you need, see the Property Manager API.
groupId Number 1001 The ID of the group associated with the new policy. To retrieve the groupId you need, see the Property Manager API.

Status 202 application/json

Response:

{
    "spsId": 24660,
    "resourceLocation": "/config-secure-provisioning-service/v1/sps-requests/24660"
}


Last modified: 12/12/2016