Properties

Number of APIs: 4

1. Get a property

GET https://{{host}}/papi/v1/properties/:propertyId

This operation gets a specific property. You can call this operation by specifying any of the propertyId members from a list of properties, or by running a GET on the propertyLink response when creating a new property.

---

2. Create or clone a property

POST https://{{host}}/papi/v1/properties?contractId={{contractId}}&groupId={{groupId}}

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.

---

3. List properties

GET https://{{host}}/papi/v1/properties?contractId={{contractId}}&groupId={{groupId}}

This operation lists properties available for the current contract and group. Use optional query parameters to only show properties that were modified within a specified time range or on a selected network. If you specify the modifiedSince parameter, contractId and groupId become optional. If you don't identify a contract and group, the operation lists all properties you have access to, modified within a specified time range.

---

4. Remove a property

DELETE https://{{host}}/papi/v1/properties/:propertyId

Removes a specific property, which you can only do if none of its versions are currently active. Activating another property with the same set of hostnames automatically triggers a deactivation on the targeted property. See Create a new activation for details. A successful DELETE results in a 200 response with the confirmation message. Attempting to delete an active property results in a 500 error. Attempting to delete an unknown property results in a 404 error.

---