Properties

Configure a property with defined rules, behaviors, and match criteria that trigger the actions that control how edge servers respond to various kinds of requests to your site and its content.

What you'll do

1. Create or clone a property.
2. Get a property's rules and make changes.
3. Update the property.
4. Activate the property.

Create property

Create a new property or a clone an existing property by using your contract, group, and product IDs.

New

New property configurations come with a default set of rules. You can use the default property rules with the addition of information that identifies your site, refine the default rules to fit your needs, or replace the defaults with an existing set of rules.

$NewProperty = New-Property -Name MyNewProperty -ProductID prd_Object_Delivery -GroupID 12345 -ContractID C-0N7RAC7

propertyLink                                                   propertyID
------------                                                   ----------
/papi/v1/properties/987654?contractId=C-0N7RAC7&groupID=12345      987654     

Returned is a link to your property and the property's ID.

👍

Tip

Use the default property on a network while you work to customize your rules to apply basic protections to your site's traffic.

1. Get your property's rules.
2. Add a CP code, an origin hostname, and an edge hostname to the behaviors of your default rule and update to your property.
3. Activate your property.

New from clone

Use an existing property's ID or name and a version or version Etag to create clone of the configuration and rules that you can use as is or update.

To clone the latest version of a property, pass a value of latest for -CloneFromVersion.

$NewProperty = New-Property -ClonePropertyName MyExistingProperty -CloneFromVersion latest -Name MyNewProperty -ProductID  prd_Object_Delivery -GroupID 12345 -ContractID C-0N7RAC7

propertyLink                                                   propertyID
------------                                                   ----------
/papi/v1/properties/987654?contractId=C-0N7RAC7&groupID=12345      987654

Returned is a link to your property and the property's ID.

New property version

Use any version of a property to create a new inactive, editable version. To use the latest version of a property, pass a value of latest for -CreateFromVersion.

New-PropertyVersion -PropertyName MyProperty -CreateFromVersion 10

propertyLink                                                              propertyVersion
------------                                                              ---------------
/papi/v1/properties/12345/versions/11?contractId=C-0N7RAC7&groupId=12345               11 

Returned is a link to your property's new version and the property's version number.

Use the new version to update rules, hostnames, or other settings and then activate it on a network to apply changes to your traffic.

Get properties

Use your group and contract IDs to get a list of all your properties. For a single property, pass a property name or ID.

# Get all
Get-Property -GroupID 12345 -ContractID C-0N7RAC7

# Get one
Get-Property -PropertyName MyProperty

accountId:        A-CCT1234
contractId:       C-0N7RAC7
groupId:          12345
propertyId:       76543
propertyName:     MyProperty
latestVersion:    4
stagingVersion:   2
productionVersion:
assetId:          12345

accountId:        A-CCT1234
contractId:       C-0N7RAC72
groupId:          65432
propertyId:       76543
propertyName:     MyProperty2
latestVersion:    2
stagingVersion:   1
productionVersion:
assetId:          98765

accountId:        A-CCT1234
contractId:       C-0N7RAC7
groupId:          12345
propertyId:       76543
propertyName:     MyProperty
latestVersion:    4
stagingVersion:   2
productionVersion:
assetId:          12345

Update property

How you update a property depends on what you're trying to change.

• You do not need to create new versions of includes, rules, or properties that have never been activated on staging or production.
• Until activated, you can continue to make changes to your property and save them upstream using Set commands.

Activate property

To apply a property's settings to your traffic, activate the property on a network using its name or ID and version. If you want to activate the latest version of a property, pass a value of latest for -PropertyVersion.

New-PropertyActivation -PropertyName MyProperty -PropertyVersion 11 -Network Staging -NotifyEmails jsmith@email.com

activationLink                                                                   activationId
--------------                                                                   ------------
/papi/v1/properties/786543/activations/12345?contractId=C-0N7RAC7&groupId=12345         12345