REST API for Content Management 1.1

Get CDN Configuration

get

/documents/api/1.1/config/sites/deliverycdn

Retrieve the Content Delivery Network URL.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json
application/xml

200 Response

The request was fulfilled.

Body

Content Delivery Network configuration description.

Root Schema : ContentDeliveryNetworkResponse

Content Delivery Network configuration description.

Properties

description: Type: string

The description of the Content Delivery Network.
domain: Type: string

Content Delivery Network's URL.
errorCode: Type: number

An error code of zero (0) indicates no errors.

Example application/json


{
    "errorCode":"0",
    "items":[
        {
            "type":"config",
            "domain":"www.myContentDeliveryDomain.com",
            "description":"Content Delivery Site Description"
        }
    ]
}

Examples

The following example retrieves the CDN configuration on a system where the CDN was configured.

GET .../config/sites/deliverycdn

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "items": [
        {
            "type": "config",
            "domain": "www.deliveryDomain.com",
            "description": "Delivery Site Description"
        }
    ]
}

Example 2

The following example retrieves the CDN configuration on a system where the CDN was not configured.

GET .../config/sites/deliverycdn

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0"
}