Modify onboarding settings

put https://{hostname}/appsec/v1/onboardings/{onboardingId}/settings

App & API Protector, App & API Protector with the Advanced Security module Update the settings in an onboarding. You can't update settings for an onboarding object that has already activated on staging or production. You can, however, change settings for an onboarding that has not been activated.

Responses

Response body

object

certificate

object

required

The certificate settings to secure your site.

adminContact

object

required

Contact information for the certificate administrator that you want to use as a contact at your company.

certificateType

string

required

length ≥ 1

A value of DEFAULT creates a new secure-by-default certificate. A value of CUSTOM_EXISTING means the certificate already exists on your account. If you want to create a new certificate, choose CUSTOM_NEW. Note that your certificate is created when you activate your onboarding. Your account may have limits for how many certificates you can create. If, for example, your account is limited to five certificates and your account already has five, then you won't be able to create a new one.

DEFAULT CUSTOM_EXISTING CUSTOM_NEW

commonName

string

length ≥ 1

The domain name to use for the certificate, also known as the common name.

enrollmentId

integer

A unique identifier for an enrollment in the Certificate Provisioning System (CPS).

enrollmentLink

uri

The URL to call the enrollment. Note this URL is for the Certificate Provisioning System (CPS) API.

delivery

object

required

The delivery settings for your site traffic.

origins

array of objects

required

length ≥ 1

List of hostnames and proposed origin hostnames. If you choose not to use an origin hostname suggested to you, you can edit it to the value you want with a request to Update onboarding settings.

origins*

object

hostname

string

required

length ≥ 1

The hostname for your site. You can add up to 100 hostnames.

origin

string

required

length ≥ 1

The origin server hostname.

onboardingLink

uri

required

The URL to call when you want to access this onboarding at a later time.

security

object

required

The security settings for your site.

cloneVersion

integer

The configuration version that is cloned to make a new configuration for onboarding.

configId

integer

The identifier for the existing configuration.

configLink

uri

The URL to make a call for the specific configuration. For example, Get a configuration.

configName

string

length ≥ 1

The name of configuration.

configType

string

required

length ≥ 1

Specifies whether the security configuration is NEW, or you're using an EXISTING one. Note than when you use an existing configuration, the onboarding process creates a new version of the configuration from the version that is currently active on the production network. If no version is active on production, the clone will be the most recent version of the configuration. For example, if you have version 14 active on production out of 23 versions, version 14 is the version that is cloned when you create a new onboarding. If there is no active version on production and there are 23 versions of the configuration, it is version 23 that's cloned.

NEW EXISTING

evalRequired

boolean

If TRUE, adds the hostnames to evaluation mode for the policy. This applies to AAP only.

policyId

string

length ≥ 1

If securityPolicy is EXISTING, lists the unique identifier for the policy.

policyLink

uri

The URL to make a call for the specific policy. For example, the URL in Update a policy.

policyName

string

length ≥ 1

The name of the security policy.

policyType

string

required

length ≥ 1

Specifies whether the security policy is NEW, or you're using an EXISTING one. Note that you can only edit policy settings if "policyType": "NEW" because editing existing, active policies could disrupt service to your site.

NEW EXISTING

protections

object

required

The set of protections in the security policy.

settingsLink

uri

required

The URL to call to manage onboarding settings after you finishing the initial creation.

`fieldErrors` and other fields provided in the response for more information.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
22
1
curl --request PUT \
2
     --url https://hostname/appsec/v1/onboardings/onboardingId/settings \
# Add Authorization header to this snippet
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "certificate": {
8
    "certificateType": "DEFAULT"
9
  },
10
  "security": {
11
    "configType": "NEW",
12
    "policyType": "NEW",
13
    "protections": {
14
      "applyApplicationLayerControls": true,
15
      "applyBotmanControls": true,
16
      "applyNetworkLayerControls": true,
17
      "applyRateControls": true,
18
      "applySlowPostControls": true
19
    }
20
  }
21
}
22
'


xxxxxxxxxx
48
}
1
{
2
  "certificate": {
3
    "adminContact": {
4
      "email": "adminContact@nomail-akamai.com",
5
      "firstName": "AdminUser",
6
      "lastName": "User",
7
      "phone": "+919090909090"
8
    },
9
    "certificateType": "CUSTOM_EXISTING",
10
    "commonName": "www.commonName.com",
11
    "enrollmentId": 87902,
12
    "enrollmentLink": "/cps/v2/enrollments/87902"
13
  },
14
  "delivery": {
15
    "origins": [
16
      {
17
        "hostname": "www.example.com",
18
        "origin": "origin-ea0ac1-.www.example.com"
19
      },
20
      {
21
        "hostname": "www.example.net",
22
        "origin": "origin-8eeeba-.www.example.net"
23
      }
24
    ]
25
  },

200Successfully updated the onboarding settings.

400Invalid. Invalid onboarding settings. See the fieldErrors and other fields provided in the response for more information.

403Forbidden. You are not authorized to use this API.

404Not found. The onboarding object wasn't found.

422Unprocessable content. Onboarding settings can't be updated after activation.

`fieldErrors` and other fields provided in the response for more information.