LogoCloudflare API

Smart Shield

smart_shield

Methods

Get Smart Shield Settings -> Envelope<{ cache_reserve, healthchecks_count, regional_tiered_cache, 2 more... }>
get/zones/{zone_id}/smart_shield

Retrieve Smart Shield Settings.

Patch Smart Shield Settings -> Envelope<{ smart_tiered_cache }>
patch/zones/{zone_id}/smart_shield

Set Smart Shield Settings.

Smart Shield

Cache Reserve Clear

smart_shield.cache_reserve_clear

Methods

Get Cache Reserve Clear -> Envelope<{ id, start_ts, state, 2 more... }>
get/zones/{zone_id}/smart_shield/cache_reserve_clear

You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

Start Cache Reserve Clear -> Envelope<{ id, start_ts, state, 2 more... }>
post/zones/{zone_id}/smart_shield/cache_reserve_clear

You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

Smart Shield

Health Checks

smart_shield.health_checks

Methods

List Health Checks -> V4PagePaginationArray<{ id, address, check_regions, 15 more... }>
get/zones/{zone_id}/smart_shield/healthchecks

List configured health checks.

Health Check Details -> Envelope<{ id, address, check_regions, 15 more... }>
get/zones/{zone_id}/smart_shield/healthchecks/{healthcheck_id}

Fetch a single configured health check.

Create Health Check -> Envelope<{ id, address, check_regions, 15 more... }>
post/zones/{zone_id}/smart_shield/healthchecks

Create a new health check.

Update Health Check -> Envelope<{ id, address, check_regions, 15 more... }>
put/zones/{zone_id}/smart_shield/healthchecks/{healthcheck_id}

Update a configured health check.

Patch Health Check -> Envelope<{ id, address, check_regions, 15 more... }>
patch/zones/{zone_id}/smart_shield/healthchecks/{healthcheck_id}

Patch a configured health check.

Delete Health Check -> Envelope<{ id }>
delete/zones/{zone_id}/smart_shield/healthchecks/{healthcheck_id}

Delete a health check.