Create an onboarding

App & API Protector, App & API Protector with the Advanced Security module Create a new onboarding. To start, you'll need a valid set of hostnames that either need delivery settings, an Akamai-owned certificate from the Certificate Provisioning System (CPS), and security protections, or have delivery settings complete and only need security protections. However, you can include only one type of these hostnames per onboarding, not both. If you have both kinds of hostnames, those that need delivery settings, a CPS certificate, and security protections, and those that only need security protections, you'll need to create two onboarding objects. The response object is your newly created onboarding.

Query Params
boolean
Defaults to false

This creates an onboarding with a new CPS certificate and security protections. If your contract limits how many certificates you create, the API responds with an error.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
string
required

A unique identifier for a contract. Run List contracts and groups to get the contractId if you don't have one already.

int32
required

A unique identifier for a group.

hostnames
array of strings
required
length between 1 and 100

List of hostnames you are setting up with Akamai services.

hostnames*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json