ListProperties-Documentation

GET

https://api.cdnetworks.com/api/properties

Get List of Properties

Limit of request rate per user: 300/5min
Applicable Products: Dynamic Web Acceleration

For API authentication details, please refer to: API Authentication Overview

Request

Query Params

Name	Description
serviceTypeString	Optional Value: wsawsa-https Unique identifier for the product
targetString	Optional Value: stagingproduction Deployment Environment
offsetInteger	Default value: 0 Indicates the first item to return.
limitInteger	Default value: 100 Maximum number of properties to return. Range: <= 200
sortOrderString	Default value: desc Optional Value: ascdesc Order of properties to return.
sortByString	Default value: lastUpdateTime Optional Value: creationTimelastUpdateTime Returns results in sorted order.
contractIdString	The id of contract, such as 40015677
itemIdString	The id of product, such as 10

Response

Body Params

Name	Description
codeString	Response code, 0 means successful.
messageString	Response error message if failed.
- dataObject	Response data.
countInteger	Number of properties.
- propertiesList	List of properties.
propertyIdLong	Property ID
propertyNameString	Name of the property.
propertyCommentString	A description of the property.
serviceTypeString	Optional Value: wsawsa-https Unique identifier for the product.
creationTimeString	RFC3339 format date indicating when the property was created.
lastUpdateTimeString	RFC3339 date indicating when the property was last updated.
latestVersionInteger	Latest version of the property.
- stagingVersionObject	Describes the version of the property deployed to staging.
versionInteger	Version of the property.
hostnamesList	hostnames.
- productionVersionObject	Describes the version of the property deployed to production.
versionInteger	Version of the property.
hostnamesList	hostnames.
- stagingDeployingVersionObject	Describes the version of the property deploying to staging.
versionInteger	Version of the property.
hostnamesList	hostnames.
- productionDeployingVersionObject	Describes the version of the property deploying to production.
versionInteger	Version of the property.
hostnamesList	hostnames.
contractIdString	The id of contract
itemIdString	The id of product

Error code

Error code(code)	Description(message)	HTTP status	Semantic
0	success	200	success

Example

JSON-200

Request example Copy Copy success#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://api.cdnetworks.com/api/properties" \ -X "GET" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -H "Content-Type:application/json" \

#!/bin/bash
username="example_username"
apiKey="example_apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://api.cdnetworks.com/api/properties" \
-X "GET" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \

Response example Copy Copy successHTTP/1.1 200 Ok x-cnc-request-id: a123c383-5443-4eab Date: Wed, 26 Jun 2024 09:38:00 GMT x-cnc-process-time: 6.53 Content-Type: application/json;charset=utf-8 {"message":"success","code":"0","data":{"count":1,"properties":[{"propertyId":123456,"propertyName":"demo","propertyComment":"I am a demo.","offerCode":"wsa","creationTime":"2024-10-10T08:08:00Z","lastUpdateTime":"2024-10-10T08:08:18Z","latestVersion":1,"stagingVersion":{"version":1,"hostnames":["www.example.com"]}}]}}

HTTP/1.1 200 Ok
x-cnc-request-id: a123c383-5443-4eab
Date: Wed, 26 Jun 2024 09:38:00 GMT
x-cnc-process-time: 6.53
Content-Type: application/json;charset=utf-8

{"message":"success","code":"0","data":{"count":1,"properties":[{"propertyId":123456,"propertyName":"demo","propertyComment":"I am a demo.","offerCode":"wsa","creationTime":"2024-10-10T08:08:00Z","lastUpdateTime":"2024-10-10T08:08:18Z","latestVersion":1,"stagingVersion":{"version":1,"hostnames":["www.example.com"]}}]}}

Is the content of this document helpful to you?

Yes

I have suggestion