INTEGRITY Dokumentace

Konfigurace pravidla Cloud Connector pomocí API

Cloud Connector rules můžete nakonfigurovat pomocí Cloudflare API.

Požadovaná oprávnění

API token používaný v požadavcích API pro správu pravidel Cloud Connector musí mít alespoň následující oprávnění:

Endpointy

Chcete-li získat úplný endpoint, připojte níže uvedené endpointy Cloud Connector k základní URL adrese API Cloudflare:

https://api.cloudflare.com/client/v4

{zone_id} je argument, který obsahuje ID zóny (hexadecimální řetězec). Tuto hodnotu najdete v dashboardu Cloudflare.

Následující tabulka shrnuje dostupné operace.

Operace Metoda + koncový bod
Seznam pravidel Cloud Connector GET /zones/{zone_id}/cloud_connector/rules
Vytvořit/aktualizovat/odstranit pravidla Cloud Connector PUT /zones/{zone_id}/cloud_connector/rules

Příklady volání API

Seznam pravidel typu Cloud Connector

Následující příklad vrátí seznam existujících pravidel Cloud Connector:

Požadovaná oprávnění API tokenu

Alespoň jeden z následujících oprávnění tokenu je povinné:
Pravidla
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/cloud_connector/rules" \
	--request GET \
	--header "X-Auth-Email: $CLOUDFLARE_EMAIL" \
	--header "X-Auth-Key: $CLOUDFLARE_API_KEY"
{
	"result": [
		{
			"id": "<RULE_1_ID>",
			"provider": "aws_s3",
			"expression": "http.request.uri.path wildcard \"/images/*\"",
			"description": "Connect to S3 bucket containing images",
			"enabled": true,
			"parameters": {
				"host": "examplebucketwithimages.s3.north-eu.amazonaws.com"
			}
		}
	],
	"success": true,
	"errors": [],
	"messages": []
}

Vytvořit/aktualizovat/odstranit pravidla Cloud Connector

Následující ukázkový požadavek nahradí všechna existující pravidla Cloud Connector jediným pravidlem:

Požadovaná oprávnění API tokenu

Alespoň jeden z následujících oprávnění tokenu je povinné:
PUT Rules
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/cloud_connector/rules" \
	--request PUT \
	--header "X-Auth-Email: $CLOUDFLARE_EMAIL" \
	--header "X-Auth-Key: $CLOUDFLARE_API_KEY" \
	--json '[
		{
				"expression": "http.request.uri.path wildcard \"/images/*\"",
				"provider": "cloudflare_r2",
				"description": "Connect to R2 bucket containing images",
				"parameters": {
						"host": "mybucketcustomdomain.example.com"
				}
		}
	]'

Povinné parametry těla pro každé pravidlo jsou: expression, provider, a parameters.host.

provider musí být jedna z následujících hodnot: cloudflare_r2, aws_s3, azure_storage, gcp_storage, a oci_storage.