> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fingerprint.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Deploy Akamai Integration using Property Manager API

> Deploy the Fingerprint Akamai Proxy Integration using Akamai Property Manager API PATCH body method.

<Info>
  **Before you start: Read the general Akamai guide**

  This document only covers deploying the Fingerprint Akamai proxy integration using the Akamai Property Manager API ([PAPI][akamai-papi]). It assumes you have already read the [general Akamai guide][akamai-guide-v3] and completed the following steps:

  * [Step 1][akamai-step-1-v3]: You have issued a proxy secret in the Fingerprint Dashboard (`FPJS_PROXY_SECRET`).
  * [Step 2][akamai-step-2-v3]: You have defined the path variables for the integration (`FPJS_INTEGRATION_PATH`, `FPJS_AGENT_PATH`, `FPJS_RESULT_PATH`)

  If you want to use Terraform instead of PAPI to install the integration, see [Deploy Akamai proxy integration using Terraform][akamai-terraform-v3].
</Info>

<Warning>
  **Limitations**

  This integration is exclusively supported for customers on the **Enterprise** Plan. Other customers are encouraged to use [Custom subdomain setup][custom-subdomain-v3] or [Cloudflare Proxy Integration][cloudflare-proxy-v3].
</Warning>

***

## Prerequisites

This deployment guide assumes you already have a working Akamai property and are familiar with the Akamai Control Panel. It uses [Postman][postman] to make the HTTP requests, but feel free to adjust the instructions to use your preferred HTTP client.

## Step 3: Authenticate with EdgeGrid

1. Follow the Akamai documentation to [Create EdgeGrid authentication credentials][akamai-edgegrid-auth]. You should end up downloading a credentials text file containing the values used below.

2. Inside Postman, use the values from the credentials file to configure the EdgeGrid authentication for your HTTP requests:
   1. Go to the **Authorization** tab.
   2. Set the **Type** to `Akamai EdgeGrid`.
   3. Set `Access Token`, `Client Token`, and `Client Secret` to the values from the credentials file.
   4. Set the base URL of the request according to the `host` value from the credentials file, e.g. `https://akab-xxxxxxxx.luna.akamaiapis.net`.

> Note: If your HTTP client does not support EdgeGrid authentication, you can use the same values to manually create the EdgeGrid authentication header. See the [EdgeGrid Protocol Specification][akamai-edgegrid-spec] for more details.

## Step 4: Clone the Akamai integration repository

1. Clone [the repository][proxy-github-repo]:

<CodeGroup>
  ```bash theme={"theme":"github-dark-dimmed"}
  git clone git@github.com:fingerprintjs/akamai-proxy.git
  ```
</CodeGroup>

2. Install dependencies using [PNPM][pnpm]:

<CodeGroup>
  ```bash theme={"theme":"github-dark-dimmed"}
  pnpm install
  ```
</CodeGroup>

## Step 5: Generate Patch Body

Use the `build` npm command to generate the integration's property rules for your Akamai property. Use the values from [previous steps][akamai-guide-v3] to configure the command:

* `integration-path`, `agent-path`, and `result-path` should be short, unique strings — avoid using `fpjs` or other recognizable words.
* `proxy-secret` can be created in [Fingerprint Dashboard → API Keys][fingerprint-api-keys].

<CodeGroup>
  ```bash theme={"theme":"github-dark-dimmed"}
  pnpm build --type patchBody \
      --integration-path "FPJS_INTEGRATION_PATH" \
      --agent-path "FPJS_AGENT_PATH" \
      --result-path "FPJS_RESULT" \
      --proxy-secret "FPJS_PROXY_SECRET"
  ```
</CodeGroup>

<Note>
  Replace variables between double quotes with the values you want to use. For example, `"FPJS_INTEGRATION_PATH"` should be replaced with the value you set for `FPJS_INTEGRATION_PATH` in [Step 2][akamai-step-2-v3].
</Note>

The output will be saved to `dist/patch-body/body.json`.

## Step 6: Deploy using Property Manager API

Use the following sequence of PAPI requests to collect the necessary data and deploy the integration.

* `baseURL` is created from the `host` value from the credentials file, e.g. `https://akab-xxxxxxxx.luna.akamaiapis.net`.
* Authenticate all requests using EdgeGrid credentials as described in [Step 3](#step-3-authenticate-with-edgegrid).

### Step 6.1: Get your Contract ID

<CodeGroup>
  ```http theme={"theme":"github-dark-dimmed"}
  GET https://{baseURL}/papi/v1/contracts
  ```
</CodeGroup>

**Sample Response:**

<CodeGroup>
  ```bash theme={"theme":"github-dark-dimmed"}
  {
    "accountId": "act_A-CCT5678",
    "contracts": {
      "items": [
        {
          "contractId": "ctr_C-0N7RAC71",
          "contractTypeName": "DIRECT_CUSTOMER"
        }
      ]
    }
  }
  ```
</CodeGroup>

Save the `contractId` to use in later requests.

### Step 6.2: Get your Group ID

<CodeGroup>
  ```http theme={"theme":"github-dark-dimmed"}
  GET https://{baseURL}/papi/v1/groups
  ```
</CodeGroup>

**Sample Response:**

<CodeGroup>
  ```bash theme={"theme":"github-dark-dimmed"}
  {
    "accountId": "act_A-CCT3456",
    "accountName": "Internet Company",
    "groups": {
      "items": [
        {
          "contractIds": ["ctr_C-0N7RAC71"],
          "groupId": "grp_32145",
          "groupName": "Example.com-1-1TJZH5"
        }
      ]
    }
  }
  ```
</CodeGroup>

Save the `groupId` associated with your `contractId` to use in later requests.

### Step 6.3: Get your Property ID

<CodeGroup>
  ```http theme={"theme":"github-dark-dimmed"}
  GET https://{baseURL}/papi/v1/properties?contractId=ctr_C-0N7RAC71&groupId=grp_32145
  ```
</CodeGroup>

**Sample Response:**

<CodeGroup>
  ```bash theme={"theme":"github-dark-dimmed"}
  {
    "properties": {
      "items": [
        {
          "accountId": "act_A-CCT9012",
          "assetId": "aid_101",
          "contractId": "ctr_C-0N7RAC7",
          "groupId": "grp_54321",
          "latestVersion": 2,
          "propertyId": "prp_175780",
          "propertyName": "example.com"
        }
      ]
    }
  }
  ```
</CodeGroup>

Find the property you want to deploy the integration to. Save its `propertyId` and `latestVersion` to use in later requests.

### Step 6.4: Get your Property Versions (optional but recommended)

To make changes to your property, you first need to clone one of its versions. To decide which version to clone, you can get the list of all versions for your property.

<CodeGroup>
  ```http theme={"theme":"github-dark-dimmed"}
  GET https://{baseURL}/papi/v1/properties/{propertyId}/versions?contractId=ctr_C-0N7RAC71&groupId=grp_32145
  ```
</CodeGroup>

**Sample Response:**

<CodeGroup>
  ```bash theme={"theme":"github-dark-dimmed"}
  {
    "accountId": "act_A-CCT7890",
    "assetId": "aid_101",
    "contractId": "ctr_C-0N7RAC71",
    "groupId": "grp_54321",
    "propertyId": "prp_173136",
    "propertyName": "981.catalog.jsmith.net",
    "versions": {
      "items": [
        {
          "propertyVersion": 2,
          "note": "updated caching",
          "productionStatus": "INACTIVE",
          "stagingStatus": "ACTIVE"
        },
        {
          "propertyVersion": 1,
          "note": "initial version",
          "productionStatus": "ACTIVE",
          "stagingStatus": "INACTIVE"
        }
      ]
    }
  }
  ```
</CodeGroup>

### Step 6.5: Clone the current version of your property

<CodeGroup>
  ```http theme={"theme":"github-dark-dimmed"}
  POST https://{baseURL}/papi/v1/properties/{propertyId}/versions?contractId=ctr_C-0N7RAC71&groupId=grp_32145
  ```
</CodeGroup>

**Request Body:**

<CodeGroup>
  ```bash theme={"theme":"github-dark-dimmed"}
  {
    "createFromVersion": PROPERTY_VERSION_TO_CLONE
  }
  ```
</CodeGroup>

<Note>
  `PROPERTY_VERSION_TO_CLONE` is the version number of the version you want to clone. For example, if you want to clone the version 2 of your property, set this value to `2`.
</Note>

**Sample Response:**

<CodeGroup>
  ```bash theme={"theme":"github-dark-dimmed"}
  {
    "versionLink": "/papi/v0/properties/prp_173136/versions/2?contractId=ctr_C-0N7RAC71&groupId=grp_15225"
  }
  ```
</CodeGroup>

### Step 6.6: Remove existing Fingerprint artifacts (if needed)

If your Akamai property already has the Fingerprint proxy integration installed, manually remove the Fingerprint artifacts before updating the integration. Otherwise, some artifacts will be duplicated and the integration will not work.

1. Navigate to [Akamai Control Center][akamai-control-center] → Properties.
2. Find the cloned property version.
3. Click **Edit** to begin editing rules.
4. Navigate to the **Variables** section and remove all variables that start with `PMUSER_FPJS_`.
5. Scroll to the bottom of the rule tree and delete the rule named **Fingerprint**.
6. Click **Save** to confirm the cleanup.

### Step 6.7: Patch the new version with Fingerprint integration rules

Finally, send a PATCH request to update your property's rule tree with the Fingerprint integration rules:

<CodeGroup>
  ```http theme={"theme":"github-dark-dimmed"}
  PATCH https://{baseURL}/papi/v1/properties/{propertyId}/versions/{newVersion}/rules?contractId=ctr_C-0N7RAC71&groupId=grp_32145
  ```
</CodeGroup>

* **Request body:** Copy-paste the content of the `dist/patch-body/body.json` file you created in [Step 5](#step-5-generate-patch-body).
* **Content-type:** header `application/json-patch+json`

**Sample Response:**

<CodeGroup>
  ```bash theme={"theme":"github-dark-dimmed"}
  {
    "accountId": "act_A-CCT1234",
    "contractId": "ctr_K-0N7RAK71",
    "etag": "a9dfe78cf93090516bde891d009eaf57",
    "groupId": "grp_12345",
    "propertyId": "prp_173136",
    "propertyName": "mytestproperty.com",
    "propertyVersion": 3,
    "ruleFormat": "v2015-08-08",
    "rules": {
      "name": "default",
      "behaviors": [],
      "children": []
    }
  }
  ```
</CodeGroup>

### Step 6.8: Activate the Patched Version

<CodeGroup>
  ```http theme={"theme":"github-dark-dimmed"}
  POST https://{baseURL}/papi/v1/properties/{propertyId}/activations?contractId=ctr_C-0N7RAC71&groupId=grp_32145
  ```
</CodeGroup>

* **Request body:**

<CodeGroup>
  ```bash theme={"theme":"github-dark-dimmed"}
  {
    "propertyVersion": PROPERTY_VERSION_TO_ACTIVATE,
    "network": "PRODUCTION",
    "notifyEmails": ["your email address to notify about activation status"],
    "acknowledgeAllWarnings": true,
    "activationType": "ACTIVATE"
  }
  ```
</CodeGroup>

<Note>
  `PROPERTY_VERSION_TO_ACTIVATE` is the version number of the version you previously cloned. For example, if you cloned version 2 of your property, set this value to `2`.
</Note>

<Note>
  Please do not forget to replace `your email address to notify about activation status` with your email address.
</Note>

**Sample Response:**

<CodeGroup>
  ```bash theme={"theme":"github-dark-dimmed"}
  {
    "activationLink": "/papi/v0/properties/prp_173136/activations/atv_67037?contractId=ctr_K-0N7RAK7&groupId=grp_15225"
  }
  ```
</CodeGroup>

<Warning>
  This will directly activate the version in `PRODUCTION`. If you want to deploy to staging first,
  change the `network` value to `STAGING`.
</Warning>

### Troubleshooting API requests

If you encounter an error, check the following:

| Issue                     | Resolution                                                                                                        |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `403 Unauthorized`        | Ensure your EdgeGrid credentials are correct and Postman is configured properly.                                  |
| `409 Conflict`            | You are trying to patch an already active version. Clone a new version first.                                     |
| `400 Bad Request`         | Check that your patch body is valid JSON and that `Content-Type` is set correctly.                                |
| `503 Service Unavailable` | [Check troubleshooting guide for SSL Verification error][akamai-supernet-troubleshooting]                         |
| Activation status unknown | Use the Akamai Control Center to monitor activations. The Property Manager API does not support progress polling. |

## Step 7: Configure the Fingerprint client agent

Please see the main Akamai proxy integration guide to [Configure the client agent on your website or mobile app][akamai-configure-agent-v3].

[akamai-configure-agent-v3]: /docs/v3/akamai-proxy-integration#configure-fingerprint-agent

[akamai-control-center]: https://control.akamai.com/

[akamai-edgegrid-auth]: https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials

[akamai-edgegrid-spec]: https://techdocs.akamai.com/developer/docs/authenticate-with-edgegrid#authentication-protocol-specification

[akamai-guide-v3]: /docs/v3/akamai-proxy-integration

[akamai-papi]: https://techdocs.akamai.com/property-mgr/reference/api

[akamai-step-1-v3]: /docs/v3/akamai-proxy-integration#step-1-issue-a-fingerprint-proxy-secret

[akamai-step-2-v3]: /docs/v3/akamai-proxy-integration#step-2-create-path-variables

[akamai-supernet-troubleshooting]: /docs/v3/troubleshooting-akamai-supernet-error

[akamai-terraform-v3]: /docs/v3/deploy-akamai-proxy-integration-via-terraform

[cloudflare-proxy-v3]: /docs/v3/cloudflare-integration

[custom-subdomain-v3]: /docs/v3/custom-subdomain-setup

[fingerprint-api-keys]: https://dashboard.fingerprint.com/api-keys

[pnpm]: https://pnpm.io/

[postman]: https://www.postman.com/

[proxy-github-repo]: https://github.com/fingerprintjs/akamai-proxy