JUMP TOAPIProperty Manager APIAPI summaryGet startedPAPI conventionsAPI versioningData conventionsID prefixesRate and resource limitingConcurrency controlRule tree errors and warningsFast validation, activation, and fallbackPAPI workflowsOnboard a custom cert propertyOnboard a secure by default propertyClone a propertyModify current property settingsManage hostnamesAdd hostnames to the hostname bucketSplit your configuration into microservicesShare common settings across propertiesErrors400401403404405406409412415422429500501Validation errorsDebug variablesKnown issuesBest practices interacting with PAPIRule configurationsRule treesThe default ruleBehaviorsCriteriaIncludesAdvanced and locked featuresCustom behaviors and overridesRule format schemasUse cases and best practicesVariablesInsert a variableBuilt-in system variablesDeclare a variableAssign a variableModify a variableVariables within includesBulk Search and UpdateSample workflowSample bulk updatesBulk searchesBulk versioningBulk patchesBulk activationsContextual searchesPossible mismatchesReplace arrays or objectsRemove array elementsAdd or remove behaviors and rulesMake conditional changeslatest criteriaadvancedImMatchbucketcacheabilitychinaCdnRegionclientCertificateclientIpclientIpVersioncloudletsOrigincontentDeliveryNetworkcontentTypedeviceCharacteristicedgeWorkersFailurefileExtensionfilenamehostnamematchAdvancedmatchCpCodematchResponseCodematchVariablemetadataStageoriginTimeoutpathqueryStringParameterrandomrecoveryConfigregularExpressionrequestCookierequestHeaderrequestMethodrequestProtocolrequestTyperesponseHeadertimetokenAuthorizationuserAgentuserLocationuserNetworkvariableErrorlatest behaviorsadScalerCircuitBreakeradaptiveAccelerationadaptiveImageCompressionadvancedaggregatedReportingakamaizerakamaizerTagallHttpInCacheHierarchyallowCloudletsOriginsallowDeleteallowHTTPSCacheKeySharingallowHTTPSDowngradeallowOptionsallowPatchallowPostallowPutallowTransferEncodingaltSvcHeaderapiPrioritizationapplicationLoadBalanceraudienceSegmentationautoDomainValidationbaseDirectorybossBeaconingbreadcrumbsbreakConnectionbrotlicacheErrorcacheIdcacheKeyIgnoreCasecacheKeyQueryParamscacheKeyRewritecachePostcacheRedirectcacheTagcacheTagVisiblecachingcentralAuthorizationchaseRedirectsclientCharacteristicscloudInterconnectscloudWrappercloudWrapperAdvancedconstructResponsecontentCharacteristicscontentCharacteristicsAMDcontentCharacteristicsDDcontentCharacteristicsWsdLargeFilecontentCharacteristicsWsdLivecontentCharacteristicsWsdVodcontentTargetingProtectioncorsSupportcpCodecustomBehaviordatastreamdcpdcpAuthHMACTransformationdcpAuthRegexTransformationdcpAuthSubstringTransformationdcpAuthVariableExtractordcpDefaultAuthzGroupsdcpDevRelationsdeliveryReceiptdenyAccessdenyDirectFailoverAccessdeviceCharacteristicCacheIddeviceCharacteristicHeaderdnsAsyncRefreshdnsPrefreshdowngradeProtocoldownloadCompleteMarkerdownloadNotificationdownstreamCachedynamicThroughtputOptimizationdynamicWebContentecmsBulkUploadecmsDatabaseecmsDatasetecmsObjectKeyedgeConnectedgeLoadBalancingAdvancededgeLoadBalancingDataCenteredgeLoadBalancingOriginedgeOriginAuthorizationedgeRedirectoredgeScapeedgeSideIncludesedgeWorkerenhancedAkamaiProtocolenhancedProxyDetectionepdForwardHeaderEnrichmentfailActionfailoverBotManagerFeatureCompatibilityfastInvalidatefirstPartyMarketingfirstPartyMarketingPlusforwardRewritefrontEndOptimizationg2oheaderglobalRequestNumbergraphqlCachinggzipResponsenetworkConditionsHeaderhdDataAdvancedhealthDetectionhttp2http3httpStrictTransportSecurityhttpToHttpsUpgradeimOverrideimageManagerimageManagerVideoincludeinputValidationinstantinstantConfiglargeFileOptimizationlargeFileOptimizationAdvancedlimitBitRatelogCustommPulsemanifestPersonalizationmanifestReroutingmanualServerPushmediaAccelerationmediaAccelerationQuicOptoutmediaClientmediaFileRetrievalOptimizationmediaOriginFailovermetadataCachingmobileSdkPerformancemodifyIncomingRequestHeadermodifyIncomingResponseHeadermodifyOutgoingRequestHeadermodifyOutgoingResponseHeadermodifyViaHeaderoriginoriginCharacteristicsoriginCharacteristicsWsdoriginFailureRecoveryMethodoriginFailureRecoveryPolicyoriginIpAclpersistentClientConnectionpersistentConnectionpersonallyIdentifiableInformationphasedReleasepreconnectpredictiveContentDeliverypredictivePrefetchingprefetchprefetchableprefreshCachequicBetarandomSeekrapidreadTimeoutrealUserMonitoringredirectredirectplusrefererCheckingremoveQueryParameterremoveVaryreportrequestControlrequestTypeMarkerresourceOptimizerresourceOptimizerExtendedCompatibilityresponseCoderesponseCookierestrictObjectCachingreturnCacheStatusrewriteUrlrumCustomsaasDefinitionssalesForceCommerceCloudClientsalesForceCommerceCloudProvidersalesForceCommerceCloudProviderHostHeadersavePostDcaProcessingscheduleInvalidationscriptManagementsegmentedContentProtectionsegmentedMediaOptimizationsegmentedMediaStreamingPrefetchshutrsimulateErrorCodesiteShieldstandardTLSMigrationstandardTLSMigrationOverridestrictHeaderParsingsubCustomersureRoutetcpOptimizationteaLeaftieredDistributiontieredDistributionAdvancedtieredDistributionCustomizationtimeoutuidConfigurationvalidateEntityTagverifyJsonWebTokenverifyJsonWebTokenForDcpverifyTokenAuthorizationvisitorPrioritizationwatermarkingwebApplicationFirewallwebSocketswebdavv2023-01-05 behaviorsadScalerCircuitBreakeradaptiveAccelerationadaptiveImageCompressionadvancedaggregatedReportingakamaizerakamaizerTagallHttpInCacheHierarchyallowCloudletsOriginsallowDeleteallowHTTPSCacheKeySharingallowHTTPSDowngradeallowOptionsallowPatchallowPostallowPutallowTransferEncodingaltSvcHeaderapiPrioritizationapplicationLoadBalanceraudienceSegmentationautoDomainValidationbaseDirectorybossBeaconingbreadcrumbsbreakConnectionbrotlicacheErrorcacheIdcacheKeyIgnoreCasecacheKeyQueryParamscacheKeyRewritecachePostcacheRedirectcacheTagcacheTagVisiblecachingcentralAuthorizationchaseRedirectsclientCharacteristicscloudInterconnectscloudWrappercloudWrapperAdvancedconstructResponsecontentCharacteristicscontentCharacteristicsAMDcontentCharacteristicsDDcontentCharacteristicsWsdLargeFilecontentCharacteristicsWsdLivecontentCharacteristicsWsdVodcontentTargetingProtectioncorsSupportcpCodecustomBehaviordatastreamdcpdcpAuthHMACTransformationdcpAuthRegexTransformationdcpAuthSubstringTransformationdcpAuthVariableExtractordcpDefaultAuthzGroupsdcpDevRelationsdeliveryReceiptdenyAccessdenyDirectFailoverAccessdeviceCharacteristicCacheIddeviceCharacteristicHeaderdnsAsyncRefreshdnsPrefreshdowngradeProtocoldownloadCompleteMarkerdownloadNotificationdownstreamCachedynamicThroughtputOptimizationdynamicWebContentecmsBulkUploadecmsDatabaseecmsDatasetecmsObjectKeyedgeConnectedgeLoadBalancingAdvancededgeLoadBalancingDataCenteredgeLoadBalancingOriginedgeOriginAuthorizationedgeRedirectoredgeScapeedgeSideIncludesedgeWorkerenhancedAkamaiProtocolenhancedProxyDetectionepdForwardHeaderEnrichmentfailActionfailoverBotManagerFeatureCompatibilityfastInvalidatefirstPartyMarketingfirstPartyMarketingPlusforwardRewritefrontEndOptimizationg2oheaderglobalRequestNumbergraphqlCachinggzipResponsehdDataAdvancedhealthDetectionhttp2http3httpStrictTransportSecurityhttpToHttpsUpgradeimOverrideimageManagerimageManagerVideoincludeinputValidationinstantinstantConfiglargeFileOptimizationlargeFileOptimizationAdvancedlimitBitRatelogCustommPulsemanifestPersonalizationmanifestReroutingmanualServerPushmediaAccelerationmediaAccelerationQuicOptoutmediaClientmediaFileRetrievalOptimizationmediaOriginFailovermetadataCachingmobileSdkPerformancemodifyIncomingRequestHeadermodifyIncomingResponseHeadermodifyOutgoingRequestHeadermodifyOutgoingResponseHeadermodifyViaHeaderoriginoriginCharacteristicsoriginCharacteristicsWsdoriginFailureRecoveryMethodoriginFailureRecoveryPolicyoriginIpAclpersistentClientConnectionpersistentConnectionpersonallyIdentifiableInformationphasedReleasepreconnectpredictiveContentDeliverypredictivePrefetchingprefetchprefetchableprefreshCachequicBetarandomSeekrapidreadTimeoutrealUserMonitoringredirectredirectplusrefererCheckingremoveQueryParameterremoveVaryreportrequestControlrequestTypeMarkerresourceOptimizerresourceOptimizerExtendedCompatibilityresponseCoderesponseCookierestrictObjectCachingreturnCacheStatusrewriteUrlrumCustomsaasDefinitionssalesForceCommerceCloudClientsalesForceCommerceCloudProvidersalesForceCommerceCloudProviderHostHeadersavePostDcaProcessingscheduleInvalidationscriptManagementsegmentedContentProtectionsegmentedMediaOptimizationsegmentedMediaStreamingPrefetchsetVariableshutrsimulateErrorCodesiteShieldstandardTLSMigrationstandardTLSMigrationOverridestrictHeaderParsingsubCustomersureRoutetcpOptimizationteaLeaftieredDistributiontieredDistributionAdvancedtieredDistributionCustomizationtimeoutuidConfigurationvalidateEntityTagverifyJsonWebTokenverifyJsonWebTokenForDcpverifyTokenAuthorizationvisitorPrioritizationwatermarkingwebApplicationFirewallwebSocketswebdavv2023-01-05 criteriaadvancedImMatchbucketcacheabilitychinaCdnRegionclientCertificateclientIpclientIpVersioncloudletsOrigincontentDeliveryNetworkcontentTypedeviceCharacteristicedgeWorkersFailurefileExtensionfilenamehostnamematchAdvancedmatchCpCodematchResponseCodematchVariablemetadataStageoriginTimeoutpathqueryStringParameterrandomrecoveryConfigregularExpressionrequestCookierequestHeaderrequestMethodrequestProtocolrequestTyperesponseHeadertimetokenAuthorizationuserAgentuserLocationuserNetworkvariableErrorv2022-10-18 behaviorsadScalerCircuitBreakeradaptiveAccelerationadaptiveImageCompressionadvancedaggregatedReportingakamaizerakamaizerTagallHttpInCacheHierarchyallowCloudletsOriginsallowDeleteallowHTTPSCacheKeySharingallowHTTPSDowngradeallowOptionsallowPatchallowPostallowPutallowTransferEncodingaltSvcHeaderapiPrioritizationapplicationLoadBalanceraudienceSegmentationautoDomainValidationbaseDirectorybossBeaconingbreadcrumbsbreakConnectionbrotlicacheErrorcacheIdcacheKeyIgnoreCasecacheKeyQueryParamscacheKeyRewritecachePostcacheRedirectcacheTagcacheTagVisiblecachingcentralAuthorizationchaseRedirectsclientCharacteristicscloudInterconnectscloudWrappercloudWrapperAdvancedconstructResponsecontentCharacteristicscontentCharacteristicsAMDcontentCharacteristicsDDcontentCharacteristicsWsdLargeFilecontentCharacteristicsWsdLivecontentCharacteristicsWsdVodcontentTargetingProtectioncorsSupportcpCodecustomBehaviordatastreamdcpdcpAuthHMACTransformationdcpAuthRegexTransformationdcpAuthSubstringTransformationdcpAuthVariableExtractordcpDefaultAuthzGroupsdcpDevRelationsdeliveryReceiptdenyAccessdenyDirectFailoverAccessdeviceCharacteristicCacheIddeviceCharacteristicHeaderdnsAsyncRefreshdnsPrefreshdowngradeProtocoldownloadCompleteMarkerdownloadNotificationdownstreamCachedynamicThroughtputOptimizationdynamicWebContentecmsBulkUploadecmsDatabaseecmsDatasetecmsObjectKeyedgeConnectedgeLoadBalancingAdvancededgeLoadBalancingDataCenteredgeLoadBalancingOriginedgeOriginAuthorizationedgeRedirectoredgeScapeedgeSideIncludesedgeWorkerenhancedAkamaiProtocolenhancedProxyDetectionepdForwardHeaderEnrichmentfailActionfailoverBotManagerFeatureCompatibilityfastInvalidatefirstPartyMarketingfirstPartyMarketingPlusforwardRewritefrontEndOptimizationg2oheaderglobalRequestNumbergraphqlCachinggzipResponsehdDataAdvancedhealthDetectionhttp2http3httpStrictTransportSecurityhttpToHttpsUpgradeimOverrideimageManagerimageManagerVideoincludeinputValidationinstantinstantConfiglargeFileOptimizationlargeFileOptimizationAdvancedlimitBitRatelogCustommPulsemanifestPersonalizationmanifestReroutingmanualServerPushmediaAccelerationmediaAccelerationQuicOptoutmediaClientmediaFileRetrievalOptimizationmediaOriginFailovermetadataCachingmobileSdkPerformancemodifyIncomingRequestHeadermodifyIncomingResponseHeadermodifyOutgoingRequestHeadermodifyOutgoingResponseHeadermodifyViaHeaderoriginoriginCharacteristicsoriginCharacteristicsWsdoriginFailureRecoveryMethodoriginFailureRecoveryPolicyoriginIpAclpersistentClientConnectionpersistentConnectionpersonallyIdentifiableInformationphasedReleasepreconnectpredictiveContentDeliverypredictivePrefetchingprefetchprefetchableprefreshCachequicBetarandomSeekrapidreadTimeoutrealUserMonitoringredirectredirectplusrefererCheckingremoveQueryParameterremoveVaryreportrequestControlrequestTypeMarkerresourceOptimizerresourceOptimizerExtendedCompatibilityresponseCoderesponseCookierestrictObjectCachingreturnCacheStatusrewriteUrlrumCustomsaasDefinitionssalesForceCommerceCloudClientsalesForceCommerceCloudProvidersalesForceCommerceCloudProviderHostHeadersavePostDcaProcessingscheduleInvalidationscriptManagementsegmentedContentProtectionsegmentedMediaOptimizationsegmentedMediaStreamingPrefetchsetVariableshutrsimulateErrorCodesiteShieldstandardTLSMigrationstandardTLSMigrationOverridestrictHeaderParsingsubCustomersureRoutetcpOptimizationteaLeaftieredDistributiontieredDistributionAdvancedtieredDistributionCustomizationtimeoutuidConfigurationvalidateEntityTagverifyJsonWebTokenverifyJsonWebTokenForDcpverifyTokenAuthorizationvisitorPrioritizationwatermarkingwebApplicationFirewallwebSocketswebdavv2022-10-18 criteriaadvancedImMatchbucketcacheabilitychinaCdnRegionclientCertificateclientIpclientIpVersioncloudletsOrigincontentDeliveryNetworkcontentTypedeviceCharacteristicedgeWorkersFailurefileExtensionfilenamehostnamematchAdvancedmatchCpCodematchResponseCodematchVariablemetadataStageoriginTimeoutpathqueryStringParameterrandomrecoveryConfigregularExpressionrequestCookierequestHeaderrequestMethodrequestProtocolrequestTyperesponseHeadertimetokenAuthorizationuserAgentuserLocationuserNetworkvariableErrorDeprecated rule formatsPrerequisite dataContractsList contractsgetCP codesList CP codesgetCreate a new CP codepostGet a CP codegetEdge hostnamesList edge hostnamesgetCreate a new edge hostnamepostGet an edge hostnamegetGroupsList groupsgetProductsList productsgetList use casesgetIncludesIncludesCreate or clone an includepostList includesgetValidate an includegetGet an includegetRemove an includedeleteList parent propertiesgetInclude activationsActivate or deactivate an includepostList include's activationsgetGet an include activationgetCancel an include's pending activationdeleteInclude versionsCreate a new include versionpostList include versionsgetGet the latest include versiongetGet an include versiongetList available behaviors for an includegetList available criteria for an includegetInclude version rulesGet an include's rule treegetUpdate an include's rule treeputPatch an include's rule treepatchGet a digest for an include's rule treeheadProperty hostnamesGeneral operations on hostnamesList hostnames for an accountgetGenerate domain validation challengespostGet audit historygetPropertiesPropertiesCreate or clone a propertypostList propertiesgetGet a propertygetRemove a propertydeleteActivationsActivate or deactivate a propertypostList property's activationsgetGet a property activationgetCancel a property's pending activationdeleteHostname bucketsList property hostname activationsgetGet a property hostname activationgetCancel a pending property hostname activationdeleteAdd or remove hostnames for a property's hostname bucketpatchActive property hostnamesList hostnames for a propertygetGet property hostnames diffgetProperty versionsCreate a new property versionpostList property versionsgetGet the latest property versiongetGet a property versiongetList available behaviors for a propertygetList available criteria for a propertygetList hostnames for a property versiongetUpdate hostnames for a property versionputAdd or remove hostnames for a property versionpatchList property's includesgetRulesGet a property's rule treegetUpdate a property's rule treeputPatch a property's rule treepatchGet a digest for a property's rule treeheadCustom behaviorsCustom behaviorsList custom behaviorsgetGet a custom behaviorgetCustom overridesList custom overridesgetGet a custom overridegetSearchSearchSearch properties or includespostBulk search and updateBulk activationsBulk activate a set of propertiespostList bulk-activated propertiesgetBulk versioningBulk version a set of propertiespostList bulk-versioned propertiesgetBulk patchBulk patch a set of propertiespostList bulk-patched propertiesgetBulk searchBulk search a set of properties or includespostSynchronously bulk search a set of properties or includespostList bulk search resultsgetRule formatsRule formatsList rule formatsgetClient settingsGet client settingsgetUpdate client settingsputSchemasGet a schema for a rule formatgetGet a schema for a requestgetBuildGet build detailsgetGet a CP codeget https://{hostname}/papi/v1/cpcodes/{cpcodeId}This operation gets details about a CP code.
