Create or clone a property

post

https://{hostname}/papi/v1/properties

This operation either creates a new property from scratch or bases one on another property's rule tree and optionally its set of assigned hostnames. Version 1 of a new property is created automatically. PAPI's ability to create and clone new properties means that you can design a system of rule templates targeted to specific domains, rather than maintain a single set of rules with conditional logic for your full range of domains. Maintaining properties manually within the Control Center interface limited you to that more consolidated approach, but you can deploy rules more efficiently using PAPI. In either case, PAPI makes it much easier for you to support a large, flexible set of domains.

Query Params

contractId

string

required

Unique identifier for the contract. See ID prefixes for details on omitting the value's ctr_ prefix.

groupId

string

required

Unique identifier for the group. See ID prefixes for details on omitting the value's grp_ prefix.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Contains configuration data to apply to edge content. Relevant response objects appear within the outer envelope's properties.items array.

cloneFrom

object

Optionally identifies another property instance to clone when making a POST request to create a new property. You need to assign the same contract and group to the cloned property.

productId

string

required

Unique identifier for the product. See ID prefixes for details on omitting the value's prd_ prefix.

propertyName

string

required

A unique, descriptive name for the property. It's not modifiable after you initially create it on a POST request.

ruleFormat

string

On GET, reflects the property's current format. Otherwise on POST, assigns a specific rule format to the property. Ignored on PUT, since you need to modify the Content-Type to change rule formats. For details, see Update rules to a newer set of features.

useHostnameBucket

boolean

Defaults to false

Available if you have the Hostname Bucket module added to your contract, false by default. When enabled, this creates a special type of property where you can add or remove property hostnames without incrementing property versions.

Headers

PAPI-Use-Prefixes

string

enum

required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201The response provides a URL link to the newly created or cloned property.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

413Request entity too large.

415Unsupported media type.

429Too many requests.

500Internal server error.