API

Update a CP code

put
https://{hostname}/cprg/v1/cpcodes/

Modifies a specific CP code. After running the GET a CP code operation, use the response to build a request body. You can only modify a CP code's name, time zone, and purgeable member.

Path Params
integer
required

The identifier for the CP code.

Query Params
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

Contains the request members that you can specify when updating a CP code. You should only modify a CP code's name, time zone, and purgeable member. Modifying other members results in a 400 error response and causes the request to fail.

accessGroup
object

A group that controls access to specific CP codes.

string
required
length ≥ 1

The descriptive label for the CP code.

overrideTimezone
object
required

The GMT time zone that overrides the default time zone assigned to the CP code. Only a few legacy reports override the default time zone for the time axis. Most reports, and all new ones, use the user's own time zone for the time axis.

boolean

Whether you can purge the content cached by the CP code.

string
enum

Whether the CP code supports serving traffic from China, or Regular traffic elsewhere.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 2 months ago