Edit GZIP settings

put

https://{hostname}/api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/gzip

Updates the GZIP compression settings configured for an endpoint version.

Path Params

versionNumber

integer

required

The unique identifier for the endpoint version.

apiEndPointId

integer

required

The unique identifier for the endpoint.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

compressResponse

string

enum

required

Defaults to ALWAYS

The type of GZIP compression configuration that you select, either ALWAYS for compressing all responses without restrictions, NEVER for no GZIP compression, or SAME_AS_ORIGIN for the same compression rules as specified for your origin server using the Content-Encoding header.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200The response reflects your updated GZIP settings.

400Bad request. Some of your request's input is invalid.

401Unauthorized. You aren't authorized to perform the action.

403Forbidden. You don't have permission to access the API endpoint.

404Not found. This API endpoint doesn't exist.

405Method not allowed.

415Unsupported Media Type.