Logo
Akamai APIs API Documentation

Create or clone an include

POST https://{{host}}/papi/v1/includes?contractId={{contractId}}&groupId={{groupId}}

Limited availability This operation either creates a new include from scratch or bases one on another include's rule tree. Version 1 of a new include is created automatically.

 

Body PARAM

Key Datatype Required Description  
contractId
 string (Required) Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix. 
groupId
 string (Required) Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix. 
accountSwitchKey
 string (Optional) 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 Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).



HEADERS

Curl
curl -X POST 'https://host/papi/v1/includes?contractId=&groupId=?contractId=&groupId=&accountSwitchKey=' -H 'PAPI-Use-Prefixes: PAPI-Use-Prefixes' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"includeName":"my.new.include1.com","includeType":"COMMON_SETTINGS","productId":"prd_Alta","ruleFormat":"v2022-10-18"}'

  • FAQs

  • More

    Claim this page

    Report this page

ENDPOINTS

    Key Datatype Required Description  
    PAPI-Use-Prefixes
    		 string (Required) __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs. 
    Content-Type
    		 string 
    Accept
    		 string