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
    API Security Create an Onboarding. Self-contained Naftiko capability covering one Akamai Api Security business surface.'
  tags:
  - Akamai Api Security
  - 'Onboarding: Creation and settings'
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AKAMAI_API_SECURITY_API_KEY: AKAMAI_API_SECURITY_API_KEY
capability:
  consumes:
  - type: http
    namespace: akamai-api-security-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: postonboarding
        method: POST
        description: Akamai API Security 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 '
        - 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-w
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getonboardings
        method: GET
        description: Akamai API Security 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-w
    - name: onboardings-onboardingId
      path: /onboardings/{onboardingId}
      operations:
      - name: getonboarding
        method: GET
        description: Akamai API Security 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-w
      - name: deleteonboarding
        method: DELETE
        description: Akamai API Security 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-w
    - name: onboardings-onboardingId-settings
      path: /onboardings/{onboardingId}/settings
      operations:
      - name: getonboardingsettings
        method: GET
        description: Akamai API Security 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-w
      - name: putonboardingsettings
        method: PUT
        description: Akamai API Security 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-w
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: akamai-api-security-onboarding-creation-and-settings-rest
    port: 8080
    description: 'REST adapter for Akamai: Application Security API — Onboarding: Creation and settings. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.'
    resources:
    - path: /v1/onboardings
      name: onboardings
      description: REST surface for onboardings.
      operations:
      - method: POST
        name: postonboarding
        description: Akamai API Security Create an Onboarding
        call: akamai-api-security-onboarding-creation-and-settings.postonboarding
        with:
          createNewResourcesOnly: rest.createNewResourcesOnly
          accountSwitchKey: rest.accountSwitchKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getonboardings
        description: Akamai API Security List Onboardings
        call: akamai-api-security-onboarding-creation-and-settings.getonboardings
        with:
          onboardingStatuses: rest.onboardingStatuses
          hostnames: rest.hostnames
          accountSwitchKey: rest.accountSwitchKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/onboardings/{onboardingid}
      name: onboardings-onboardingid
      description: REST surface for onboardings-onboardingId.
      operations:
      - method: GET
        name: getonboarding
        description: Akamai API Security Get an Onboarding
        call: akamai-api-security-onboarding-creation-and-settings.getonboarding
        with:
          accountSwitchKey: rest.accountSwitchKey
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteonboarding
        description: Akamai API Security Delete an Onboarding
        call: akamai-api-security-onboarding-creation-and-settings.deleteonboarding
        with:
          accountSwitchKey: rest.accountSwitchKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/onboardings/{onboardingid}/settings
      name: onboardings-onboardingid-settings
      description: REST surface for onboardings-onboardingId-settings.
      operations:
      - method: GET
        name: getonboardingsettings
        description: Akamai API Security Get Onboarding Settings
        call: akamai-api-security-onboarding-creation-and-settings.getonboardingsettings
        with:
          accountSwitchKey: rest.accountSwitchKey
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putonboardingsettings
        description: Akamai API Security Modify Onboarding Settings
        call: akamai-api-security-onboarding-creation-and-settings.putonboardingsettings
        with:
          accountSwitchKey: rest.accountSwitchKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: akamai-api-security-onboarding-creation-and-settings-mcp
    port: 9090
    transport: http
    description: 'MCP adapter for Akamai: Application Security API — Onboarding: Creation and settings. One tool per consumed
      operation, routed inline through this capability''s consumes block.'
    tools:
    - name: akamai-api-security-create-onboarding
      description: Akamai API Security Create an Onboarding
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: akamai-api-security-onboarding-creation-and-settings.postonboarding
      with:
        createNewResourcesOnly: tools.createNewResourcesOnly
        accountSwitchKey: tools.accountSwitchKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: akamai-api-security-list-onboardings
      description: Akamai API Security List Onboardings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: akamai-api-security-onboarding-creation-and-settings.getonboardings
      with:
        onboardingStatuses: tools.onboardingStatuses
        hostnames: tools.hostnames
        accountSwitchKey: tools.accountSwitchKey
      outputParameters:
      - type: object
        mapping: $.
    - name: akamai-api-security-get-onboarding
      description: Akamai API Security Get an Onboarding
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: akamai-api-security-onboarding-creation-and-settings.getonboarding
      with:
        accountSwitchKey: tools.accountSwitchKey
      outputParameters:
      - type: object
        mapping: $.
    - name: akamai-api-security-delete-onboarding
      description: Akamai API Security Delete an Onboarding
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: akamai-api-security-onboarding-creation-and-settings.deleteonboarding
      with:
        accountSwitchKey: tools.accountSwitchKey
      outputParameters:
      - type: object
        mapping: $.
    - name: akamai-api-security-get-onboarding-2
      description: Akamai API Security Get Onboarding Settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: akamai-api-security-onboarding-creation-and-settings.getonboardingsettings
      with:
        accountSwitchKey: tools.accountSwitchKey
      outputParameters:
      - type: object
        mapping: $.
    - name: akamai-api-security-modify-onboarding
      description: Akamai API Security Modify Onboarding Settings
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: akamai-api-security-onboarding-creation-and-settings.putonboardingsettings
      with:
        accountSwitchKey: tools.accountSwitchKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.