See the API's various operations for details on their request parameters and response data.
You can also run this API with a Postman collection.
| Operation | Method | Endpoint |
|---|---|---|
| Prerequisite data | ||
| List contracts | GET | /contracts |
| List CP codes | GET | /cpcodes |
| Create a new CP code | POST | /cpcodes |
| Get a CP code | GET | /cpcodes/{cpcodeId} |
| List edge hostnames | GET | /edgehostnames |
| Create a new edge hostname | POST | /edgehostnames |
| Get an edge hostname | GET | /edgehostnames/{edgeHostnameId} |
| List groups | GET | /groups |
| List products | GET | /products |
| List use cases | GET | /products/{productId}/mapping-use-cases |
| Includes | ||
| Limited availability List includes | GET | /includes |
| Limited availability Create or clone an include | POST | /includes |
| Limited availability Validate an include | GET | /includes/validation-results/{activationId}/properties/{propertyId}/versions/{propertyVersion} |
| Limited availability Remove an include | DELETE | /includes/{includeId} |
| Limited availability Get an include | GET | /includes/{includeId} |
| Limited availability List include's activations | GET | /includes/{includeId}/activations |
| Limited availability Activate or deactivate an include | POST | /includes/{includeId}/activations |
| Limited availability Cancel an include's pending activation | DELETE | /includes/{includeId}/activations/{activationId} |
| Limited availability Get an include activation | GET | /includes/{includeId}/activations/{activationId} |
| Limited availability List parent properties | GET | /includes/{includeId}/parents |
| Limited availability List include versions | GET | /includes/{includeId}/versions |
| Limited availability Create a new include version | POST | /includes/{includeId}/versions |
| Limited availability Get the latest include version | GET | /includes/{includeId}/versions/latest |
| Limited availability Get an include version | GET | /includes/{includeId}/versions/{includeVersion} |
| Limited availability List available behaviors for an include | GET | /includes/{includeId}/versions/{includeVersion}/available-behaviors |
| Limited availability List available criteria for an include | GET | /includes/{includeId}/versions/{includeVersion}/available-criteria |
| Limited availability Get an include's rule tree | GET | /includes/{includeId}/versions/{includeVersion}/rules |
| Limited availability Get a digest for an include's rule tree | HEAD | /includes/{includeId}/versions/{includeVersion}/rules |
| Limited availability Patch an include's rule tree | PATCH | /includes/{includeId}/versions/{includeVersion}/rules |
| Limited availability Update an include's rule tree | PUT | /includes/{includeId}/versions/{includeVersion}/rules |
| Property hostnames | ||
| List hostnames for an account | GET | /hostnames |
| Generate domain validation challenges | POST | /hostnames/certificate-challenges |
| Get audit history | GET | /hostnames/{hostname}/audit-history |
| Properties | ||
| List properties | GET | /properties |
| Create or clone a property | POST | /properties |
| Remove a property | DELETE | /properties/{propertyId} |
| Get a property | GET | /properties/{propertyId} |
| List property's activations | GET | /properties/{propertyId}/activations |
| Activate or deactivate a property | POST | /properties/{propertyId}/activations |
| Cancel a property's pending activation | DELETE | /properties/{propertyId}/activations/{activationId} |
| Get a property activation | GET | /properties/{propertyId}/activations/{activationId} |
| List property hostname activations | GET | /properties/{propertyId}/hostname-activations |
| Cancel a pending property hostname activation | DELETE | /properties/{propertyId}/hostname-activations/{hostnameActivationId} |
| Get a property hostname activation | GET | /properties/{propertyId}/hostname-activations/{hostnameActivationId} |
| List hostnames for a property | GET | /properties/{propertyId}/hostnames |
| Add or remove hostnames for a property's hostname bucket | PATCH | /properties/{propertyId}/hostnames |
| Get property hostnames diff | GET | /properties/{propertyId}/hostnames/diff |
| List property versions | GET | /properties/{propertyId}/versions |
| Create a new property version | POST | /properties/{propertyId}/versions |
| Get the latest property version | GET | /properties/{propertyId}/versions/latest |
| Get a property version | GET | /properties/{propertyId}/versions/{propertyVersion} |
| List available behaviors for a property | GET | /properties/{propertyId}/versions/{propertyVersion}/available-behaviors |
| List available criteria for a property | GET | /properties/{propertyId}/versions/{propertyVersion}/available-criteria |
| List hostnames for a property version | GET | /properties/{propertyId}/versions/{propertyVersion}/hostnames |
| Add or remove hostnames for a property version | PATCH | /properties/{propertyId}/versions/{propertyVersion}/hostnames |
| Update hostnames for a property version | PUT | /properties/{propertyId}/versions/{propertyVersion}/hostnames |
| Limited availability List property's includes | GET | /properties/{propertyId}/versions/{propertyVersion}/includes |
| Get a property's rule tree | GET | /properties/{propertyId}/versions/{propertyVersion}/rules |
| Get a digest for a property's rule tree | HEAD | /properties/{propertyId}/versions/{propertyVersion}/rules |
| Patch a property's rule tree | PATCH | /properties/{propertyId}/versions/{propertyVersion}/rules |
| Update a property's rule tree | PUT | /properties/{propertyId}/versions/{propertyVersion}/rules |
| Custom behaviors and overrides | ||
| List custom behaviors | GET | /custom-behaviors |
| Get a custom behavior | GET | /custom-behaviors/{behaviorId} |
| List custom overrides | GET | /custom-overrides |
| Get a custom override | GET | /custom-overrides/{overrideId} |
| Bulk search and update | ||
| Bulk activate a set of properties | POST | /bulk/activations |
| List bulk-activated properties | GET | /bulk/activations/{bulkActivationId} |
| Bulk version a set of properties | POST | /bulk/property-version-creations |
| List bulk-versioned properties | GET | /bulk/property-version-creations/{bulkCreateId} |
| Bulk patch a set of properties | POST | /bulk/rules-patch-requests |
| List bulk-patched properties | GET | /bulk/rules-patch-requests/{bulkPatchId} |
| Bulk search a set of properties or includes | POST | /bulk/rules-search-requests |
| Synchronously bulk search a set of properties or includes | POST | /bulk/rules-search-requests-synch |
| List bulk search results | GET | /bulk/rules-search-requests/{bulkSearchId} |
| Search | ||
| Search properties or includes | POST | /search/find-by-value |
| Rule formats, schemas, and utilities | ||
| Get build details | GET | /build |
| Get client settings | GET | /client-settings |
| Update client settings | PUT | /client-settings |
| List rule formats | GET | /rule-formats |
| Get a schema for a rule format | GET | /schemas/products/{productId}/{ruleFormat} |
| Get a schema for a request | GET | /schemas/request/{filename} |