### API Versioning Examples

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/QUICK-REFERENCE.md

Always specify the API version in the URL path. Examples show different API paths with their respective versions.

```bash
/papi/v1/...
```

```bash
/appsec/v1/...
```

```bash
/ccu/v3/...
```

--------------------------------

### Create an API client

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/identity-management-v3-endpoints.md

Creates a new API client. Optionally, you can automatically assign a credential for the client during creation. Refer to the authentication credentials setup guide for details if not assigning automatically.

```APIDOC
## POST /api-clients

### Description
Create an API client. Optionally, you can automatically assign a credential for the client when you create it. If you choose not to assign the credential automatically, see [Create authentication credentials](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) for details.

### Method
POST

### Endpoint
/api-clients

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Request Body
Content-Type: `application/json`

### Responses
#### Success Response (201)
- The response provides the newly created API client.

```

--------------------------------

### Example OpenAPI Specification URL

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/API-CATALOG.md

An example of a complete URL to fetch the OpenAPI 3.0 specification for the 'papi' API, version 'v1'.

```text
https://raw.githubusercontent.com/akamai/akamai-apis/main/apis/papi/v1/openapi.json
```

--------------------------------

### Deepscan POST Request Example

Source: https://github.com/akamai/akamai-apis/blob/main/apis/etp-report/v3/examples/deepscan-post-request.txt

This example demonstrates how to construct and send a POST request to the deepscan API. Ensure you have the correct API endpoint and authentication headers.

```bash
curl -X POST \
  'https://<api_host>/etp-report/v3/deepscan' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic <credentials>' \
  -d '{ \
    "file_name": "/834970/offlinescan_shared/3323112204_3323110387/403229d4f0895c21cf913cf127e14135130672b3e23a5e813c208d60a0a46bae.zip", \
    "file_type": "zip" \
  }'
```

--------------------------------

### Deepscan POST Request Example

Source: https://github.com/akamai/akamai-apis/blob/main/apis/etp-report/v3/examples/deepscan-post-request.txt

This example demonstrates how to make a POST request for a deepscan operation.

```APIDOC
## POST /etp-report/v3/deepscan

### Description
Initiates a deepscan operation for a specified file.

### Method
POST

### Endpoint
/etp-report/v3/deepscan

### Request Body
- **filePath** (string) - Required - The path to the file to be scanned.

### Request Example
{
  "filePath": "/834970/offlinescan_shared/3323112204_3323110387/403229d4f0895c21cf913cf127e14135130672b3e23a5e813c208d60a0a46bae.zip"
}

### Response
#### Success Response (200)
- **scanId** (string) - The unique identifier for the initiated scan.

#### Response Example
{
  "scanId": "scan_abc123xyz789"
}
```

--------------------------------

### GET /configs/{configId}/dictionaries/{dictionaryId}

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/etp-config-v3.md

Get a DLP dictionary. Returns details of a DLP dictionary.

```APIDOC
## GET /configs/{configId}/dictionaries/{dictionaryId}

### Description
Returns details of a DLP dictionary.

### Method
GET

### Endpoint
/configs/{configId}/dictionaries/{dictionaryId}

### Parameters
#### Header Parameters
- **If-Match** (string) - Yes - Use the `x_etag` value included in the GET response. See [Concurrency control](h
#### Query Parameters
- **accountSwitchKey** (string) - No - For customers who manage more than one account, this [runs the operation from an

#### Responses
#### Success Response (200)
Successful response.

#### Error Responses
- **400**: [Validation error.](https://techdocs.akamai.com/etp-config/reference/400)
- **401**: [Authentication error](https://techdocs.akamai.com/etp-config/reference/401). Se
- **403**: [Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403)
- **404**: [Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)
- **412**: [Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use
```

--------------------------------

### Big Alias Multi-Part Request Example

Source: https://github.com/akamai/akamai-apis/blob/main/apis/network-cloud-firewall/v1/examples/big-alias-multi-part-request.txt

This example demonstrates how to construct a multi-part POST request to the /upload endpoint for creating a big alias. It includes fields for alias name, IP version, and the file content.

```http
POST /upload HTTP/1.1
Content-Length: 428
Content-Type: multipart/form-data; boundary=abcde12345
--abcde12345
Content-Disposition: form-data; name="aliasName"
Content-Type: text/plain
big-alias-123
--abcde12345
Content-Disposition: form-data; name="ipVersion"
Content-Type: text/plain
V4
--abcde12345
Content-Disposition: form-data; name="file "; filename="upload.txt"
Content-Type: application/octet-stream
{…file content…}
--abcde12345--
```

--------------------------------

### GET /device-posture/inventory/summary/browsers

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/crux-v1-endpoints.md

Lists installed browser activity metrics for devices connecting to your applications.

```APIDOC
## GET /device-posture/inventory/summary/browsers

### Description
Lists installed browser activity metrics for devices connecting to your applications.

### Method
GET

### Endpoint
/device-posture/inventory/summary/browsers

### Parameters
#### Query Parameters
- **contractId** (string) - Optional - The Akamai contract identifier for your Enterprise Application Access product.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Responses
#### Success Response (200)
- Successful response.
```

--------------------------------

### POST /configs/{configId}/onboard-tenant

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/etp-config-v3.md

Onboards a new tenant to a specified configuration.

```APIDOC
## POST /configs/{configId}/onboard-tenant

### Description
Onboards a new Tenant.

### Method
POST

### Endpoint
`/configs/{configId}/onboard-tenant`

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an account.

### Request Body
Content-Type: `application/json`

### Responses
#### Success Response (200)
Successful response.

#### Error Responses
- **400**: Validation error.
- **401**: Authentication error.
- **403**: Insufficient permissions.
- **404**: Configuration not Found.
- **406**: Resource already onboarded.
```

--------------------------------

### Get Client Status

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/etp-config-v3.md

Retrieves the status of client software installed on devices, including counts of devices with and without errors.

```APIDOC
## GET /configs/{configId}/client/status

### Description
Provides details of software installed with device counts. Also specifies errors and device count with errors.

### Method
GET

### Endpoint
/configs/{configId}/client/status

#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an account.

#### Responses
- **200** - Successful response.
- **400** - Validation error.
- **401** - Authentication error.
- **403** - Insufficient permissions.
- **404** - Configuration not Found.
```

--------------------------------

### Get Client Status

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/etp-config-v3-endpoints.md

Provides details of software installed with device counts. Also specifies errors and device count with errors.

```APIDOC
## GET /configs/{configId}/client/status

### Description
Provides details of software installed with device counts. Also specifies errors and device count with errors.

### Method
GET

### Endpoint
/configs/{configId}/client/status

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Responses
#### Success Response (200)
Successful response.

#### Error Responses
- **400**: Validation error.
- **401**: Authentication error.
- **403**: Insufficient permissions.
- **404**: Configuration not Found.
```

--------------------------------

### Onboard a Tenant

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/etp-config-v3-endpoints.md

Onboards a new tenant to the ETP configuration.

```APIDOC
## POST /configs/{configId}/onboard-tenant

### Description
Onboards a new Tenant.

### Method
POST

### Endpoint
/configs/{configId}/onboard-tenant

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Request Body
Content-Type: `application/json`

### Responses
#### Success Response (200)
Successful response.
#### Error Responses
- **400**: [Validation error.](https://techdocs.akamai.com/etp-config/reference/400)
- **401**: [Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](http
- **403**: [Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](h
- **404**: [Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)
- **406**: [Resource already onboarded](https://techdocs.akamai.com/etp-config/reference/406).
```

--------------------------------

### GET /configs

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/appsec-v1-endpoints.md

Lists available security configurations for all products.

```APIDOC
## GET /configs

### Description
Lists available security configurations.

### Method
GET

### Endpoint
/configs

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Responses
#### Success Response (200)
Successful response.

#### Error Responses
- **403**: Forbidden. You don't have access to this resource.
- **404**: Not found. That resource doesn't exist.
```

--------------------------------

### Get Permission Group

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/edgeworkers-v1.md

View details on the capabilities enabled within a specified group, for example: activate a version or fetch an EdgeWorker ID.

```APIDOC
## GET /groups/{groupId}

### Description
View details on the capabilities enabled within a specified group, for example: activate a version or fetch an EdgeWorker ID.

### Method
GET

### Endpoint
/groups/{groupId}

#### Path Parameters
- **groupId** (string) - Required - The ID of the group to retrieve.

#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an account.

#### Success Response (200)
- **Capabilities** (object) - This section describes EdgeWorker capabilities allowed within the Akamai group.
```

--------------------------------

### GET /configs/{configId}/firstTimeWizard

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/etp-config-v3.md

Retrieves the current status of the first-time wizard for a specific configuration. This is useful for understanding if a user has completed the initial setup.

```APIDOC
## GET /configs/{configId}/firstTimeWizard

### Description
Provides the first time wizard status.

### Method
GET

### Endpoint
/configs/{configId}/firstTimeWizard

### Parameters
#### Header Parameters
- **If-Match** (string) - Required - Use the `x_etag` value included in the GET response. See [Concurrency control](h

#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this [runs the operation from an

### Responses
#### Success Response (200)
Successful response.

#### Error Responses
- **400**: [Validation error.](https://techdocs.akamai.com/etp-config/reference/400)
- **401**: [Authentication error](https://techdocs.akamai.com/etp-config/reference/401). Se
- **403**: [Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403)
- **404**: [Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)
```

--------------------------------

### POST /configs/{configId}/dictionaries

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/etp-config-v3.md

Create a DLP dictionary. Creates a DLP dictionary.

```APIDOC
## POST /configs/{configId}/dictionaries

### Description
Creates a DLP dictionary.

### Method
POST

### Endpoint
/configs/{configId}/dictionaries

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - No - For customers who manage more than one account, this [runs the operation from an

#### Request Body
Content-Type: `application/json`

#### Responses
#### Success Response (200)
Successful response.

#### Error Responses
- **400**: [Validation error.](https://techdocs.akamai.com/etp-config/reference/400)
- **401**: [Authentication error](https://techdocs.akamai.com/etp-config/reference/401). Se
- **403**: [Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403)
- **404**: [Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)
```

--------------------------------

### Create an onboarding

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/appsec-v1.md

Creates a new onboarding process for App & API Protector. This can be used to set up new resources like CPS certificates and security protections, or to apply security protections to existing resources. Note that hostnames requiring delivery settings and those only needing security protections must be onboarded separately.

```APIDOC
## POST /onboardings

### 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.

### Method
POST

### Endpoint
/onboardings

### Parameters
#### Query Parameters
- **createNewResourcesOnly** (boolean) - Optional - This creates an onboarding with a new CPS certificate and security protections.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an

### Responses
#### Success Response (201)
- Successfully created an onboarding object.

#### Error Responses
- **400**: Bad request
- **403**: Forbidden
```

--------------------------------

### Get onboarding settings

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/appsec-v1.md

Retrieves the settings for a specific onboarding.

```APIDOC
## GET /onboardings/{onboardingId}/settings

### Description
Gets the settings for a specific onboarding.

### Method
GET

### Endpoint
/onboardings/{onboardingId}/settings

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an account.

### Responses
#### Success Response (200)
- Successfully returned onboarding settings.

#### Error Responses
- **403**: Forbidden. You.
- **404**: Not found. Onb.
```

--------------------------------

### Get Load Feedback Report Window

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/gtm-api-v1.md

Retrieves the date range of available data for load feedback reports. The returned start and end values can be used as bounds for queries to the load feedback report endpoint.

```APIDOC
## GET /load-feedback/domains/{domain}/window

### Description
Get a load feedback report window

Returns the date range of data available for load feedback reports. Use the returned `start` and `end` values as the bounds for queries to the load feedback report endpoint.

### Method
GET

### Endpoint
/load-feedback/domains/{domain}/window

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an account.

### Responses
#### Success Response (200)
Successful response.
```

--------------------------------

### Get a directed demand report window

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/gtm-api-v1.md

Returns the date range of data available for directed demand reports. The returned `start` and `end` values can be used as bounds for queries to the directed demand report endpoint.

```APIDOC
## GET /demand/domains/{domain}/properties/{property}/window

### Description
Get a directed demand report window.

### Method
GET

### Endpoint
`/demand/domains/{domain}/properties/{property}/window`

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an account.

### Responses
#### Success Response (200)
Successful response.
```

--------------------------------

### POST /activations

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/appsec-v1-endpoints.md

Activates one or more configurations globally. Requires acknowledging any invalid hosts.

```APIDOC
## POST /activations

### Description
Activates one or more configurations globally. Note that you need to explicitly list any invalid hosts in the `acknowledgedInvalidHostsByConfig` parameter in order to successfully activate a configuration that includes invalid hostnames. If you have an invalid hostname that isn't explicitly called out you'll receive an error telling you to add them to `acknowledgedInvalidHostsByConfig`.

### Method
POST

### Endpoint
/activations

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Request Body
Content-Type: `application/json`

### Response
#### Success Response (200)
Activation request successful.

#### Success Response (202)
Activation request launched.
```

--------------------------------

### Get Property Traffic Report Window

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/gtm-api-v1-endpoints.md

Retrieves the date range of data available for property traffic reports. Use the returned `start` and `end` values as the bounds for queries to the property traffic report endpoint.

```APIDOC
## GET /traffic/properties-window

### Description
Get a property traffic report window. Returns the date range of data available for property traffic reports. Use the returned `start` and `end` values as the bounds for queries to the property traffic report endpoint.

### Method
GET

### Endpoint
/traffic/properties-window

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Responses
#### Success Response (200)
Successful response.
```

--------------------------------

### List onboarding domain challenges

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/appsec-v1.md

Retrieves information for validating your domains by adding TXT or CNAME DNS records.

```APIDOC
## GET /onboardings/{onboardingId}/domain-validation

### Description
Returns the information you need to validate your domains. Add the `TXT` or `CNAME` value listed in the response to your DNS record. Adding the record won't affect your website. Once you've added the record, and before the token expires, run [Validate onboarding domains](https://techdocs.akamai.com/application-security/docs/post-onboarding-domain-validation).

### Method
GET

### Endpoint
/onboardings/{onboardingId}/domain-validation

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an

### Responses
#### Success Response (200)
- **DomainChallenges** (object) - Information for domain validation challenges.

#### Error Responses
- **403** - Forbidden
- **404** - Not found
- **500** - Internal server error
```

--------------------------------

### List onboarding certificate challenges

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/appsec-v1.md

Retrieves the information needed to validate your certificate by adding a TXT DNS record.

```APIDOC
## GET /onboardings/{onboardingId}/certificate-validation

### Description
Returns the information you need to validate your certificate. Add the `TXT` DNS record listed in the response to your DNS record. Adding the `TXT` record won't affect your website. Once you've added the `TXT` record, and before the token expires, run [Validate onboarding certificate](https://techdocs.akamai.com/application-security/docs/post-onboarding-certificate-validation) to validate the certificate.

### Method
GET

### Endpoint
/onboardings/{onboardingId}/certificate-validation

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an

### Responses
#### Success Response (200)
- **Challenges** (object) - Description of certificate challenges.

#### Error Responses
- **403** - Forbidden
- **404** - Not found
- **500** - Conflict
```

--------------------------------

### Get Datacenter Traffic Report Window

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/gtm-api-v1-endpoints.md

Retrieves the date range of data available for datacenter traffic reports. Use the returned `start` and `end` values as the bounds for queries to the datacenter traffic report endpoint.

```APIDOC
## GET /traffic/datacenters-window

### Description
Get a datacenter traffic report window. Returns the date range of data available for datacenter traffic reports. Use the returned `start` and `end` values as the bounds for queries to the datacenter traffic report endpoint.

### Method
GET

### Endpoint
/traffic/datacenters-window

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Responses
#### Success Response (200)
Successful response.
```

--------------------------------

### Get a load feedback report window

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/gtm-api-v1-endpoints.md

Retrieves the date range for which load feedback data is available. The returned start and end dates can be used to define the boundaries for queries to the load feedback report endpoint.

```APIDOC
## GET /load-feedback/domains/{domain}/window

### Description
Get a load feedback report window

Returns the date range of data available for load feedback reports. Use the returned `start` and `end` values as the bounds for queries to the load feedback report endpoint.

### Method
GET

### Endpoint
/load-feedback/domains/{domain}/window

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Responses
#### Success Response (200)
- Successful response.
```

--------------------------------

### Get Directed Demand Report Window

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/gtm-api-v1-endpoints.md

Retrieves the available date range for directed demand reports. The returned `start` and `end` values can be used to define the bounds for queries to the directed demand report endpoint.

```APIDOC
## GET /demand/domains/{domain}/properties/{property}/window

### Description
Get a directed demand report window. Returns the date range of data available for directed demand reports. Use the returned `start` and `end` values as the bounds for queries to the directed demand report endpoint.

### Method
GET

### Endpoint
/demand/domains/{domain}/properties/{property}/window

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Responses
#### Success Response (200)
Successful response.
```

--------------------------------

### Create Site

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/etp-config-v3-endpoints.md

Creates a new site within a specified configuration. Requires the configuration ID.

```APIDOC
## POST /configs/{configId}/sites

### Description
Create a site

Creates a new site.

### Method
POST

### Endpoint
/configs/{configId}/sites

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/etp-config/reference/account-switch)

### Request Body
Content-Type: `application/json`

### Responses
#### Success Response (200)
Successful response.

#### Error Responses
- **400** - [Validation error.](https://techdocs.akamai.com/etp-config/reference/400)
- **401** - [Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](http://techdocs.akamai.com/etp-config/reference/authentication)
- **403** - [Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](http://techdocs.akamai.com/etp-config/reference/authentication)
- **404** - [Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)
```

--------------------------------

### Get PII Learning Settings

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/appsec-v1-endpoints.md

Retrieves the current PII learning settings for a specific security configuration version. This helps understand if PII learning is enabled for your Kona Site Defender or App & API Protector setup.

```APIDOC
## GET /configs/{configId}/versions/{versionNumber}/advanced-settings/pii-learning

### Description
Get PII learning settings for a configuration. This operation applies at the security configuration level.

### Method
GET

### Endpoint
/configs/{configId}/versions/{versionNumber}/advanced-settings/pii-learning

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Responses
#### Success Response (200)
- **Success** - Successfully retrieved the PII learning settings.

#### Error Responses
- **400** - Invalid client error.
- **404** - Not found. The security policy does not exist.
- **500** - Internal server error.
```

--------------------------------

### GET /products

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/papi-v1.md

Lists the available products under a given contract. This is necessary for creating new edge hostnames, CP codes, or properties, and determines the available rule behaviors.

```APIDOC
## GET /products

### Description
Lists the set of products available under a given contract. A product identifier is needed to create new edge hostnames, CP codes, or properties. The assigned product determines the supported set of rule behaviors available within a property.

### Method
GET

### Endpoint
/products

### Parameters
#### Header Parameters
- **PAPI-Use-Prefixes** (string) - Required - Enum: ['true', 'false'] - Sets whether to represent ID prefixes.
#### Query Parameters
- **contractId** (string) - Required - Unique identifier for the contract.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an alternate account.

### Response
#### Success Response (200)
- The response lists products available in a contract.

#### Error Responses
- **400**: Bad request
- **401**: Unauthorized
- **403**: Forbidden
- **404**: Not found
- **405**: Method not allowed
- **406**: Not acceptable
- **429**: Too many requests
- **500**: Internal server error
```

--------------------------------

### Get an anti-malware profile

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/crux-v1.md

Get an anti-malware profile.

```APIDOC
## GET /device-posture/risk-assessment/certificate-usage/anti-malware-profiles/{antiMalwareProfileId}

### Description
Get an anti-malware profile.

### Method
GET

### Endpoint
/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/{antiMalwareProfileId}

#### Query Parameters
- **contractId** (string) - Optional - The Akamai contract identifier for your Enterprise Application Access product.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this [runs the operation from an

### Responses
#### Success Response (200)
Successful response.
```

--------------------------------

### Create Onboarding

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/appsec-v1-endpoints.md

Creates a new onboarding for App & API Protector. You can specify whether to create new resources (like a CPS certificate and security protections) or only apply security protections to existing resources. Hostnames requiring delivery settings and those only needing security protections must be in separate onboardings.

```APIDOC
## POST /onboardings

### 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.

### Method
POST

### Endpoint
/onboardings

### Parameters
#### Query Parameters
- **createNewResourcesOnly** (boolean) - Optional - This creates an onboarding with a new CPS certificate and security protections. If your contract lim
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this [runs the operation from another account](https

### Request Body
Content-Type: `application/json`

### Responses
#### Success Response (201)
- Successfully created an onboarding object.

#### Error Response (400)
- [Bad request](https://techdocs.akamai.com/application-security/reference/400). Invalid request body

#### Error Response (403)
- [Forbidden](https://techdocs.akamai.com/application-security/reference/403). You don't have create S
```

--------------------------------

### GET /cves/{cveId}

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/appsec-v1-endpoints.md

Get details for a specific CVE.

```APIDOC
## GET /cves/{cveId}

### Description
Get details for a specific CVE.

### Method
GET

### Endpoint
/cves/{cveId}

### Parameters
#### Path Parameters
- **cveId** (string) - Required - The ID of the CVE.

#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Responses
#### Success Response (200)
Successful response.

#### Error Responses
- **401**: Unauthorized.
- **403**: Forbidden. You don't have access.
- **404**: Not found. That resource doesn't exist.
- **405**: Method not allowed.
- **406**: Not acceptable.
```

--------------------------------

### Get certificate profile

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/crux-v1.md

Get a certificate profile by its id.

```APIDOC
## GET /device-posture/risk-assessment/certificate-profiles/{certificateProfileId}

### Description
Get a certificate profile by its id.

### Method
GET

### Endpoint
/device-posture/risk-assessment/certificate-profiles/{certificateProfileId}

#### Query Parameters
- **contractId** (string) - Optional - The Akamai contract identifier for your Enterprise Application Access product.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this [runs the operation from an

### Responses
#### Success Response (200)
Successful response.
```

--------------------------------

### POST /site-snapshots

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/storage-v1.md

Create a new site snapshot configuration.

```APIDOC
## POST /site-snapshots

### Description
Use this operation to create a new site snapshot configuration.

### Method
POST

### Endpoint
/site-snapshots

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - No - For customers who manage more than one account, this [runs the operation from an

### Request Body
Content-Type: `application/json`

### Responses
#### Success Response (200)
Site snapshot entity created and returned.

#### Error Responses
- **400** - Badly formatted JSON. Compare with the schema.
- **401** - Unauthorized Request.
- **403** - Application permission error.
- **429** - The maximum request count for a specific time duration for this resource has bee
```

--------------------------------

### Create Application Bundle

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/crux-v1.md

Creates a new application bundle.

```APIDOC
## POST /mgmt-pop/appbundle

### Description
Creates a new application bundle.

### Method
POST

### Endpoint
`/mgmt-pop/appbundle`

### Parameters
#### Query Parameters
- **contractId** (string) - Required - The Akamai contract identifier for your Enterprise Application Access product.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an alternate account.

### Request Body
Content-Type: `application/json`

### Responses
#### Success Response (200)
Successful response.
```

--------------------------------

### Get an include

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/papi-v1.md

This operation gets a specific include. Limited availability.

```APIDOC
## GET /includes/{includeId}

### Description
Get an include. This operation gets a specific include. You can call this operation by specifying any of the `includeId` members from a [list of includes](https://techdocs.akamai.com/property-mgr/reference/get-includes), or by running a GET on the `includeLink` response when [creating a new include](https://techdocs.akamai.com/property-mgr/reference/post-includes).

### Method
GET

### Endpoint
/includes/{includeId}

### Parameters
#### Query Parameters
- **contractId** (string) - No - Unique identifier for the contract. The parameter is optional if a property belongs to a contract.
- **groupId** (string) - No - Unique identifier for the group. The parameter is optional if a property belongs to a group.
- **accountSwitchKey** (string) - No - For customers who manage more than one account, this runs the operation from an account.

### Responses
#### Success Response (200)
- The response shows details for the requested include.

#### Error Responses
- **400**: [Bad request](https://techdocs.akamai.com/property-mgr/reference/400).
- **401**: [Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).
- **403**: [Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).
- **404**: [Not found](https://techdocs.akamai.com/property-mgr/reference/404).
- **405**: [Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).
- **406**: [Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).
- **429**: [Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).
- **500**: [Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).
```

--------------------------------

### Get a CP Code

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/papi-v1.md

Gets details about a specific CP code.

```APIDOC
## GET /cpcodes/{cpcodeId}

### Description
Gets details about a CP code.

### Method
GET

### Endpoint
/cpcodes/{cpcodeId}

### Parameters
#### Header Parameters
- **PAPI-Use-Prefixes** (string: ['true', 'false']) - Required - Sets whether to represent ID prefixes.

#### Query Parameters
- **contractId** (string) - Required - Unique identifier for the contract.
- **groupId** (string) - Required - Unique identifier for the group.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an alternate account.

### Responses
#### Success Response (200)
- The response lists available CP codes.

#### Error Responses
- 400: Bad request
- 401: Unauthorized
- 403: Forbidden
- 404: Not found
- 405: Method not allowed
- 406: Not acceptable
- 429: Too many requests
- 500: Internal server error
```

--------------------------------

### POST /site-snapshots/schedule-now

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/storage-v1.md

Create an immediate site snapshot with specified ID and name.

```APIDOC
## POST /site-snapshots/schedule-now

### Description
Create an immediate snapshot for a `snapshotId` and `snapshotName` you provide.

### Method
POST

### Endpoint
/site-snapshots/schedule-now

### Parameters
#### Query Parameters
- **snapshotId** (integer) - Yes - ID of the snapshot schedule being requested.
- **snapshotName** (string) - Yes - Name of the snapshot schedule requested.
- **accountSwitchKey** (string) - No - For customers who manage more than one account, this [runs the operation from an

### Responses
#### Success Response (200)
Site snapshot object created.

#### Error Responses
- **400** - Badly formatted JSON. Compare with the schema.
- **401** - Unauthorized Request.
- **403** - Application permission error.
- **429** - The maximum request count for a specific time duration for this resource has bee
```

--------------------------------

### POST /configs/{configId}/sites

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/etp-config-v3.md

Creates a new site within a specified configuration.

```APIDOC
## POST /configs/{configId}/sites

### Description
Creates a new site.

### Method
POST

### Endpoint
/configs/{configId}/sites

### Parameters
#### Path Parameters
- **configId** (string) - Required - The ID of the configuration.

#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an account.

### Request Body
Content-Type: `application/json`

### Responses
#### Success Response (200)
- **Successful response.**

#### Error Responses
- **400** - [Validation error.](https://techdocs.akamai.com/etp-config/reference/400)
- **401** - [Authentication error](https://techdocs.akamai.com/etp-config/reference/401). Se
- **403** - [Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403)
- **404** - [Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)
```

--------------------------------

### GET /mgmt-pop/directories/{directory_id}/users/byname/{user_id}

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/crux-v1-endpoints.md

Gets details of a user.

```APIDOC
## GET /mgmt-pop/directories/{directory_id}/users/byname/{user_id}

### Description
Gets details of a user.

### Method
GET

### Endpoint
/mgmt-pop/directories/{directory_id}/users/byname/{user_id}

### Parameters
#### Query Parameters
- **contractId** (string) - Required - The Akamai contract identifier for your Enterprise Application Access product.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Response
#### Success Response (200)
Successful response.
```

--------------------------------

### GET /mgmt-pop/appidp/{appIdpId}

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/crux-v1.md

Get details for a specific application IDP.

```APIDOC
## GET /mgmt-pop/appidp/{appIdpId}

### Description
Get details for a specific application IDP.

### Method
GET

### Endpoint
/mgmt-pop/appidp/{appIdpId}

### Parameters
#### Query Parameters
- **contractId** (string) - Required - The Akamai contract identifier for your Enterprise Application Access product.
- **expand** (boolean) - Optional - When set to `true`, includes additional members in the request.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an account.

### Responses
#### Success Response (200)
Successful response.
```

--------------------------------

### List Available Hostnames

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/appsec-v1.md

Lists all acceptable hostnames that can be used for a new configuration within a given contract and group. This is useful for initial setup when you need to know all possible hostname options.

```APIDOC
## GET /contracts/{contractId}/groups/{groupId}/selectable-hostnames

### Description
List available hostnames for a new configuration. Lists the hostnames for a given contract and group. Use this operation for a new configuration, and use [List selectable hostnames](https://techdocs.akamai.com/application-security/reference/get-selectable-hostnames) to see a list of hostnames you can add to an existing configuration. This operation shows you every acceptable hostname you can use, where the other hostname operation omits any hostnames already included in your configuration.

### Method
GET

### Endpoint
/contracts/{contractId}/groups/{groupId}/selectable-hostnames

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an account.

### Responses
#### Success Response (200)
Successful response.

#### Error Responses
- **400**: Bad request.
- **403**: Forbidden.
- **404**: Not found.
```

--------------------------------

### Activate Onboarding

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/appsec-v1.md

Activates an onboarding process on the staging or production networks. Activation on the staging network must precede activation on production. This operation allows activation on only one network at a time. After activating on staging, you can test your site as usual.

```APIDOC
## POST /onboardings/{onboardingId}/activations

### Description
Activate an onboarding on the staging or production networks.

### Method
POST

### Endpoint
/onboardings/{onboardingId}/activations

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from an account.

### Request Body
Content-Type: `application/json`

### Responses
#### Success Response (202)
Successfully updated the onboarding settings.

#### Error Response (403)
Forbidden. You

#### Error Response (404)
Not found. Onb

#### Error Response (409)
Conflict. Inva

#### Error Response (422)
Unprocessable content.
```

--------------------------------

### GET /device-posture/risk-assessment/ca-ocsp

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/crux-v1-endpoints.md

Get CA and OCSP information for use in certificate profiles.

```APIDOC
## GET /device-posture/risk-assessment/ca-ocsp

### Description
Get CA and OCSP information.

Get CA and OCSP information for use in certificate profiles.

### Method
GET

### Endpoint
/device-posture/risk-assessment/ca-ocsp

### Parameters
#### Query Parameters
- **contractId** (string) - Optional - The Akamai contract identifier for your Enterprise Application Access product.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Response
#### Success Response (200)
- Successful response.
```

--------------------------------

### Get Directory User

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/crux-v1.md

Gets details of a specific user within a directory.

```APIDOC
## GET `/mgmt-pop/directories/{directory_id}/users/byname/{user_id}`

### Description
Gets details of a user.

### Method
GET

### Endpoint
`/mgmt-pop/directories/{directory_id}/users/byname/{user_id}`

### Parameters
#### Query Parameters
- **contractId** (string) - Required - The Akamai contract identifier for your Enterprise Application Access product.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this [runs the operation from an

### Responses
#### Success Response (200)
Successful response.
```

--------------------------------

### POST /mgmt-pop/appbundle

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/crux-v1-endpoints.md

Creates a new application bundle. Requires a contract ID and optionally accepts an account switch key.

```APIDOC
## POST /mgmt-pop/appbundle

### Description
Creates a new application bundle.

### Method
POST

### Endpoint
/mgmt-pop/appbundle

### Parameters
#### Query Parameters
- **contractId** (string) - Required - The Akamai contract identifier for your Enterprise Application Access product.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Request Body
Content-Type: `application/json`

### Response
#### Success Response (200)
Successful response.
```

--------------------------------

### List Onboarding Domain Challenges

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/appsec-v1-endpoints.md

Retrieves information needed to validate your domains. Add the TXT or CNAME value to your DNS record to proceed with validation.

```APIDOC
## GET /onboardings/{onboardingId}/domain-validation

### Description
List onboarding domain challenges. Returns the information you need to validate your domains. Add the `TXT` or `CNAME` value listed in the response to your DNS record. Adding the record won't affect your website. Once you've added the record, and before the token expires, run [Validate onboarding domains](https://techdocs.akamai.com/application-security/docs/post-onboarding-domain-validation).

### Method
GET

### Endpoint
/onboardings/{onboardingId}/domain-validation

### Parameters
#### Query Parameters
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this runs the operation from another account.

### Responses
#### Success Response (200)
Successfully retrieved domain validation challenges.
#### Error Response (403)
Forbidden. You aren't authorized to perform this operation.
#### Error Response (404)
Not found. The `onboardingId` was not found.
#### Error Response (500)
Internal server error. Failure to retrieve domain validation challenges.
```

--------------------------------

### Get a URL location rule

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/crux-v1.md

Gets the URL location rule for an application.

```APIDOC
## GET /mgmt-pop/apps/{applicationId}/urllocation/{locationId}

### Description
Gets the URL location rule for an application.

### Method
GET

### Endpoint
/mgmt-pop/apps/{applicationId}/urllocation/{locationId}

### Parameters
#### Query Parameters
- **contractId** (string) - Required - The Akamai contract identifier for your Enterprise Application Access product.
- **accountSwitchKey** (string) - Optional - For customers who manage more than one account, this [runs the operation from an

### Responses
#### Success Response (200)
Successful response.
```

--------------------------------

### Get an alert summary

Source: https://github.com/akamai/akamai-apis/blob/main/_autodocs/api-reference/alerts-v2.md

Get the summary of basic metadata for a single alert.

```APIDOC
## GET /alert-summaries/{definitionId}

### Description
Get the summary of basic metadata for a single alert.

### Method
GET

### Endpoint
/alert-summaries/{definitionId}

#### Query Parameters
- **accountSwitchKey** (string) - No - For customers who manage more than one account, this [runs the operation from an

### Responses
#### Success Response (200)
- The response provides the alert summary.

#### Error Responses
- **400**: [Bad request](https://techdocs.akamai.com/alerts-app/reference/400)
- **401**: [Unauthorized error](https://techdocs.akamai.com/alerts-app/reference/401)
- **403**: [Access is forbidden](https://techdocs.akamai.com/alerts-app/reference/403)
- **404**: [Resource not found](https://techdocs.akamai.com/alerts-app/reference/404)
- **405**: [Method not allowed](https://techdocs.akamai.com/alerts-app/reference/405)
- **500**: [Server error](https://techdocs.akamai.com/alerts-app/reference/500)
```