# Akamai Property Manager API API > Akamai Property Manager API API on Apizie: 79 endpoints (Get build details, Bulk activate a set of properties, List bulk-activated properties, Bulk version a set of properties, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:akamai-papi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:akamai-papi` - Category: Cloud - Status: byok - Source: https://techdocs.akamai.com/home/page/apis - Page: https://zieapi.vercel.app/api/cloud/akamai-papi - OpenAPI: https://zieapi.vercel.app/api/cloud/akamai-papi/openapi.json ## Endpoints ### Get build details `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-build` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Bulk activate a set of properties `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-bulk-activations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and… | | groupId | string | no | Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### List bulk-activated properties `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-bulk-activation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | bulkActivationId | integer | yes | Identifies each bulk activation job. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and… | | groupId | string | no | Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Bulk version a set of properties `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-bulk-version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and… | | groupId | string | no | Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### List bulk-versioned properties `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-bulk-version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | bulkCreateId | integer | yes | Identifies each bulk-versioning job. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and… | | groupId | string | no | Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Bulk patch a set of properties `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-bulk-patch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and… | | groupId | string | no | Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### List bulk-patched properties `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-bulk-patch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | bulkPatchId | integer | yes | Identifies each bulk patch job. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and… | | groupId | string | no | Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Bulk search a set of properties or includes `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-bulk-search` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and… | | groupId | string | no | Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### Synchronously bulk search a set of properties or includes `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-bulk-search-synch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and… | | groupId | string | no | Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### List bulk search results `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-bulk-search` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | bulkSearchId | integer | yes | Identifies each bulk search job. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and… | | groupId | string | no | Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Get client settings `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-client-settings` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Update client settings `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/put-client-settings` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### List contracts `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-contracts` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List CP codes `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-cpcodes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | yes | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Create a new CP code `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-cpcodes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | yes | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### Get a CP code `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-cpcode` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | cpcodeId | string | yes | Unique identifier for the CP code. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | yes | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List custom behaviors `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-custom-behaviors` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Get a custom behavior `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-custom-behavior` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | behaviorId | string | yes | Unique identifier for the custom behavior. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List custom overrides `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-custom-overrides` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Get a custom override `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-custom-override` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | overrideId | string | yes | Unique identifier for the custom override. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List edge hostnames `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-edgehostnames` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | yes | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | options | string | no | Currently the only supported option is `mapDetails` that enables extra mapping-related information. See [Site Shield… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Create a new edge hostname `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-edgehostnames` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | yes | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | options | string | no | Currently the only supported option is `mapDetails` that enables extra mapping-related information. See [Site Shield… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### Get an edge hostname `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-edgehostname` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | edgeHostnameId | string | yes | Unique identifier for the edge hostname. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | yes | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | options | string | no | Currently the only supported option is `mapDetails` that enables extra mapping-related information. See [Site Shield… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List groups `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List hostnames for an account `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-hostnames` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | offset | integer | no | For paginated responses, specifies the page of results you want to navigate to, starting from `0`. | | limit | integer | no | For paginated responses, specifies the number of `hostnames` objects to include on each page. | | sort | string | no | __Enum__ Sort the results based on the `cnameFrom` value, either `hostname:a` for ascending or `hostname:d` for descending order. The… | | hostname | string | no | Filter the results by `cnameFrom`. Supports wildcard matches with `*`. | | cnameTo | string | no | Filter the results by edge hostname. Supports wildcard matches with `*`. | | network | string | no | __Enum__ Network of activated hostnames, either `STAGING` or `PRODUCTION`. | | contractId | string | no | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | no | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Generate domain validation challenges `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-certificate-challenges` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### Get audit history `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-hostname-audit-history` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | The `cnameFrom` for the hostname your end users see, indicated by the `Host` header in end user requests. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List includes `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-includes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | modifiedSince | string | no | Filters properties or includes that have been modified in a specified time. Accepts duration in the ISO 8601 format. | | modifiedNetwork | string | no | __Enum__ Filters and only shows properties or includes that have been modified within a specified period on a selected network, either… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | yes | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Create or clone an include `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-includes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | yes | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### Validate an include `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-include-validation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | activationId | string | yes | Unique identifier for the property or include activation. | | propertyVersion | integer | yes | Property's incremental version number. | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | offset | integer | no | For paginated responses, specifies the page of results you want to navigate to, starting from `0`. | | limit | integer | no | For paginated responses, specifies the number of `hostnames` objects to include on each page. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Get an include `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-include` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Remove an include `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/delete-include` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List include's activations `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-include-activations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Activate or deactivate an include `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-include-activation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### Get an include activation `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-include-activation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | activationId | string | yes | Unique identifier for the property or include activation. | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Cancel an include's pending activation `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/delete-include-activation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | activationId | string | yes | Unique identifier for the property or include activation. | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List parent properties `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-include-parents` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | offset | integer | no | For paginated responses, specifies the page of results you want to navigate to, starting from `0`. | | limit | integer | no | For paginated responses, specifies the number of `hostnames` objects to include on each page. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List include versions `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-include-versions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | offset | integer | no | For paginated responses, specifies the page of results you want to navigate to, starting from `0`. | | limit | integer | no | For paginated responses, specifies the number of `hostnames` objects to include on each page. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Create a new include version `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-include-versions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### Get the latest include version `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-latest-include-version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | activatedOn | string | no | __Enum__ If present, returns the latest version activated on the given network, either `STAGING` or `PRODUCTION`. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Get an include version `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-include-version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | includeVersion | integer | yes | Include's incremental version number. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List available behaviors for an include `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-include-available-behaviors` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | includeVersion | integer | yes | Include's incremental version number. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List available criteria for an include `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-include-available-criteria` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | includeVersion | integer | yes | Include's incremental version number. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Get an include's rule tree `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-include-version-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | includeVersion | integer | yes | Include's incremental version number. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | validateRules | boolean | no | Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's… | | validateMode | string | no | __Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Update an include's rule tree `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/put-include-version-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | includeVersion | integer | yes | Include's incremental version number. | | If-Match | string | yes | This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures you don't overwrite edits… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | validateRules | boolean | no | Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's… | | validateMode | string | no | __Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster… | | dryRun | boolean | no | With the `validateRules` query parameter also enabled, allows for a _dry run_ in order to gather any possible errors without saving the… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Patch an include's rule tree `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/patch-include-version-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | includeId | string | yes | Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | includeVersion | integer | yes | Include's incremental version number. | | If-Match | string | yes | This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures you don't overwrite edits… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | validateRules | boolean | no | Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's… | | validateMode | string | no | __Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster… | | dryRun | boolean | no | With the `validateRules` query parameter also enabled, allows for a _dry run_ in order to gather any possible errors without saving the… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### List products `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-products` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List use cases `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-product-mapping-use-cases` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | productId | string | yes | Unique identifier for the product. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List properties `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-properties` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | modifiedSince | string | no | Filters properties or includes that have been modified in a specified time. Accepts duration in the ISO 8601 format. | | modifiedNetwork | string | no | __Enum__ Filters and only shows properties or includes that have been modified within a specified period on a selected network, either… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | yes | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Create or clone a property `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-properties` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | yes | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### Get a property `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-property` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Remove a property `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/delete-property` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List property's activations `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-property-activations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Activate or deactivate a property `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-property-activations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### Get a property activation `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-property-activation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | activationId | string | yes | Unique identifier for the property or include activation. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Cancel a property's pending activation `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/delete-property-activation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | activationId | string | yes | Unique identifier for the property or include activation. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List property hostname activations `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-property-hostname-activations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | offset | integer | no | For paginated responses, specifies the page of results you want to navigate to, starting from `0`. | | limit | integer | no | For paginated responses, specifies the number of `hostnames` objects to include on each page. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Get a property hostname activation `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-property-hostname-activation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | hostnameActivationId | string | yes | Unique identifier for the hostname activation. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | includeHostnames | boolean | no | Whether the response should include the property hostnames associated with an activation and the related certificate status on staging and… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | yes | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Cancel a pending property hostname activation `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/delete-property-hostname-activations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | hostnameActivationId | string | yes | Unique identifier for the hostname activation. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | yes | Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | groupId | string | yes | Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List hostnames for a property `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-property-hostnames` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | offset | integer | no | For paginated responses, specifies the page of results you want to navigate to, starting from `0`. | | limit | integer | no | For paginated responses, specifies the number of `hostnames` objects to include on each page. | | sort | string | no | __Enum__ Sort the results based on the `cnameFrom` value, either `hostname:a` for ascending or `hostname:d` for descending order. The… | | hostname | string | no | Filter the results by `cnameFrom`. Supports wildcard matches with `*`. | | cnameTo | string | no | Filter the results by edge hostname. Supports wildcard matches with `*`. | | network | string | no | __Enum__ Network of activated hostnames, either `STAGING` or `PRODUCTION`. | | includeCertStatus | boolean | no | __Limited availability__ Whether the response should include the certificate status for the hostname on staging and production networks. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Add or remove hostnames for a property's hostname bucket `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/patch-property-hostnames` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### Get property hostnames diff `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-property-hostnames-diff` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | offset | integer | no | For paginated responses, specifies the page of results you want to navigate to, starting from `0`. | | limit | integer | no | For paginated responses, specifies the number of `hostnames` objects to include on each page. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List property versions `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-property-versions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | offset | integer | no | For paginated responses, specifies the page of results you want to navigate to, starting from `0`. | | limit | integer | no | For paginated responses, specifies the number of `hostnames` objects to include on each page. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Create a new property version `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-property-versions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### Get the latest property version `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-latest-property-version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | activatedOn | string | no | __Enum__ If present, returns the latest version activated on the given network, either `STAGING` or `PRODUCTION`. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Get a property version `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-property-version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyVersion | integer | yes | Property's incremental version number. | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List available behaviors for a property `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-available-behaviors` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyVersion | integer | yes | Property's incremental version number. | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List available criteria for a property `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-available-criteria` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyVersion | integer | yes | Property's incremental version number. | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### List hostnames for a property version `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-property-version-hostnames` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | propertyVersion | integer | yes | Property's incremental version number. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | validateHostnames | boolean | no | When `false`, skips validation tests that would identify potential hostname-related problems within the response object's `errors` and… | | includeCertStatus | boolean | no | __Limited availability__ Whether the response should include the certificate status for the hostname on staging and production networks. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Update hostnames for a property version `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/put-property-version-hostnames` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | propertyVersion | integer | yes | Property's incremental version number. | | If-Match | string | yes | This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures you don't overwrite edits… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | validateHostnames | boolean | no | When `false`, skips validation tests that would identify potential hostname-related problems within the response object's `errors` and… | | includeCertStatus | boolean | no | __Limited availability__ Whether the response should include the certificate status for the hostname on staging and production networks. | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### Add or remove hostnames for a property version `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/patch-property-version-hostnames` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | propertyVersion | integer | yes | Property's incremental version number. | | If-Match | string | yes | This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures you don't overwrite edits… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | validateHostnames | boolean | no | When `false`, skips validation tests that would identify potential hostname-related problems within the response object's `errors` and… | | includeCertStatus | boolean | no | __Limited availability__ Whether the response should include the certificate status for the hostname on staging and production networks. | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### List property's includes `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-property-version-includes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyVersion | integer | yes | Property's incremental version number. | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | offset | integer | no | For paginated responses, specifies the page of results you want to navigate to, starting from `0`. | | limit | integer | no | For paginated responses, specifies the number of `hostnames` objects to include on each page. | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Get a property's rule tree `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-property-version-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | propertyVersion | integer | yes | Property's incremental version number. | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | validateRules | boolean | no | Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's… | | validateMode | string | no | __Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Update a property's rule tree `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/put-property-version-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | propertyVersion | integer | yes | Property's incremental version number. | | If-Match | string | yes | This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures you don't overwrite edits… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | validateRules | boolean | no | Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's… | | validateMode | string | no | __Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster… | | dryRun | boolean | no | With the `validateRules` query parameter also enabled, allows for a _dry run_ in order to gather any possible errors without saving the… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Patch a property's rule tree `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/patch-property-version-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | propertyId | string | yes | Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | propertyVersion | integer | yes | Property's incremental version number. | | If-Match | string | yes | This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures you don't overwrite edits… | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | contractId | string | no | Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it… | | groupId | string | no | Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along… | | validateRules | boolean | no | Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's… | | validateMode | string | no | __Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster… | | dryRun | boolean | no | With the `validateRules` query parameter also enabled, allows for a _dry run_ in order to gather any possible errors without saving the… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ### List rule formats `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-rule-formats` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Get a schema for a rule format `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-schemas-product-rule-format` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | productId | string | yes | Unique identifier for the product. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on… | | ruleFormat | string | yes | Name of the rule format. The rule format can be frozen to a specific version, or represent the `latest` set of behaviors and criteria. | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Get a schema for a request `GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-schemas-request-filename` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | filename | string | yes | Schema's filename. | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | ### Search properties or includes `POST https://zieapi.vercel.app/v1/cloud:akamai-papi/post-search-find-by-value` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | hostname | string | yes | Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net | | PAPI-Use-Prefixes | string | yes | __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to… | | accountSwitchKey | string | no | For customers who manage more than one account, this [runs the operation from another… | | body | object | yes | JSON request body | ## Example ``` curl "https://zieapi.vercel.app/v1/cloud:akamai-papi/get-build" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Akamai Property Manager API API? Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:akamai-papi/get-build with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Akamai Property Manager API API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Akamai Property Manager API itself also needs your own key from akamaiapis.net. ### Can AI agents use the Akamai Property Manager API API? Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:akamai-papi. ### What is the status of the Akamai Property Manager API API? Needs your own provider key (bring your own key)