Modify onboarding 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.

Path Params
integer
required

A unique identifier for an onboarding.

Query Params
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
certificate
object
required

The certificate settings to secure your site.

delivery
object
required

The delivery settings for your site traffic.

uri
required
security
object
required

The security settings for your site.

uri
required
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.

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

string
length ≥ 1

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

integer

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

uri
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
string
required
length ≥ 1

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

string
required
length ≥ 1

The origin server hostname.

uri
required
security
object
required

The security settings for your site.

integer

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

integer

The identifier for the existing configuration.

uri
string
length ≥ 1

The name of configuration.

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

boolean

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

string
length ≥ 1

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

uri
string
length ≥ 1

The name of the security policy.

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.

uri
required

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

Language
Authentication
URL