Onboarding
Synopsis
Create an onboarding.
Syntax
New-AppSecOnboarding -Hostnames <String[]> -ContractID <String> -GroupID <Int32> [-CreateNewResourcesOnly] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]New-AppSecOnboarding [-CreateNewResourcesOnly] -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]Description
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.
Parameters
‑AccountSwitchKey | An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey. |
‑BodyConditionally required | The request body, either as a |
‑ContractIDConditionally required | Your contract's ID. |
‑CreateNewResourcesOnly | 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. |
‑EdgeRCFile | Your EdgeGrid resource file to authenticate your command. Defaults to |
‑GroupIDConditionally required | Your group's ID. |
‑HostnamesConditionally required | List of hostnames to be added to the configuration. |
‑Section | The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
Related Links
Updated 7 days ago