JUMP TOAPIProperty Manager APIAPI summaryOpenAPI schemaGet startedPAPI workflowsOnboard a property with a CPS-managed certificateOnboard a property with a Default DV certificateClone a propertyModify current property settingsManage hostnamesActivate a propertyAdd hostnames to the hostname bucketSplit your configuration into microservicesShare common settings across propertiesPAPI conventionsAPI versioningData conventionsID prefixesRate and resource limitingConcurrency controlTroubleshootingKnown issuesRestart a Default DV certificate validationDebug variablesRule tree errors and warningsValidation errorsActivation error handlingErrors400401403404405406409412415422429500501Rule 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 behaviorsadScalerCircuitBreakeradaptiveImageCompressionadvancedaggregatedReportingakamaizerakamaizerTagallHttpInCacheHierarchyallowCloudletsOriginsallowDeleteallowHTTPSCacheKeySharingallowHTTPSDowngradeallowOptionsallowPatchallowPostallowPutallowTransferEncodingaltSvcHeaderapiPrioritizationapplicationLoadBalanceraudienceSegmentationautoDomainValidationbaseDirectorybossBeaconingbreadcrumbsbreakConnectionbrotlicacheErrorcacheIdcacheKeyIgnoreCasecacheKeyQueryParamscacheKeyRewritecachePostcacheRedirectcacheTagcacheTagVisiblecachingcentralAuthorizationchaseRedirectsclientCertificateAuthclientCharacteristicscloudInterconnectscloudWrappercloudWrapperAdvancedcommonMediaClientDataconstructResponsecontentCharacteristicscontentCharacteristicsAMDcontentCharacteristicsDDcontentCharacteristicsWsdLargeFilecontentCharacteristicsWsdLivecontentCharacteristicsWsdVodcontentTargetingProtectioncorsSupportcpCodecustomBehaviordatastreamdcpdcpAuthHMACTransformationdcpAuthRegexTransformationdcpAuthSubstringTransformationdcpAuthVariableExtractordcpDefaultAuthzGroupsdcpDevRelationsdeliveryReceiptdenyAccessdenyDirectFailoverAccessdeviceCharacteristicCacheIddeviceCharacteristicHeaderdnsAsyncRefreshdnsPrefreshdowngradeProtocoldownloadCompleteMarkerdownloadNotificationdownstreamCachedynamicThroughtputOptimizationdynamicThroughtputOptimizationOverridedynamicWebContentearlyDataearlyHintsecmsBulkUploadecmsDatabaseecmsDatasetecmsObjectKeyedgeConnectedgeLoadBalancingAdvancededgeLoadBalancingDataCenteredgeLoadBalancingOriginedgeOriginAuthorizationedgeRedirectoredgeScapeedgeSideIncludesedgeWorkerenforceMtlsSettingsenhancedAkamaiProtocolenhancedDebugenhancedProxyDetectionepdForwardHeaderEnrichmentfailActionfailoverBotManagerFeatureCompatibilityfastInvalidatefipsfirstPartyMarketingfirstPartyMarketingPlusforwardRewriteg2oheaderglobalRequestNumbergraphqlCachinggzipResponsehdDataAdvancedhealthDetectionhsafEipBindinghttp2http3httpStrictTransportSecurityhttpToHttpsUpgradeimOverrideimageManagerimageManagerVideoincludeinstantinstantConfiglargeFileOptimizationlargeFileOptimizationAdvancednetworkConditionsHeaderlimitBitRatelogCustommPulsemanifestPersonalizationmanifestReroutingmanualServerPushmediaAccelerationmediaAccelerationQuicOptoutmediaClientmediaFileRetrievalOptimizationmetadataCachingmobileSdkPerformancemodifyIncomingRequestHeadermodifyIncomingResponseHeadermodifyOutgoingRequestHeadermodifyOutgoingResponseHeadermodifyViaHeadermtlsOriginKeystoreoriginCharacteristicsWsdoriginFailureRecoveryMethodoriginFailureRecoveryPolicyoriginIpAclpermissionsPolicypersistentClientConnectionpersistentConnectionpersonallyIdentifiableInformationphasedReleasepreconnectpredictiveContentDeliverypredictivePrefetchingprefetchprefetchableprefreshCachequicBetarandomSeekrapidreadTimeoutrealTimeReportingrealUserMonitoringredirectredirectplusrefererCheckingremoveQueryParametershutrremoveVaryreportrequestClientHintsrequestControlrequestTypeMarkerresourceOptimizerresourceOptimizerExtendedCompatibilityresponseCoderesponseCookierestrictObjectCachingreturnCacheStatusrewriteUrlrumCustomsaasDefinitionssalesForceCommerceCloudClientsalesForceCommerceCloudProvidersalesForceCommerceCloudProviderHostHeadersavePostDcaProcessingscheduleInvalidationscriptManagementsegmentedContentProtectionsegmentedMediaOptimizationsegmentedMediaStreamingPrefetchsetVariablesimulateErrorCodesiteShieldstandardTLSMigrationstandardTLSMigrationOverridestrictHeaderParsingsubCustomersureRoutetcpOptimizationteaLeaftieredDistributiontieredDistributionAdvancedtieredDistributionCustomizationtimeoutuidConfigurationvalidateEntityTagverifyJsonWebTokenverifyJsonWebTokenForDcpverifyTokenAuthorizationvisitorPrioritizationwatermarkingwebApplicationFirewallwebSocketswebdavlatest criteriaadvancedImMatchbucketcacheabilitychinaCdnRegionclientCertificateclientIpclientIpVersioncloudletsOrigincontentDeliveryNetworkcontentTypedebugModedeviceCharacteristicedgeWorkersFailurefileExtensionfilenamehostnamematchAdvancedmatchCpCodematchResponseCodematchVariablemetadataStageoriginTimeoutpathqueryStringParameterrandomrecoveryConfigregularExpressionrequestCookierequestHeaderrequestMethodrequestProtocolrequestTyperesponseHeaderserverLocationtimetokenAuthorizationuserAgentuserLocationuserNetworkvariableErrorv2024-10-21 behaviorsadScalerCircuitBreakeradaptiveImageCompressionadvancedaggregatedReportingakamaizerakamaizerTagallHttpInCacheHierarchyallowCloudletsOriginsallowDeleteallowHTTPSCacheKeySharingallowHTTPSDowngradeallowOptionsallowPatchallowPostallowPutallowTransferEncodingaltSvcHeaderapiPrioritizationapplicationLoadBalanceraudienceSegmentationautoDomainValidationbaseDirectorybossBeaconingbreadcrumbsbreakConnectionbrotlicacheErrorcacheIdcacheKeyIgnoreCasecacheKeyQueryParamscacheKeyRewritecachePostcacheRedirectcacheTagcacheTagVisiblecachingcentralAuthorizationchaseRedirectsclientCertificateAuthclientCharacteristicscloudInterconnectscloudWrappercloudWrapperAdvancedcommonMediaClientDataconstructResponsecontentCharacteristicscontentCharacteristicsAMDcontentCharacteristicsDDcontentCharacteristicsWsdLargeFilecontentCharacteristicsWsdLivecontentCharacteristicsWsdVodcontentTargetingProtectioncorsSupportcpCodecustomBehaviordatastreamdcpdcpAuthHMACTransformationdcpAuthRegexTransformationdcpAuthSubstringTransformationdcpAuthVariableExtractordcpDefaultAuthzGroupsdcpDevRelationsdeliveryReceiptdenyAccessdenyDirectFailoverAccessdeviceCharacteristicCacheIddeviceCharacteristicHeaderdnsAsyncRefreshdnsPrefreshdowngradeProtocoldownloadCompleteMarkerdownloadNotificationdownstreamCachedynamicThroughtputOptimizationdynamicThroughtputOptimizationOverridedynamicWebContentearlyDataearlyHintsecmsBulkUploadecmsDatabaseecmsDatasetecmsObjectKeyedgeConnectedgeLoadBalancingAdvancededgeLoadBalancingDataCenteredgeLoadBalancingOriginedgeOriginAuthorizationedgeRedirectoredgeScapeedgeSideIncludesedgeWorkerenforceMtlsSettingsenhancedAkamaiProtocolenhancedDebugenhancedProxyDetectionepdForwardHeaderEnrichmentfailActioninputValidationfailoverBotManagerFeatureCompatibilityfastInvalidatefipsfirstPartyMarketingfirstPartyMarketingPlusforwardRewriteg2oheaderglobalRequestNumbergraphqlCachinggzipResponsehdDataAdvancedhealthDetectionhsafEipBindinghttp2http3httpStrictTransportSecurityhttpToHttpsUpgradeimOverrideimageManagerimageManagerVideoincludeinstantinstantConfiglargeFileOptimizationlargeFileOptimizationAdvancedlimitBitRatelogCustommPulsemanifestPersonalizationmanifestReroutingmanualServerPushmediaAccelerationmediaAccelerationQuicOptoutmediaClientmediaFileRetrievalOptimizationmediaOriginFailovermetadataCachingmobileSdkPerformancemodifyIncomingRequestHeadermodifyIncomingResponseHeadermodifyOutgoingRequestHeadermodifyOutgoingResponseHeadermodifyViaHeadermtlsOriginKeystoreoriginCharacteristicsoriginCharacteristicsWsdoriginFailureRecoveryMethodoriginFailureRecoveryPolicyoriginIpAclpermissionsPolicypersistentClientConnectionpersistentConnectionpersonallyIdentifiableInformationphasedReleasepreconnectpredictiveContentDeliverypredictivePrefetchingshutrprefetchprefetchableprefreshCachequicBetarandomSeekrapidreadTimeoutrealTimeReportingrealUserMonitoringredirectredirectplusrefererCheckingremoveQueryParameterremoveVaryreportrequestClientHintsrequestControlrequestTypeMarkerresourceOptimizerresourceOptimizerExtendedCompatibilityresponseCoderesponseCookierestrictObjectCachingreturnCacheStatusrewriteUrlrumCustomsaasDefinitionssalesForceCommerceCloudClientsalesForceCommerceCloudProvidersalesForceCommerceCloudProviderHostHeadersavePostDcaProcessingscheduleInvalidationscriptManagementsegmentedContentProtectionsegmentedMediaOptimizationsegmentedMediaStreamingPrefetchsetVariablesimulateErrorCodesiteShieldstandardTLSMigrationstandardTLSMigrationOverridestrictHeaderParsingsubCustomersureRoutetcpOptimizationteaLeaftieredDistributiontieredDistributionAdvancedtieredDistributionCustomizationtimeoutuidConfigurationvalidateEntityTagverifyJsonWebTokenverifyJsonWebTokenForDcpverifyTokenAuthorizationvisitorPrioritizationwatermarkingwebApplicationFirewallwebSocketswebdavv2024-10-21 criteriaadvancedImMatchbucketcacheabilitychinaCdnRegionclientCertificateclientIpclientIpVersioncloudletsOrigincontentDeliveryNetworkcontentTypedebugModedeviceCharacteristicedgeWorkersFailurefileExtensionfilenamehostnamematchAdvancedmatchCpCodematchResponseCodematchVariablemetadataStageoriginTimeoutpathqueryStringParameterrandomrecoveryConfigregularExpressionrequestCookierequestHeaderrequestMethodrequestProtocolrequestTyperesponseHeaderserverLocationtimetokenAuthorizationuserAgentuserLocationuserNetworkvariableErrorv2024-08-13 behaviorsadScalerCircuitBreakeradaptiveAccelerationadaptiveImageCompressionadvancedaggregatedReportingakamaizerakamaizerTagallHttpInCacheHierarchyallowCloudletsOriginsallowDeleteallowHTTPSCacheKeySharingallowHTTPSDowngradeallowOptionsallowPatchallowPostallowPutallowTransferEncodingaltSvcHeaderapiPrioritizationapplicationLoadBalanceraudienceSegmentationautoDomainValidationbaseDirectorybossBeaconingbreadcrumbsbreakConnectionbrotlicacheErrorcacheIdcacheKeyIgnoreCasecacheKeyQueryParamscacheKeyRewritecachePostcacheRedirectcacheTagcacheTagVisiblecachingcentralAuthorizationchaseRedirectsclientCertificateAuthclientCharacteristicscloudInterconnectscloudWrappercloudWrapperAdvancedcommonMediaClientDataconstructResponsecontentCharacteristicscontentCharacteristicsAMDcontentCharacteristicsDDcontentCharacteristicsWsdLargeFilecontentCharacteristicsWsdLivecontentCharacteristicsWsdVodcontentTargetingProtectioncorsSupportcpCodecustomBehaviordatastreamdcpdcpAuthHMACTransformationdcpAuthRegexTransformationdcpAuthSubstringTransformationdcpAuthVariableExtractordcpDefaultAuthzGroupsdcpDevRelationsdeliveryReceiptdenyAccessdenyDirectFailoverAccessdeviceCharacteristicCacheIddeviceCharacteristicHeaderdnsAsyncRefreshdnsPrefreshdowngradeProtocoldownloadCompleteMarkerdownloadNotificationdownstreamCachedynamicThroughtputOptimizationdynamicThroughtputOptimizationOverridedynamicWebContentearlyHintsecmsBulkUploadecmsDatabaseecmsDatasetecmsObjectKeyedgeConnectedgeLoadBalancingAdvancededgeLoadBalancingDataCenteredgeLoadBalancingOriginedgeOriginAuthorizationedgeRedirectoredgeScapeedgeSideIncludesedgeWorkerenforceMtlsSettingsenhancedAkamaiProtocolenhancedProxyDetectionepdForwardHeaderEnrichmentfailActionfailoverBotManagerFeatureCompatibilityfastInvalidatefipsfirstPartyMarketinginputValidationfirstPartyMarketingPlusforwardRewriteg2oheaderglobalRequestNumbergraphqlCachinggzipResponsehdDataAdvancedhealthDetectionhsafEipBindinghttp2http3httpStrictTransportSecurityhttpToHttpsUpgradeimOverrideimageManagerimageManagerVideoincludeinstantinstantConfiglargeFileOptimizationlargeFileOptimizationAdvancedlimitBitRatelogCustommPulsemanifestPersonalizationmanifestReroutingmanualServerPushmediaAccelerationmediaAccelerationQuicOptoutmediaClientmediaFileRetrievalOptimizationmediaOriginFailovermetadataCachingmobileSdkPerformancemodifyIncomingRequestHeadermodifyIncomingResponseHeadermodifyOutgoingRequestHeadermodifyOutgoingResponseHeadermodifyViaHeadermtlsOriginKeystoreoriginoriginCharacteristicsoriginCharacteristicsWsdoriginFailureRecoveryMethodoriginFailureRecoveryPolicyoriginIpAclpermissionsPolicypersistentClientConnectionpersistentConnectionpersonallyIdentifiableInformationphasedReleasepreconnectpredictiveContentDeliverypredictivePrefetchingprefetchprefetchableprefreshCachequicBetarandomSeekrapidreadTimeoutrealTimeReportingrealUserMonitoringredirectredirectplusrefererCheckingshutrremoveQueryParameterremoveVaryreportrequestClientHintsrequestControlrequestTypeMarkerresourceOptimizerresourceOptimizerExtendedCompatibilityresponseCoderesponseCookierestrictObjectCachingreturnCacheStatusrewriteUrlrumCustomsaasDefinitionssalesForceCommerceCloudClientsalesForceCommerceCloudProvidersalesForceCommerceCloudProviderHostHeadersavePostDcaProcessingscheduleInvalidationscriptManagementsegmentedContentProtectionsegmentedMediaOptimizationsegmentedMediaStreamingPrefetchsetVariablesimulateErrorCodesiteShieldstandardTLSMigrationstandardTLSMigrationOverridestrictHeaderParsingsubCustomersureRoutetcpOptimizationteaLeaftieredDistributiontieredDistributionAdvancedtieredDistributionCustomizationtimeoutuidConfigurationvalidateEntityTagverifyJsonWebTokenverifyJsonWebTokenForDcpverifyTokenAuthorizationvisitorPrioritizationwatermarkingwebApplicationFirewallwebSocketswebdavv2024-08-13 criteriaadvancedImMatchbucketcacheabilitychinaCdnRegionclientCertificateclientIpclientIpVersioncloudletsOrigincontentDeliveryNetworkcontentTypedeviceCharacteristicedgeWorkersFailurefileExtensionfilenamehostnamematchAdvancedmatchCpCodematchResponseCodematchVariablemetadataStageoriginTimeoutpathqueryStringParameterrandomrecoveryConfigregularExpressionrequestCookierequestHeaderrequestMethodrequestProtocolrequestTyperesponseHeaderserverLocationtimetokenAuthorizationuserAgentuserLocationuserNetworkvariableErrorDeprecated rule formatsPrerequisite dataGroupsList groupsgetEdge hostnamesCreate a new edge hostnamepostList edge hostnamesgetGet an edge hostnamegetProductsList productsgetList use casesgetContractsList contractsgetCP codesCreate a new CP codepostList CP codesgetGet a CP codegetIncludesIncludesCreate 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 hostnamesProperty hostnamesList hostnames for an accountgetGenerate domain validation challengespostGet audit historygetPropertiesPropertiesCreate or clone a propertypostList propertiesgetGet a propertygetRemove a propertydeleteProperty activationsActivate 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 propertygetProperty version hostnamesList hostnames for a property versiongetUpdate hostnames for a property versionputAdd or remove hostnames for a property versionpatchProperty version includesList property's includesgetProperty version rulesGet a property's rule treegetUpdate a property's rule treeputPatch a property's rule treepatchGet a digest for a property's rule treeheadCustom behaviors and overridesCustom behaviorsList custom behaviorsgetGet a custom behaviorgetCustom overridesList custom overridesgetGet a custom overridegetBulk 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 resultsgetSearchSearchSearch properties or includespostRule formats, schemas, and utilitiesBuildGet build detailsgetClient settingsGet client settingsgetUpdate client settingsputRule formatsList rule formatsgetSchemasGet a schema for a rule formatgetGet a schema for a requestget401API authentication failure. See Get started for guidance on how to correctly set up your API hostname token.
