{ "operationId": "post-onboarding", "method": "POST", "path": "/onboardings", "summary": "Create an onboarding", "requestExamples": [ { "contentType": "application/json", "example": { "contractId": "C-0N7RAC7", "groupId": 12345, "hostnames": [ "www.example.com", "www.test.example.org" ] } } ], "responseExamples": [ { "status": "201", "contentType": "application/json", "example": { "accountId": "A-CCT7890", "contractId": "C-0N7RAC7", "createdBy": "jsmith", "createdDate": "2024-05-02T22:08:50Z", "currentStep": 2, "groupId": 54321, "hostnames": [ "www.example.com", "test.example.org" ], "modifiedBy": "asingh", "modifiedDate": "2024-07-02T22:08:50Z", "nextSteps": [ { "stepDescription": "Activate the onboarding", "stepLink": "/appsec/v1/onboardings/101/activate", "stepName": "activate-onboarding" } ], "onboardingId": 101, "onboardingLink": "/appsec/v1/onboardings/101", "onboardingStatus": "CREATED", "product": "AAP", "settings": { "certificate": { "adminContact": { "email": "adminContact@nomail-akamai.com", "firstName": "AdminUser", "lastName": "User", "phone": "+9180460018" }, "certificateType": "CUSTOM_EXISTING", "commonName": "www.at.konaqa.com", "enrollmentId": 94723, "enrollmentLink": "/cps/v2/enrollments/94723" }, "delivery": { "origins": [ { "hostname": "www.example.com", "origin": "origin-ea0ac1-www.example.com" }, { "hostname": "www.www.test.example.org", "origin": "origin-8eeeba-test.example.org" } ] }, "security": { "cloneVersion": 25, "configId": 243359, "configLink": "/appsec/v1/configs/12345", "configName": "sec-config", "configType": "EXISTING", "evalRequired": true, "policyId": "PLCY_12344", "policyLink": "/appsec/v1/configs/12345/versions/25/security-policies/PLCY_12345", "policyName": "sec-policy", "policyType": "EXISTING", "protections": { "applyApplicationLayerControls": true, "applyBotmanControls": false, "applyNetworkLayerControls": true, "applyRateControls": true, "applyReputationControls": true, "applySlowPostControls": true } }, "settingsLink": "/appsec/v1/onboardings/101/settings" }, "totalSteps": 6 } }, { "status": "400", "contentType": "application/problem+json", "example": { "detail": "The request could not be understood by the server due to malformed syntax.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/BAD-REQUEST" } }, { "status": "403", "contentType": "application/problem+json", "example": { "detail": "You do not have the necessary access to perform this operation or the requested resource cannot be modified", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 403, "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED" } } ] }