--- title: Get a gateway --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [AI Gateway](https://developers.cloudflare.com/api/python/resources/ai_gateway) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get a gateway ai\_gateway.get(strid, AIGatewayGetParams\*\*kwargs) -> [AIGatewayGetResponse]() GET/accounts/{account\_id}/ai-gateway/gateways/{id} Retrieves the configuration of an AI Gateway. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `AI Gateway Write``AI Gateway Read` ##### ParametersExpand Collapse account\_id: str [Link to this property](<#(resource)%20ai_gateway%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) id: str Unique identifier of the AI Gateway within the account. maxLength64 minLength1 [Link to this property](<#(resource)%20ai_gateway%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20id%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class AIGatewayGetResponse: … id: str Unique identifier of the AI Gateway within the account. maxLength64 minLength1 Link to this property cache\_invalidate\_on\_update: bool Link to this property cache\_ttl: Optional\[int] minimum0 Link to this property collect\_logs: bool Link to this property created\_at: datetime formatdate-time Link to this property modified\_at: datetime formatdate-time Link to this property rate\_limiting\_interval: Optional\[int] minimum0 Link to this property rate\_limiting\_limit: Optional\[int] minimum0 Link to this property authentication: Optional\[bool] Link to this property byok\_only: Optional\[bool] Requires customer-provided provider credentials and prevents fallback to Unified Billing. Link to this property
dlp: Optional\[DLP] One of the following:
class DLPUnionMember0: …
action: Literal\["BLOCK", "FLAG"] One of the following: "BLOCK" Link to this property "FLAG" Link to this property
Link to this property enabled: bool Link to this property profiles: List\[str] Link to this property
Link to this property
class DLPUnionMember1: … enabled: bool Link to this property
policies: List\[DLPUnionMember1Policy] id: str Link to this property
action: Literal\["FLAG", "BLOCK"] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
check: List\[Literal\["REQUEST", "RESPONSE"]] One of the following: "REQUEST" Link to this property "RESPONSE" Link to this property
Link to this property enabled: bool Link to this property profiles: List\[str] Link to this property
Link to this property
Link to this property
Link to this property
guardrails: Optional\[Guardrails]
prompt: GuardrailsPrompt
p1: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s1: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s10: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s11: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s12: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s13: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s2: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s3: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s4: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s5: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s6: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s7: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s8: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s9: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
Link to this property
response: GuardrailsResponse
p1: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s1: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s10: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s11: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s12: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s13: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s2: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s3: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s4: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s5: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s6: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s7: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s8: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
s9: Optional\[Literal\["FLAG", "BLOCK"]] One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
Link to this property
Link to this property is\_default: Optional\[bool] Link to this property log\_classification: Optional\[bool] Link to this property log\_management: Optional\[int] maximum10000000 minimum10000 Link to this property
log\_management\_strategy: Optional\[Literal\["STOP\_INSERTING", "DELETE\_OLDEST"]] One of the following: "STOP\_INSERTING" Link to this property "DELETE\_OLDEST" Link to this property
Link to this property logpush: Optional\[bool] Link to this property logpush\_public\_key: Optional\[str] maxLength1024 minLength16 Link to this property
otel: Optional\[List\[Otel]] headers: Dict\[str, str] Link to this property url: str formaturi maxLength2048 Link to this property authorization: Optional\[str] maxLength256 Link to this property
content\_type: Optional\[Literal\["json", "protobuf"]] One of the following: "json" Link to this property "protobuf" Link to this property
Link to this property
Link to this property
rate\_limiting\_technique: Optional\[Literal\["fixed", "sliding"]] One of the following: "fixed" Link to this property "sliding" Link to this property
Link to this property
retry\_backoff: Optional\[Literal\["constant", "linear", "exponential"]] Backoff strategy for retry delays One of the following: "constant" Link to this property "linear" Link to this property "exponential" Link to this property
Link to this property retry\_delay: Optional\[int] Delay between retry attempts in milliseconds (0-60000) maximum60000 minimum0 Link to this property retry\_max\_attempts: Optional\[int] Maximum number of retry attempts for failed requests (1-5) maximum5 minimum1 Link to this property
spend\_limits: Optional\[SpendLimits] enabled: Optional\[bool] Link to this property
rules: Optional\[List\[SpendLimitsRule]] limit: float exclusiveMinimum minimum0 Link to this property limit\_type: Literal\["cost"] Link to this property window: int exclusiveMinimum minimum0 Link to this property id: Optional\[str] minLength1 Link to this property enabled: Optional\[bool] Link to this property
metadata: Optional\[Dict\[str, SpendLimitsRuleMetadata]] One of the following:
class SpendLimitsRuleMetadataMode: … mode: Literal\["partition"] Link to this property
Link to this property
class SpendLimitsRuleMetadataUnionMember1: … mode: Literal\["filter"] Link to this property values: List\[str] Link to this property
Link to this property
Link to this property
model: Optional\[SpendLimitsRuleModel] mode: Literal\["filter"] Link to this property values: List\[str] Link to this property
Link to this property
provider: Optional\[SpendLimitsRuleProvider] mode: Literal\["filter"] Link to this property values: List\[str] Link to this property
Link to this property
technique: Optional\[Literal\["fixed", "sliding"]] One of the following: "fixed" Link to this property "sliding" Link to this property
Link to this property
Link to this property
Link to this property store\_id: Optional\[str] Link to this property
stripe: Optional\[Stripe] authorization: str Link to this property
usage\_events: List\[StripeUsageEvent] payload: str Link to this property
Link to this property
Link to this property
workers\_ai\_billing\_mode: Optional\[Literal\["postpaid", "unified"]] Controls how Workers AI inference calls routed through this gateway are billed. ‘postpaid’ bills the account directly through Workers AI; ‘unified’ deducts credits via AI Gateway using neuron-based pricing and delegates billing to AI Gateway. One of the following: "postpaid" Link to this property "unified" Link to this property
Link to this property zdr: Optional\[bool] Link to this property
[Link to this property](<#(resource)%20ai_gateway%20%3E%20(model)%20ai_gateway_get_response%20%3E%20(schema)>) ### Get a gateway Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) ai_gateway = client.ai_gateway.get( id="my-gateway", account_id="3ebbcb006d4d46d7bb6a8c7f14676cb0", ) print(ai_gateway.id) ``` 200 example ``` { "result": { "id": "my-gateway", "cache_invalidate_on_update": true, "cache_ttl": 0, "collect_logs": true, "created_at": "2019-12-27T18:11:19.117Z", "modified_at": "2019-12-27T18:11:19.117Z", "rate_limiting_interval": 0, "rate_limiting_limit": 0, "authentication": true, "byok_only": true, "dlp": { "action": "BLOCK", "enabled": true, "profiles": [ "string" ] }, "guardrails": { "prompt": { "P1": "FLAG", "S1": "FLAG", "S10": "FLAG", "S11": "FLAG", "S12": "FLAG", "S13": "FLAG", "S2": "FLAG", "S3": "FLAG", "S4": "FLAG", "S5": "FLAG", "S6": "FLAG", "S7": "FLAG", "S8": "FLAG", "S9": "FLAG" }, "response": { "P1": "FLAG", "S1": "FLAG", "S10": "FLAG", "S11": "FLAG", "S12": "FLAG", "S13": "FLAG", "S2": "FLAG", "S3": "FLAG", "S4": "FLAG", "S5": "FLAG", "S6": "FLAG", "S7": "FLAG", "S8": "FLAG", "S9": "FLAG" } }, "is_default": true, "log_classification": true, "log_management": 10000, "log_management_strategy": "STOP_INSERTING", "logpush": true, "logpush_public_key": "xxxxxxxxxxxxxxxx", "otel": [ { "headers": { "foo": "string" }, "url": "https://example.com", "authorization": "authorization", "content_type": "json" } ], "rate_limiting_technique": "fixed", "retry_backoff": "constant", "retry_delay": 0, "retry_max_attempts": 1, "spend_limits": { "enabled": true, "rules": [ { "limit": 1, "limitType": "cost", "window": 1, "id": "x", "enabled": true, "metadata": { "foo": { "mode": "partition" } }, "model": { "mode": "filter", "values": [ "string" ] }, "provider": { "mode": "filter", "values": [ "string" ] }, "technique": "fixed" } ] }, "store_id": "store_id", "stripe": { "authorization": "authorization", "usage_events": [ { "payload": "payload" } ] }, "workers_ai_billing_mode": "postpaid", "zdr": true }, "success": true } ``` ##### Returns Examples 200 example ``` { "result": { "id": "my-gateway", "cache_invalidate_on_update": true, "cache_ttl": 0, "collect_logs": true, "created_at": "2019-12-27T18:11:19.117Z", "modified_at": "2019-12-27T18:11:19.117Z", "rate_limiting_interval": 0, "rate_limiting_limit": 0, "authentication": true, "byok_only": true, "dlp": { "action": "BLOCK", "enabled": true, "profiles": [ "string" ] }, "guardrails": { "prompt": { "P1": "FLAG", "S1": "FLAG", "S10": "FLAG", "S11": "FLAG", "S12": "FLAG", "S13": "FLAG", "S2": "FLAG", "S3": "FLAG", "S4": "FLAG", "S5": "FLAG", "S6": "FLAG", "S7": "FLAG", "S8": "FLAG", "S9": "FLAG" }, "response": { "P1": "FLAG", "S1": "FLAG", "S10": "FLAG", "S11": "FLAG", "S12": "FLAG", "S13": "FLAG", "S2": "FLAG", "S3": "FLAG", "S4": "FLAG", "S5": "FLAG", "S6": "FLAG", "S7": "FLAG", "S8": "FLAG", "S9": "FLAG" } }, "is_default": true, "log_classification": true, "log_management": 10000, "log_management_strategy": "STOP_INSERTING", "logpush": true, "logpush_public_key": "xxxxxxxxxxxxxxxx", "otel": [ { "headers": { "foo": "string" }, "url": "https://example.com", "authorization": "authorization", "content_type": "json" } ], "rate_limiting_technique": "fixed", "retry_backoff": "constant", "retry_delay": 0, "retry_max_attempts": 1, "spend_limits": { "enabled": true, "rules": [ { "limit": 1, "limitType": "cost", "window": 1, "id": "x", "enabled": true, "metadata": { "foo": { "mode": "partition" } }, "model": { "mode": "filter", "values": [ "string" ] }, "provider": { "mode": "filter", "values": [ "string" ] }, "technique": "fixed" } ] }, "store_id": "store_id", "stripe": { "authorization": "authorization", "usage_events": [ { "payload": "payload" } ] }, "workers_ai_billing_mode": "postpaid", "zdr": true }, "success": true } ```