Jump to

• Request
• Response
• Examples

Get CDN Configuration

get

/documents/api/1.2/config/sites/deliverycdn

Retrieve the Content Delivery Network URL.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : ContentDeliveryNetworkResponse

Type: object

Content Delivery Network configuration description.

Show Source

• description(optional): string
  The description of the Content Delivery Network.
• domain(optional): string
  Content Delivery Network's URL.
• errorCode(optional): number
  An error code of zero (0) indicates no errors.

{
    "description":"Content Delivery Network configuration description.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "domain":{
            "type":"string",
            "description":"Content Delivery Network's URL."
        },
        "description":{
            "type":"string",
            "description":"The description of the Content Delivery Network."
        }
    }
}

Example Response (application/json)

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

Back to Top

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"
}

Back to Top