Updates compression setting information
A request to set compression setting information is described below.
HTTP Method | Request URI |
---|---|
PUT |
https://api.edgecast.com/v2/mcc/customers/AccountNumber/compression |
Define the following variables when submitting the above request.
VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3). | Description |
---|---|
Required |
|
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
Required and optional parameters are described below.
Name | Data Type | Description |
---|---|---|
ContentTypes Required |
Array |
This response parameter can contain the set of content types on which compression will be applied. |
string |
String |
ContentTypes array Indicates a specific content type (e.g., text/plain) on which compression will be applied. If you plan on using XML, then you will need to include the following XML namespace when specifying each content type: http://schemas.microsoft.com/2003/10/Serialization/Arrays (e.g., <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">). |
MediaTypeId Required |
Integer |
Determines the platform for which compression setting information will be reported.
|
Status |
Integer |
Determines whether compression will be enabled on the platform defined in the MediaTypeID response body parameter. Valid values are:
|
The response to the above request includes an HTTP status code, response headers, and a response body.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
The response body for a successful request does not contain a response parameter.
The response body for an unsuccessful request may contain an error parameter that provides additional information.
A sample JSON request is provided below.
PUT https://api.edgecast.com/v2/mcc/customers/0001/compression HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/json
Content-Type: application/json
Host:api.edgecast.com
Content-Length: 149
{
"ContentTypes" : ["text\/plain", "text\/html", "text\/css", "application\/x-javascript", "text\/javascript"],
"MediaTypeId" : 3,
"Status" : 1
}
A sample JSON response is provided below.
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Date: Thu, 15 Apr 2021 12:00:00 GMT
Content-Length: 0
A sample XML request is provided below.
PUT https://api.edgecast.com/v2/mcc/customers/0001/compression HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/xml
Content-Type: application/xml
Host:api.edgecast.com
Content-Length: 531
<CustomerCompressionUpdate xmlns="http://www.whitecdn.com/schemas/apiservices/">
<ContentTypes>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> text/plain</string>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> text/html</string>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> text/css</string>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> application/x-javascript</string>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> text/javascript</string>
</ContentTypes>
<MediaTypeId>3</MediaTypeId>
<Status>1</Status>
</CustomerCompressionUpdate>
A sample XML response is provided below.
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Date: Thu, 15 Apr 2021 12:00:00 GMT
Content-Length: 0