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 property hostnamesErrors400401403404405406409412415422429500501Validation errorsDebug variablesKnown issuesBest practices interacting with PAPIRule configurationsRule treesThe default ruleBehaviorsCriteriaAdvanced and locked featuresCustom behaviors and overridesManage property rulesRule format schemasUse cases and best practicesVariablesInsert a variableBuilt-in system variablesDeclare a variableAssign a variableModify a variableBulk 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 behaviorsadScalerCircuitBreakeradaptiveAccelerationadaptiveImageCompressionadvancedaggregatedReportingakamaizerakamaizerTagallHttpInCacheHierarchyallowCloudletsOriginsallowDeleteallowHTTPSCacheKeySharingallowHTTPSDowngradeallowOptionsallowPatchallowPostallowPutallowTransferEncodingapiPrioritizationapplicationLoadBalanceraudienceSegmentationautoDomainValidationbaseDirectorybossBeaconingbreadcrumbsbreakConnectionbrotlicacheErrorcacheIdcacheKeyIgnoreCasecacheKeyQueryParamscacheKeyRewritecachePostcacheRedirectcacheTagcacheTagVisiblecachingcentralAuthorizationchaseRedirectsclientCharacteristicscloudInterconnectscloudWrappercloudWrapperAdvancedconstructResponsecontentCharacteristicscontentCharacteristicsAMDcontentCharacteristicsDDcontentCharacteristicsWsdLargeFilecontentCharacteristicsWsdLivecontentCharacteristicsWsdVodcontentTargetingProtectioncorsSupportcpCodecustomBehaviordatastreamdcpdcpAuthHMACTransformationdcpAuthRegexTransformationdcpAuthSubstringTransformationdcpAuthVariableExtractordcpDefaultAuthzGroupsdcpDevRelationsdeliveryReceiptdenyAccessdenyDirectFailoverAccessdeviceCharacteristicCacheIddeviceCharacteristicHeaderdnsAsyncRefreshdnsPrefreshdowngradeProtocoldownloadCompleteMarkerdownloadNotificationdownstreamCachedynamicThroughtputOptimizationdynamicWebContentecmsBulkUploadecmsDatabaseecmsDatasetecmsObjectKeyedgeConnectedgeImageConversionedgeLoadBalancingAdvancededgeLoadBalancingDataCenteredgeLoadBalancingOriginedgeOriginAuthorizationedgeRedirectoredgeScapeedgeSideIncludesedgeWorkerenhancedAkamaiProtocolenhancedProxyDetectionfailActionfastInvalidateforwardRewritefrontEndOptimizationg2oheaderglobalRequestNumbergraphqlCachinggzipResponsehdDataAdvancedhealthDetectionhttp2httpStrictTransportSecurityhttpToHttpsUpgradeimOverrideimageManagerimageManagerVideoinjectReferenceIdinputValidationinstantinstantConfiglargeFileOptimizationlargeFileOptimizationAdvancedlimitBitRatelogCustommPulsemanifestPersonalizationmanifestReroutingmanualServerPushmediaAccelerationmediaAccelerationQuicOptoutmediaClientmediaFileRetrievalOptimizationmediaOriginFailovermetadataCachingmobileSdkPerformancemodifyIncomingRequestHeadermodifyIncomingResponseHeadermodifyOutgoingRequestHeadermodifyOutgoingResponseHeadermodifyViaHeadernetworkConditionsHeaderoriginoriginCharacteristicsoriginCharacteristicsWsdoriginFailureRecoveryMethodoriginFailureRecoveryPolicyoriginIpAclpersistentClientConnectionpersistentConnectionpersonallyIdentifiableInformationphasedReleasepreconnectpredictiveContentDeliverypredictivePrefetchingprefetchprefetchableprefreshCachequicBetarandomSeekrapidreadTimeoutrealUserMonitoringredirectredirectplusrefererCheckingremoveQueryParameterremoveVaryreportrequestControlrequestTypeMarkerresourceOptimizerresourceOptimizerExtendedCompatibilityresponseCoderesponseCookierestrictObjectCachingreturnCacheStatusrewriteUrlrmaOptimizationrumCustomsaasDefinitionssalesForceCommerceCloudClientsalesForceCommerceCloudProvidersalesForceCommerceCloudProviderHostHeadersavePostDcaProcessingscheduleInvalidationscriptManagementsegmentedContentProtectionsegmentedMediaOptimizationsegmentedMediaStreamingPrefetchsetVariableshutrsimulateErrorCodesiteShieldspdystandardTLSMigrationstandardTLSMigrationOverridesubCustomersureRoutetcpOptimizationteaLeaftieredDistributiontieredDistributionCustomizationtimeoutuidConfigurationvalidateEntityTagverifyJsonWebTokenverifyJsonWebTokenForDcpverifyTokenAuthorizationvisitorPrioritizationwatermarkUrlwatermarkingwebApplicationFirewallwebSocketswebdavv2021-09-22 criteriaadvancedImMatchbucketcacheabilitychinaCdnRegionclientCertificateclientIpclientIpVersioncloudletsOrigincontentDeliveryNetworkcontentTypedeviceCharacteristicedgeWorkersFailurefileExtensionfilenamehostnamematchAdvancedmatchCpCodematchResponseCodematchVariablemetadataStageoriginTimeoutpathqueryStringParameterrandomrecoveryConfigregularExpressionrequestCookierequestHeaderrequestMethodrequestProtocolrequestTyperesponseHeadertimetokenAuthorizationuserAgentuserLocationuserNetworkvariableErrorv2021-09-22 behaviorsadaptiveAccelerationadaptiveImageCompressionadScalerCircuitBreakeradvancedaggregatedReportingakamaizerakamaizerTagallHttpInCacheHierarchyallowCloudletsOriginsallowDeleteallowHTTPSCacheKeySharingallowHTTPSDowngradeallowOptionsallowPatchallowPostallowPutallowTransferEncodingapiPrioritizationapplicationLoadBalanceraudienceSegmentationautoDomainValidationbaseDirectorybossBeaconingbreadcrumbsbreakConnectionbrotlicacheErrorcacheIdcacheKeyIgnoreCasecacheKeyQueryParamscacheKeyRewritecachePostcacheRedirectcacheTagcacheTagVisiblecachingcentralAuthorizationchaseRedirectsclientCharacteristicscloudInterconnectscloudWrappercloudWrapperAdvancedconstructResponsecontentCharacteristicscontentCharacteristicsAMDcontentCharacteristicsDDcontentCharacteristicsWsdLargeFilecontentCharacteristicsWsdLivecontentCharacteristicsWsdVodcontentTargetingProtectioncorsSupportcpCodecustomBehaviordatastreamdcpdcpAuthHMACTransformationdcpAuthRegexTransformationdcpAuthSubstringTransformationdcpAuthVariableExtractordcpDefaultAuthzGroupsdcpDevRelationsdeliveryReceiptdenyAccessdenyDirectFailoverAccessdeviceCharacteristicCacheIddeviceCharacteristicHeaderdnsAsyncRefreshdnsPrefreshdowngradeProtocoldownloadCompleteMarkerdownloadNotificationdownstreamCachedynamicThroughtputOptimizationdynamicWebContentecmsBulkUploadecmsDatabaseecmsDatasetecmsObjectKeyedgeConnectedgeImageConversionedgeLoadBalancingAdvancededgeLoadBalancingDataCenteredgeLoadBalancingOriginedgeOriginAuthorizationedgeRedirectoredgeScapeedgeSideIncludesedgeWorkerenhancedAkamaiProtocolenhancedProxyDetectionfailActionfastInvalidatefirstPartyMarketingfirstPartyMarketingPlusforwardRewritefrontEndOptimizationg2oheaderglobalRequestNumbergraphqlCachinggzipResponsehdDataAdvancedhealthDetectionhttp2httpStrictTransportSecurityhttpToHttpsUpgradeimageManagerimageManagerVideoimOverrideinjectReferenceIdinputValidationinstantinstantConfiglargeFileOptimizationlargeFileOptimizationAdvancedlimitBitRatelogCustommanifestPersonalizationmanifestReroutingmanualServerPushmediaAccelerationmediaAccelerationQuicOptoutmediaClientmediaFileRetrievalOptimizationmediaOriginFailovermetadataCachingmobileSdkPerformancemodifyIncomingRequestHeadermodifyIncomingResponseHeadermodifyOutgoingRequestHeadermodifyOutgoingResponseHeadermodifyViaHeadermPulsenetworkConditionsHeaderoriginoriginCharacteristicsoriginCharacteristicsWsdoriginFailureRecoveryMethodoriginFailureRecoveryPolicyoriginIpAclpersistentClientConnectionpersistentConnectionpersonallyIdentifiableInformationphasedReleasepreconnectpredictiveContentDeliverypredictivePrefetchingprefetchprefetchableprefreshCachequicBetarandomSeekrapidreadTimeoutrealUserMonitoringredirectredirectplusrefererCheckingremoveQueryParameterremoveVaryreportrequestControlrequestTypeMarkerresourceOptimizerresourceOptimizerExtendedCompatibilityresponseCoderesponseCookierestrictObjectCachingreturnCacheStatusrewriteUrlrmaOptimizationrumCustomsaasDefinitionssalesForceCommerceCloudClientsalesForceCommerceCloudProvidersalesForceCommerceCloudProviderHostHeadersavePostDcaProcessingscheduleInvalidationscriptManagementsegmentedContentProtectionsegmentedMediaOptimizationsegmentedMediaStreamingPrefetchsetVariableshutrsimulateErrorCodesiteShieldspdystandardTLSMigrationstandardTLSMigrationOverridesubCustomersureRoutetcpOptimizationteaLeaftieredDistributiontieredDistributionCustomizationtimeoutuidConfigurationvalidateEntityTagverifyJsonWebTokenverifyJsonWebTokenForDcpverifyTokenAuthorizationvisitorPrioritizationwatermarkingwatermarkUrlwebApplicationFirewallwebdavwebSocketsGroupsEdge hostnamesList edge hostnamesgetCreate a new edge hostnamepostGet an edge hostnamegetGroupsList groupsgetContractsList contractsgetProductsList productsgetList use casesgetCP codesList CP codesgetCreate a new CP codepostGet a CP codegetPropertiesPropertiesList propertiesgetCreate or clone a propertypostGet a propertygetRemove a propertydeleteProperty versionsList property versionsgetCreate a new property versionpostGet the latest property versiongetGet a property versiongetList available behaviorsgetList available criteriagetList external resourcesgetHostnamesList hostnames for a propertygetAdd or remove hostnames for a propertypatchUpdate hostnames for a propertyputRulesGet a property rule treegetGet a digest for a rule treeheadPatch a rule treepatchUpdate a rule treeputActivationsList activationsgetCreate a new activation or deactivationpostGet an activationgetCancel a pending activationdeleteCustom behaviorsCustom behaviorsList custom behaviorsgetGet a custom behaviorgetCustom overridesList custom overridesgetGet a custom overridegetSearchSearchSearch propertiespostBulk search and updateBulk searchBulk search a set of propertiespostList bulk search resultsgetSynchronously bulk search a set of propertiespostBulk versioningBulk version a set of propertiespostList bulk-versioned propertiesgetBulk patchBulk patch a set of propertiespostList bulk-patched propertiesgetBulk activationsBulk activate a set of propertiespostList bulk-activated propertiesgetRule formatsClient settingsGet client settingsgetUpdate client settingsputRule formatsList rule formatsgetSchemasGet a schema for a rule formatgetGet a schema for a requestgetBuildGet build detailsgetDeprecated rule formatsv2021-07-30 criteriaadvancedImMatchbucketcacheabilitychinaCdnRegionclientCertificateclientIpclientIpVersioncloudletsOrigincontentDeliveryNetworkcontentTypedeviceCharacteristicedgeWorkersFailurefileExtensionfilenamehostnamematchAdvancedmatchCpCodematchResponseCodematchVariablemetadataStageoriginTimeoutpathqueryStringParameterrandomrecoveryConfigregularExpressionrequestCookierequestHeaderrequestMethodrequestProtocolrequestTyperesponseHeadertimetokenAuthorizationuserAgentuserLocationuserNetworkvariableErrorv2021-07-30 behaviorsadScalerCircuitBreakeradaptiveAccelerationadaptiveImageCompressionadvancedaggregatedReportingakamaizerakamaizerTagallHttpInCacheHierarchyallowCloudletsOriginsallowDeleteallowHTTPSCacheKeySharingallowHTTPSDowngradeallowOptionsallowPatchallowPostallowPutallowTransferEncodingapiPrioritizationapplicationLoadBalanceraudienceSegmentationautoDomainValidationbaseDirectorybossBeaconingbreadcrumbsbreakConnectionbrotlicacheErrorcacheIdcacheKeyIgnoreCasecacheKeyQueryParamscacheKeyRewritecachePostcacheRedirectcacheTagcacheTagVisiblecachingcentralAuthorizationchaseRedirectsclientCharacteristicscloudInterconnectscloudWrappercloudWrapperAdvancedconstructResponsecontentCharacteristicscontentCharacteristicsAMDcontentCharacteristicsDDcontentCharacteristicsWsdLargeFilecontentCharacteristicsWsdLivecontentCharacteristicsWsdVodcontentTargetingProtectioncorsSupportcpCodecustomBehaviordatastreamdcpdcpAuthHMACTransformationdcpAuthRegexTransformationdcpAuthSubstringTransformationdcpAuthVariableExtractordcpDefaultAuthzGroupsdcpDevRelationsdeliveryReceiptdenyAccessdenyDirectFailoverAccessdeviceCharacteristicCacheIddeviceCharacteristicHeaderdnsAsyncRefreshdnsPrefreshdowngradeProtocoldownloadCompleteMarkerdownloadNotificationdownstreamCachedynamicThroughtputOptimizationdynamicWebContentecmsBulkUploadecmsDatabaseecmsDatasetecmsObjectKeyedgeConnectedgeImageConversionedgeLoadBalancingAdvancededgeLoadBalancingDataCenteredgeLoadBalancingOriginedgeOriginAuthorizationedgeRedirectoredgeScapeedgeSideIncludesedgeWorkerenhancedAkamaiProtocolenhancedProxyDetectionfailActionfastInvalidatefirstPartyMarketingfirstPartyMarketingPlusforwardRewritefrontEndOptimizationg2oheaderglobalRequestNumbergraphqlCachinggzipResponsehdDataAdvancedhealthDetectionhttp2httpStrictTransportSecurityhttpToHttpsUpgradeimOverrideimageManagerimageManagerVideoinjectReferenceIdinputValidationinstantinstantConfiglargeFileOptimizationlargeFileOptimizationAdvancedlimitBitRatelogCustommPulsemanifestPersonalizationmanifestReroutingmanualServerPushmediaAccelerationmediaAccelerationQuicOptoutmediaClientmediaFileRetrievalOptimizationmediaOriginFailovermetadataCachingmobileSdkPerformancemodifyIncomingRequestHeadermodifyIncomingResponseHeadermodifyOutgoingRequestHeadermodifyOutgoingResponseHeadermodifyViaHeadernetworkConditionsHeaderoriginoriginCharacteristicsoriginCharacteristicsWsdoriginFailureRecoveryMethodoriginFailureRecoveryPolicyoriginIpAclpersistentClientConnectionpersistentConnectionpersonallyIdentifiableInformationphasedReleasepreconnectpredictiveContentDeliverypredictivePrefetchingprefetchprefetchableprefreshCachequicBetarandomSeekrapidreadTimeoutrealUserMonitoringredirectredirectplusrefererCheckingremoveQueryParameterremoveVaryreportrequestControlrequestTypeMarkerresourceOptimizerresourceOptimizerExtendedCompatibilityresponseCoderesponseCookierestrictObjectCachingreturnCacheStatusrewriteUrlrmaOptimizationrumCustomsaasDefinitionssalesForceCommerceCloudClientsalesForceCommerceCloudProvidersalesForceCommerceCloudProviderHostHeadersavePostDcaProcessingscheduleInvalidationscriptManagementsegmentedContentProtectionsegmentedMediaOptimizationsegmentedMediaStreamingPrefetchsetVariableshutrsimulateErrorCodesiteShieldspdystandardTLSMigrationstandardTLSMigrationOverridesubCustomersureRoutetcpOptimizationteaLeaftieredDistributiontieredDistributionCustomizationtimeoutuidConfigurationvalidateEntityTagverifyJsonWebTokenverifyJsonWebTokenForDcpverifyTokenAuthorizationvisitorPrioritizationwatermarkUrlwatermarkingwebApplicationFirewallwebSocketswebdavv2020-11-02 criteriaadvancedImMatchbucketcacheabilitychinaCdnRegionclientCertificateclientIpclientIpVersioncloudletsOrigincontentDeliveryNetworkcontentTypedeviceCharacteristicedgeWorkersFailurefileExtensionfilenamehostnamematchAdvancedmatchCpCodematchResponseCodematchVariablemetadataStageoriginTimeoutpathqueryStringParameterrandomrecoveryConfigregularExpressionrequestCookierequestHeaderrequestMethodrequestProtocolrequestTyperesponseHeadertimetokenAuthorizationuserAgentuserLocationuserNetworkvariableErrorv2020-11-02 behaviorsadScalerCircuitBreakeradaptiveAccelerationadaptiveImageCompressionadvancedaggregatedReportingakamaizerakamaizerTagallHttpInCacheHierarchyallowCloudletsOriginsallowDeleteallowHTTPSCacheKeySharingallowHTTPSDowngradeallowOptionsallowPatchallowPostallowPutallowTransferEncodingapiPrioritizationapplicationLoadBalanceraudienceSegmentationautoDomainValidationbaseDirectorybossBeaconingbreadcrumbsbreakConnectionbrotlicacheErrorcacheIdcacheKeyIgnoreCasecacheKeyQueryParamscacheKeyRewritecachePostcacheRedirectcacheTagVisiblecachingcentralAuthorizationchaseRedirectsclientCharacteristicscloudInterconnectscloudWrapperconstructResponsecontentCharacteristicscontentCharacteristicsAMDcontentCharacteristicsDDcontentCharacteristicsWsdLargeFilecontentCharacteristicsWsdLivecontentCharacteristicsWsdVodcontentTargetingProtectioncorsSupportcpCodecustomBehaviordatastreamdcpdcpAuthHMACTransformationdcpAuthRegexTransformationdcpAuthSubstringTransformationdcpAuthVariableExtractordcpDefaultAuthzGroupsdcpDevRelations