Change Regional Tiered Cache setting

Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.

/zones/{zone_identifier}/cache/regional_tiered_cache

patch

Zone Cache Settings

zone-cache-settings-change-regional-tiered-cache-setting

Debug "planAvailability"

{
  "business": false,
  "enterprise": true,
  "free": false,
  "pro": false
}

Debug "tokenPermissions"

{
  "enum": [
    "#zone_settings:edit"
  ]
}

Debug "parameters"

[
  {
    "in": "path",
    "name": "zone_identifier",
    "required": true,
    "schema": {
      "description": "Identifier",
      "example": "023e105f4ecef8ad9ca31a8372d0c353",
      "maxLength": 32,
      "readOnly": true,
      "type": "string"
    }
  }
]

Debug "requestBody"

{
  "content": {
    "application/json": {
      "schema": {
        "properties": {
          "value": {
            "default": "off",
            "description": "Value of the Regional Tiered Cache zone setting.",
            "enum": [
              "on",
              "off"
            ],
            "type": "string"
          }
        },
        "required": [
          "value"
        ]
      }
    }
  },
  "required": true
}

Debug "responses"

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "allOf": [
                {
                  "allOf": [
                    {
                      "properties": {
                        "errors": {
                          "example": [],
                          "items": {
                            "properties": {
                              "code": {
                                "minimum": 1000,
                                "type": "integer"
                              },
                              "message": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "code",
                              "message"
                            ],
                            "type": "object",
                            "uniqueItems": true
                          },
                          "type": "array"
                        },
                        "messages": {
                          "example": [],
                          "items": {
                            "properties": {
                              "code": {
                                "minimum": 1000,
                                "type": "integer"
                              },
                              "message": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "code",
                              "message"
                            ],
                            "type": "object",
                            "uniqueItems": true
                          },
                          "type": "array"
                        },
                        "result": {
                          "anyOf": [
                            {
                              "type": "object"
                            },
                            {
                              "items": {},
                              "type": "array"
                            },
                            {
                              "type": "string"
                            }
                          ]
                        },
                        "success": {
                          "description": "Whether the API call was successful",
                          "enum": [
                            true
                          ],
                          "example": true,
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "success",
                        "errors",
                        "messages",
                        "result"
                      ],
                      "type": "object"
                    },
                    {
                      "properties": {
                        "result": {
                          "anyOf": [
                            {
                              "nullable": true,
                              "type": "object"
                            },
                            {
                              "nullable": true,
                              "type": "string"
                            }
                          ]
                        }
                      }
                    }
                  ],
                  "type": "object"
                },
                {
                  "properties": {
                    "result": {
                      "type": "object"
                    }
                  }
                }
              ]
            },
            {
              "properties": {
                "result": {
                  "allOf": [
                    {
                      "allOf": [
                        {
                          "properties": {
                            "id": {
                              "description": "Identifier of the zone setting.",
                              "type": "string"
                            },
                            "modified_on": {
                              "description": "last time this setting was modified.",
                              "example": "2014-01-01T05:20:00.12345Z",
                              "format": "date-time",
                              "nullable": true,
                              "readOnly": true,
                              "type": "string"
                            }
                          },
                          "required": [
                            "id",
                            "modified_on"
                          ]
                        },
                        {
                          "properties": {
                            "id": {
                              "description": "ID of the zone setting.",
                              "enum": [
                                "tc_regional"
                              ],
                              "example": "tc_regional"
                            }
                          }
                        }
                      ],
                      "description": "Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.",
                      "title": "Regional Tiered Cache"
                    },
                    {
                      "properties": {
                        "value": {
                          "allOf": [
                            {
                              "properties": {
                                "id": {
                                  "description": "Identifier of the zone setting.",
                                  "type": "string"
                                },
                                "modified_on": {
                                  "description": "last time this setting was modified.",
                                  "example": "2014-01-01T05:20:00.12345Z",
                                  "format": "date-time",
                                  "nullable": true,
                                  "readOnly": true,
                                  "type": "string"
                                }
                              },
                              "required": [
                                "id",
                                "modified_on"
                              ]
                            },
                            {
                              "properties": {
                                "id": {
                                  "description": "ID of the zone setting.",
                                  "enum": [
                                    "tc_regional"
                                  ],
                                  "example": "tc_regional"
                                }
                              }
                            }
                          ],
                          "description": "Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.",
                          "title": "Regional Tiered Cache"
                        }
                      },
                      "required": [
                        "value"
                      ]
                    }
                  ]
                }
              }
            }
          ]
        }
      }
    },
    "description": "Change Regional Tiered Cache setting response"
  },
  "4XX": {
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "allOf": [
                {
                  "allOf": [
                    {
                      "allOf": [
                        {
                          "properties": {
                            "errors": {
                              "example": [],
                              "items": {
                                "properties": {
                                  "code": {
                                    "minimum": 1000,
                                    "type": "integer"
                                  },
                                  "message": {
                                    "type": "string"
                                  }
                                },
                                "required": [
                                  "code",
                                  "message"
                                ],
                                "type": "object",
                                "uniqueItems": true
                              },
                              "type": "array"
                            },
                            "messages": {
                              "example": [],
                              "items": {
                                "properties": {
                                  "code": {
                                    "minimum": 1000,
                                    "type": "integer"
                                  },
                                  "message": {
                                    "type": "string"
                                  }
                                },
                                "required": [
                                  "code",
                                  "message"
                                ],
                                "type": "object",
                                "uniqueItems": true
                              },
                              "type": "array"
                            },
                            "result": {
                              "anyOf": [
                                {
                                  "type": "object"
                                },
                                {
                                  "items": {},
                                  "type": "array"
                                },
                                {
                                  "type": "string"
                                }
                              ]
                            },
                            "success": {
                              "description": "Whether the API call was successful",
                              "enum": [
                                true
                              ],
                              "example": true,
                              "type": "boolean"
                            }
                          },
                          "required": [
                            "success",
                            "errors",
                            "messages",
                            "result"
                          ],
                          "type": "object"
                        },
                        {
                          "properties": {
                            "result": {
                              "anyOf": [
                                {
                                  "nullable": true,
                                  "type": "object"
                                },
                                {
                                  "nullable": true,
                                  "type": "string"
                                }
                              ]
                            }
                          }
                        }
                      ],
                      "type": "object"
                    },
                    {
                      "properties": {
                        "result": {
                          "type": "object"
                        }
                      }
                    }
                  ]
                },
                {
                  "properties": {
                    "result": {
                      "allOf": [
                        {
                          "allOf": [
                            {
                              "properties": {
                                "id": {
                                  "description": "Identifier of the zone setting.",
                                  "type": "string"
                                },
                                "modified_on": {
                                  "description": "last time this setting was modified.",
                                  "example": "2014-01-01T05:20:00.12345Z",
                                  "format": "date-time",
                                  "nullable": true,
                                  "readOnly": true,
                                  "type": "string"
                                }
                              },
                              "required": [
                                "id",
                                "modified_on"
                              ]
                            },
                            {
                              "properties": {
                                "id": {
                                  "description": "ID of the zone setting.",
                                  "enum": [
                                    "tc_regional"
                                  ],
                                  "example": "tc_regional"
                                }
                              }
                            }
                          ],
                          "description": "Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.",
                          "title": "Regional Tiered Cache"
                        },
                        {
                          "properties": {
                            "value": {
                              "allOf": [
                                {
                                  "properties": {
                                    "id": {
                                      "description": "Identifier of the zone setting.",
                                      "type": "string"
                                    },
                                    "modified_on": {
                                      "description": "last time this setting was modified.",
                                      "example": "2014-01-01T05:20:00.12345Z",
                                      "format": "date-time",
                                      "nullable": true,
                                      "readOnly": true,
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "modified_on"
                                  ]
                                },
                                {
                                  "properties": {
                                    "id": {
                                      "description": "ID of the zone setting.",
                                      "enum": [
                                        "tc_regional"
                                      ],
                                      "example": "tc_regional"
                                    }
                                  }
                                }
                              ],
                              "description": "Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.",
                              "title": "Regional Tiered Cache"
                            }
                          },
                          "required": [
                            "value"
                          ]
                        }
                      ]
                    }
                  }
                }
              ]
            },
            {
              "properties": {
                "errors": {
                  "allOf": [
                    {
                      "example": [],
                      "items": {
                        "properties": {
                          "code": {
                            "minimum": 1000,
                            "type": "integer"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object",
                        "uniqueItems": true
                      },
                      "type": "array"
                    }
                  ],
                  "example": [
                    {
                      "code": 7003,
                      "message": "No route for the URI"
                    }
                  ],
                  "minLength": 1
                },
                "messages": {
                  "allOf": [
                    {
                      "example": [],
                      "items": {
                        "properties": {
                          "code": {
                            "minimum": 1000,
                            "type": "integer"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object",
                        "uniqueItems": true
                      },
                      "type": "array"
                    }
                  ],
                  "example": []
                },
                "result": {
                  "enum": [
                    null
                  ],
                  "nullable": true,
                  "type": "object"
                },
                "success": {
                  "description": "Whether the API call was successful",
                  "enum": [
                    false
                  ],
                  "example": false,
                  "type": "boolean"
                }
              },
              "required": [
                "success",
                "errors",
                "messages",
                "result"
              ],
              "type": "object"
            }
          ]
        }
      }
    },
    "description": "Change Regional Tiered Cache setting response failure"
  }
}

Debug "security"

[
  {
    "api_email": [],
    "api_key": []
  }
]