Akamai: Application Security API — Onboarding: Creation and settings

naftiko: 1.0.0-alpha2
info:
  label: 'Akamai: Application Security API — Onboarding: Creation and settings'
  description: 'Akamai: Application Security API — Onboarding: Creation and settings. 6 operations. Lead operation: Akamai Create an onboarding. Self-contained Naftiko capability covering
    one Akamai business surface.'
  tags:
  - Akamai
  - Application Security
  - 'Onboarding: Creation and settings'
  created: '2026-05-22'
  modified: '2026-05-22'
binds:
- namespace: env
  keys:
    AKAMAI_API_KEY: AKAMAI_API_KEY
capability:
  consumes:
  - type: http
    namespace: appsec-onboarding-creation-and-settings
    baseUri: https://{hostname}/appsec/v1
    description: 'Akamai: Application Security API — Onboarding: Creation and settings business capability. Self-contained, no shared references.'
    resources:
    - name: onboardings
      path: /onboardings
      operations:
      - name: postpost-onboarding
        method: POST
        description: Create an onboarding
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: createNewResourcesOnly
          in: query
          type: boolean
          description: 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.
        - name: accountSwitchKey
          in: query
          type: string
          description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client).
            The Identity and
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getget-onboardings
        method: GET
        description: List onboardings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: onboardingStatuses
          in: query
          type: array
          description: Lists onboardings for a specific status.
        - name: hostnames
          in: query
          type: array
          description: Returns onboardings containing the specified hostnames.
        - name: accountSwitchKey
          in: query
          type: string
          description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client).
            The Identity and
    - name: onboardings-onboardingId
      path: /onboardings/{onboardingId}
      operations:
      - name: getget-onboarding
        method: GET
        description: Get an onboarding
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountSwitchKey
          in: query
          type: string
          description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client).
            The Identity and
      - name: deletedelete-onboarding
        method: DELETE
        description: Delete an onboarding
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountSwitchKey
          in: query
          type: string
          description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client).
            The Identity and
    - name: onboardings-onboardingId-settings
      path: /onboardings/{onboardingId}/settings
      operations:
      - name: getget-onboarding-settings
        method: GET
        description: Get onboarding settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountSwitchKey
          in: query
          type: string
          description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client).
            The Identity and
      - name: putput-onboarding-settings
        method: PUT
        description: Modify onboarding settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountSwitchKey
          in: query
          type: string
          description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client).
            The Identity and
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true