[ Web Proxy ]

Viewing: https://developers.cloudflare.com/api/resources/workers_builds/subresources/deploy_hooks

Deploy Hooks | Cloudflare API Skip to content

API Reference
Overview
Account & User Management
- Abuse ReportsAbuse Reports
- AccountsAccounts
- AlertingAlerting
- Audit LogsAudit Logs
  - Get account audit logs
- BillingBilling
  - ProfilesProfiles
    - Billing Profile Details
  - UsageUsage
- Custom PagesCustom Pages
- IAMIAM
- MembershipsMemberships
- Resource SharingResource Sharing
- UserUser
AI
- AIAI
- AI AuditAI Audit
  - RobotsRobots
    - Get robots.txt rules
    - Bulk get robots.txt rules
- AI GatewayAI Gateway
- AI SearchAI Search
- VectorizeVectorize
  - IndexesIndexes
Certificate Management
- ACMACM
  - Total TLSTotal TLS
  - Custom Trust StoreCustom Trust Store
- Certificate AuthoritiesCertificate Authorities
  - Hostname AssociationsHostname Associations
    - List Hostname Associations
    - Replace Hostname Associations
- Client CertificatesClient Certificates
- Custom CertificatesCustom Certificates
- Custom HostnamesCustom Hostnames
- DCV DelegationDCV Delegation
  - Retrieve the DCV Delegation unique identifier.
- HostnamesHostnames
  - SettingsSettings
    - TLSTLS
- Keyless CertificatesKeyless Certificates
- MTLS CertificatesMTLS Certificates
- Origin CA CertificatesOrigin CA Certificates
- Origin Post Quantum EncryptionOrigin Post Quantum Encryption
  - Get Origin Post-Quantum Encryption setting
  - Change Origin Post-Quantum Encryption setting
- Origin TLS Client AuthOrigin TLS Client Auth
- Origin TLS Compliance ModesOrigin TLS Compliance Modes
- SSLSSL
Cloudflare One
- Email SecurityEmail Security
- Zero TrustZero Trust
Data Localization Suite
- Data Localization SuiteData Localization Suite
  - RegionsRegions
    - List DLS regions for an account
    - Get a DLS region
  - Regional ServicesRegional Services
    - Prefix BindingsPrefix Bindings
DNS
- Account Custom NameserversAccount Custom Nameservers
- DNSDNS
- DNS FirewallDNS Firewall
- Tenant Custom NameserversTenant Custom Nameservers
Domain/Zone Management
- RegistrarRegistrar
- Registrar SandboxRegistrar Sandbox
- ZonesZones
IP Addresses
- AddressingAddressing
- IPsIPs
  - Cloudflare/JD Cloud IP Details
Media
- CallsCalls
  - SFUSFU
  - TURNTURN
- ImagesImages
  - V1V1
  - V2V2
    - List images V2
    - Direct UploadsDirect Uploads
      - Create authenticated direct upload URL V2
- MoQMoQ
  - RelaysRelays
- Realtime KitRealtime Kit
- StreamStream
Networking
- DDoS ProtectionDDoS Protection
  - Advanced TCP ProtectionAdvanced TCP Protection
- Magic Cloud NetworkingMagic Cloud Networking
- Magic Network MonitoringMagic Network Monitoring
- Magic TransitMagic Transit
- Network InterconnectsNetwork Interconnects
Observability
- Analytics QueryAnalytics Query
- DiagnosticsDiagnostics
  - TraceroutesTraceroutes
    - Traceroute
  - Endpoint HealthchecksEndpoint Healthchecks
- HealthchecksHealthchecks
- LogpushLogpush
- LogsLogs
- RUMRUM
  - Site InfoSite Info
  - RulesRules
Radar
- RadarRadar
Routing & Performance
- ArgoArgo
  - Smart RoutingSmart Routing
    - Get Argo Smart Routing setting
    - Patch Argo Smart Routing setting
  - Tiered CachingTiered Caching
    - Get Tiered Caching setting
    - Patch Tiered Caching setting
- CacheCache
- Load BalancersLoad Balancers
- Smart ShieldSmart Shield
- SpectrumSpectrum
  - AnalyticsAnalytics
    - AggregatesAggregates
      - Currents
        Get current aggregated analytics
    - EventsEvents
      - Bytimes
        Get analytics by time
      - Summaries
        Get analytics summary
  - AppsApps
- SpeedSpeed
- Waiting RoomsWaiting Rooms
- Web3Web3
  - HostnamesHostnames
Rules
- Cloud ConnectorCloud Connector
  - RulesRules
    - Rules
    - Put Rules
- Managed TransformsManaged Transforms
- Page RulesPage Rules
- Rules ListsRules Lists
  - ListsLists
- Rules TraceRules Trace
  - TracesTraces
    - Request Trace
- RulesetsRulesets
- SnippetsSnippets
- URL NormalizationURL Normalization
Security
- AI SecurityAI Security
  - Get AI Security for Apps Status
  - Set AI Security for Apps Status
  - Custom TopicsCustom Topics
    - Get AI Security for Apps Custom Topics
    - Set AI Security for Apps Custom Topics
- API GatewayAPI Gateway
  - ConfigurationsConfigurations
    - Retrieve information about specific configuration properties
    - Update configuration properties
  - DiscoveryDiscovery
    - Retrieve discovered operations on a zone rendered as OpenAPI schemas
    - OperationsOperations
      - Retrieve discovered operations on a zone
      - Patch discovered operations
  - LabelsLabels
  - OperationsOperations
  - SchemasSchemas
    - Retrieve operations and features as OpenAPI schemas
  - SettingsSettings
    - Schema ValidationSchema Validation
  - User SchemasUser Schemas
  - Expression TemplateExpression Template
    - FallthroughFallthrough
      - Generate fallthrough WAF expression template from a set of API hosts
- Bot ManagementBot Management
  - Get Zone Bot Management Config
  - Update Zone Bot Management Config
  - FeedbackFeedback
    - List zone feedback reports
    - Submit a feedback report
- Botnet FeedBotnet Feed
  - ASNASN
    - Get daily report
    - Get full report
  - ConfigsConfigs
    - ASNASN
      - Get list of ASNs
      - Delete an ASN
- Content ScanningContent Scanning
  - Enable Content Scanning
  - Disable Content Scanning
  - Update Content Scanning Status
  - Update Content Scanning Status
  - Get Content Scanning Status
  - PayloadsPayloads
  - SettingsSettings
    - Get Content Scanning Status
- Csam ScannerCsam Scanner
  - Get CSAM Scanner setting
  - Update CSAM Scanner setting
- Email AuthEmail Auth
  - DMARC ReportsDMARC Reports
    - Get DMARC Report Status
    - Configure DMARC Reports
  - SPFSPF
    - InspectInspect
      - Inspect SPF Record
- FiltersFilters
  - List filters
  - Get a filter
  - Create filters
  - Update a filter
  - Delete a filter
  - Update filters
  - Delete filters
- FirewallFirewall
  - LockdownsLockdowns
  - RulesRules
  - Access RulesAccess Rules
  - UA RulesUA Rules
  - WAFWAF
    - OverridesOverrides
    - PackagesPackages
- FraudFraud
  - Get Fraud Detection Settings
  - Update Fraud Detection Settings
- Leaked Credential ChecksLeaked Credential Checks
  - Get Leaked Credential Checks Status
  - Set Leaked Credential Checks Status
  - DetectionsDetections
- Page ShieldPage Shield
  - Get Page Shield settings
  - Update Page Shield settings
  - PoliciesPolicies
  - ConnectionsConnections
    - List Page Shield connections
    - Get a Page Shield connection
  - ScriptsScripts
    - List Page Shield scripts
    - Get a Page Shield script
  - CookiesCookies
    - List Page Shield Cookies
    - Get a Page Shield cookie
- PrecursorPrecursor
  - Get Zone Precursor Config
  - Update Zone Precursor Config
- Rate LimitsRate Limits
  - List rate limits
  - Get a rate limit
  - Create a rate limit
  - Update a rate limit
  - Delete a rate limit
- Schema ValidationSchema Validation
  - SchemasSchemas
  - SettingsSettings
- Security CenterSecurity Center
  - InsightsInsights
- Security TXTSecurity TXT
  - Retrieves security.txt
  - Updates security.txt
  - Deletes security.txt
- Token ValidationToken Validation
  - ConfigurationConfiguration
  - RulesRules
- TurnstileTurnstile
  - WidgetsWidgets
- Vulnerability ScannerVulnerability Scanner
  - Credential SetsCredential Sets
  - ScansScans
  - Target EnvironmentsTarget Environments
Storage & Databases
- D1D1
  - DatabaseDatabase
- HyperdriveHyperdrive
  - ConfigsConfigs
- KVKV
  - NamespacesNamespaces
- PipelinesPipelines
- QueuesQueues
- R2R2
- R2 Data CatalogR2 Data Catalog
- Secrets StoreSecrets Store
  - StoresStores
  - QuotaQuota
    - View secret usage
Threat Intelligence
- Brand ProtectionBrand Protection
- Cloudforce OneCloudforce One
- IntelIntel
- URL ScannerURL Scanner
  - ResponsesResponses
    - Get raw response
  - ScansScans
Workers & Pages
- Browser RenderingBrowser Rendering
- Durable ObjectsDurable Objects
  - NamespacesNamespaces
    - List Namespaces
    - ObjectsObjects
      - List Objects
- Email RoutingEmail Routing
- Email SendingEmail Sending
- FlagshipFlagship
  - AppsApps
- PagesPages
  - ProjectsProjects
  - AssetsAssets
- WorkersWorkers
- Workers BuildsWorkers Builds
- Workers For PlatformsWorkers For Platforms
  - DispatchDispatch
    - NamespacesNamespaces
- WorkflowsWorkflows
AutoRAGAutoRAG
- AI Search
- Search
- Sync
- Files
- JobsJobs
ConnectivityConnectivity
- DirectoryDirectory
  - ServicesServices
Custom CsrsCustom Csrs
- List Custom CSRs
- Create Custom CSR
- Custom CSR Details
- Delete Custom CSR
Google Tag GatewayGoogle Tag Gateway
- ConfigConfig
  - Get Google Tag Gateway configuration
  - Update Google Tag Gateway configuration
OrganizationsOrganizations
- List organizations the user has access to
- Get organization
- Create organization
- Modify organization.
- Delete organization.
- Organization AccountsOrganization Accounts
  - Get organization accounts
- Organization ProfileOrganization Profile
  - Get organization profile
  - Modify organization profile.
- MembersMembers
- LogsLogs
  - AuditAudit
    - Get organization audit logs (Version 2)
    - Get resource change history from an organization audit log entry (Version 2)
- BillingBilling
  - UsageUsage
    - Get Organization Usage (Version 2, Alpha, Restricted)
Resource TaggingResource Tagging
- List tagged resources
- Account TagsAccount Tags
- Zone TagsZone Tags
- KeysKeys
  - List tag keys
- ValuesValues
  - List tag values
- SummarySummary
  - List tag key summary
TenantsTenants
- Get tenant
- Account TypesAccount Types
  - Get tenant account types
- AccountsAccounts
  - List tenant accounts
- EntitlementsEntitlements
  - List tenant entitlements
- MembershipsMemberships
  - List tenant memberships
ZarazZaraz
- Update Zaraz workflow
- ConfigConfig
  - Get Zaraz configuration
  - Update Zaraz configuration
- DefaultDefault
  - Get default Zaraz configuration
- ExportExport
  - Export Zaraz configuration
- HistoryHistory
- PublishPublish
  - Publish Zaraz preview configuration
- WorkflowWorkflow
  - Get Zaraz workflow
Shared

API Reference

Workers Builds

Deploy Hooks

List deploy hooks

GET/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks

Create deploy hook

POST/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks

Get deploy hook

GET/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid}

Update deploy hook

PUT/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid}

Delete deploy hook

DELETE/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid}

Trigger deploy hook

POST/workers/builds/deploy_hooks/{deploy_hook_uuid}

ModelsExpand Collapse

DeployHookListResponse object { branch, created_on, deploy_hook_name, 4 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated worker script tag.

latest_build: optional object { created_on }

created_on: optional string

formatdate-time

modified_on: optional string

formatdate-time

DeployHookCreateResponse object { branch, created_on, deploy_hook_name, 3 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated worker script tag.

modified_on: optional string

formatdate-time

DeployHookGetResponse object { branch, created_on, deploy_hook_name, 3 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated worker script tag.

modified_on: optional string

formatdate-time

DeployHookUpdateResponse object { branch, created_on, deploy_hook_name, 3 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated worker script tag.

modified_on: optional string

formatdate-time

DeployHookDeleteResponse object { branch, created_on, deploy_hook_name, 3 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated worker script tag.

modified_on: optional string

formatdate-time

DeployHookTriggerResponse object { already_exists, build_uuid, created_on, status }

already_exists: optional boolean

True if a pending build already exists for this branch

build_uuid: optional string

Build UUID.

formatuuid

created_on: optional string

formatdate-time

status: optional "queued" or "initializing" or "running" or "stopped"

One of the following:

"queued"

"initializing"

"running"

"stopped"

Environment Variables

Tokens

Web Proxy Viewer | New URL | Original Page

Deploy Hooks

List deploy hooks

Create deploy hook

Get deploy hook

Update deploy hook

Delete deploy hook

Trigger deploy hook

ModelsExpand Collapse

Environment Variables

Tokens

On this page