API summary

See the API's various operations for details on their request parameters and response data.

OperationMethodEndpoint
Prerequisite data
List contractsGET/contracts
Create a new CP codePOST/cpcodes
List CP codesGET/cpcodes
Get a CP codeGET/cpcodes/‚Äč{cpcodeId}
Create a new edge hostnamePOST/edgehostnames
List edge hostnamesGET/edgehostnames
Get an edge hostnameGET/edgehostnames/‚Äč{edgeHostnameId}
List groupsGET/groups
List productsGET/products
List use casesGET/products/‚Äč{productId}/‚Äčmapping-use-cases
Includes
Create or clone an includePOST/includes
List includesGET/includes
Validate an includeGET/includes/‚Äčvalidation-results/‚Äč{activationId}/‚Äčproperties/‚Äč{propertyId}/‚Äčversions/‚Äč{propertyVersion}
Get an includeGET/includes/‚Äč{includeId}
Remove an includeDELETE/includes/‚Äč{includeId}
Activate or deactivate an includePOST/includes/‚Äč{includeId}/‚Äčactivations
List include's activationsGET/includes/‚Äč{includeId}/‚Äčactivations
Get an include activationGET/includes/‚Äč{includeId}/‚Äčactivations/‚Äč{activationId}
Cancel an include's pending activationDELETE/includes/‚Äč{includeId}/‚Äčactivations/‚Äč{activationId}
List parent propertiesGET/includes/‚Äč{includeId}/‚Äčparents
Create a new include versionPOST/includes/‚Äč{includeId}/‚Äčversions
List include versionsGET/includes/‚Äč{includeId}/‚Äčversions
Get the latest include versionGET/includes/‚Äč{includeId}/‚Äčversions/‚Äčlatest
Get an include versionGET/includes/‚Äč{includeId}/‚Äčversions/‚Äč{includeVersion}
List available behaviors for an includeGET/includes/‚Äč{includeId}/‚Äčversions/‚Äč{includeVersion}/‚Äčavailable-behaviors
List available criteria for an includeGET/includes/‚Äč{includeId}/‚Äčversions/‚Äč{includeVersion}/‚Äčavailable-criteria
Get an include's rule treeGET/includes/‚Äč{includeId}/‚Äčversions/‚Äč{includeVersion}/‚Äčrules
Update an include's rule treePUT/includes/‚Äč{includeId}/‚Äčversions/‚Äč{includeVersion}/‚Äčrules
Patch an include's rule treePATCH/includes/‚Äč{includeId}/‚Äčversions/‚Äč{includeVersion}/‚Äčrules
Get a digest for an include's rule treeHEAD/includes/‚Äč{includeId}/‚Äčversions/‚Äč{includeVersion}/‚Äčrules
Property hostnames
List hostnames for an accountGET/hostnames
Generate domain validation challengesPOST/hostnames/‚Äčcertificate-challenges
Get audit historyGET/hostnames/‚Äč{hostname}/‚Äčaudit-history
Properties
Create or clone a propertyPOST/properties
List propertiesGET/properties
Get a propertyGET/properties/‚Äč{propertyId}
Remove a propertyDELETE/properties/‚Äč{propertyId}
Activate or deactivate a propertyPOST/properties/‚Äč{propertyId}/‚Äčactivations
List property's activationsGET/properties/‚Äč{propertyId}/‚Äčactivations
Get a property activationGET/properties/‚Äč{propertyId}/‚Äčactivations/‚Äč{activationId}
Cancel a property's pending activationDELETE/properties/‚Äč{propertyId}/‚Äčactivations/‚Äč{activationId}
List property hostname activationsGET/properties/‚Äč{propertyId}/‚Äčhostname-activations
Get a property hostname activationGET/properties/‚Äč{propertyId}/‚Äčhostname-activations/‚Äč{hostnameActivationId}
Cancel a pending property hostname activationDELETE/properties/‚Äč{propertyId}/‚Äčhostname-activations/‚Äč{hostnameActivationId}
List hostnames for a propertyGET/properties/‚Äč{propertyId}/‚Äčhostnames
Add or remove hostnames for a property's hostname bucketPATCH/properties/‚Äč{propertyId}/‚Äčhostnames
Get property hostnames diffGET/properties/‚Äč{propertyId}/‚Äčhostnames/‚Äčdiff
Create a new property versionPOST/properties/‚Äč{propertyId}/‚Äčversions
List property versionsGET/properties/‚Äč{propertyId}/‚Äčversions
Get the latest property versionGET/properties/‚Äč{propertyId}/‚Äčversions/‚Äčlatest
Get a property versionGET/properties/‚Äč{propertyId}/‚Äčversions/‚Äč{propertyVersion}
List available behaviors for a propertyGET/properties/‚Äč{propertyId}/‚Äčversions/‚Äč{propertyVersion}/‚Äčavailable-behaviors
List available criteria for a propertyGET/properties/‚Äč{propertyId}/‚Äčversions/‚Äč{propertyVersion}/‚Äčavailable-criteria
List hostnames for a property versionGET/properties/‚Äč{propertyId}/‚Äčversions/‚Äč{propertyVersion}/‚Äčhostnames
Update hostnames for a property versionPUT/properties/‚Äč{propertyId}/‚Äčversions/‚Äč{propertyVersion}/‚Äčhostnames
Add or remove hostnames for a property versionPATCH/properties/‚Äč{propertyId}/‚Äčversions/‚Äč{propertyVersion}/‚Äčhostnames
List property's includesGET/properties/‚Äč{propertyId}/‚Äčversions/‚Äč{propertyVersion}/‚Äčincludes
Get a property's rule treeGET/properties/‚Äč{propertyId}/‚Äčversions/‚Äč{propertyVersion}/‚Äčrules
Update a property's rule treePUT/properties/‚Äč{propertyId}/‚Äčversions/‚Äč{propertyVersion}/‚Äčrules
Patch a property's rule treePATCH/properties/‚Äč{propertyId}/‚Äčversions/‚Äč{propertyVersion}/‚Äčrules
Get a digest for a property's rule treeHEAD/properties/‚Äč{propertyId}/‚Äčversions/‚Äč{propertyVersion}/‚Äčrules
Custom behaviors and overrides
List custom behaviorsGET/custom-behaviors
Get a custom behaviorGET/custom-behaviors/‚Äč{behaviorId}
List custom overridesGET/custom-overrides
Get a custom overrideGET/custom-overrides/‚Äč{overrideId}
Bulk search and update
Bulk activate a set of propertiesPOST/bulk/‚Äčactivations
List bulk-activated propertiesGET/bulk/‚Äčactivations/‚Äč{bulkActivationId}
Bulk version a set of propertiesPOST/bulk/‚Äčproperty-version-creations
List bulk-versioned propertiesGET/bulk/‚Äčproperty-version-creations/‚Äč{bulkCreateId}
Bulk patch a set of propertiesPOST/bulk/‚Äčrules-patch-requests
List bulk-patched propertiesGET/bulk/‚Äčrules-patch-requests/‚Äč{bulkPatchId}
Bulk search a set of properties or includesPOST/bulk/‚Äčrules-search-requests
Synchronously bulk search a set of properties or includesPOST/bulk/‚Äčrules-search-requests-synch
List bulk search resultsGET/bulk/‚Äčrules-search-requests/‚Äč{bulkSearchId}
Search
Search properties or includesPOST/search/‚Äčfind-by-value
Rule formats, schemas, and utilities
Get build detailsGET/build
Get client settingsGET/client-settings
Update client settingsPUT/client-settings
List rule formatsGET/rule-formats
Get a schema for a rule formatGET/schemas/‚Äčproducts/‚Äč{productId}/‚Äč{ruleFormat}
Get a schema for a requestGET/schemas/‚Äčrequest/‚Äč{filename}