Deployment Integrations

Start Cloudflare OAuth integration

Creates a Cloudflare OAuth authorization URL for deployment integration setup.

post/v2/organization/{organization}/deployment-integration/cloudflare/oauth/start

Request

Base URL: https://api.zephyr-cloud.io
URL: https://api.zephyr-cloud.io/v2/organization/{organization}/deployment-integration/cloudflare/oauth/start
Auth: HTTP bearer

Path parameters

organizationstring required

Organization unique name (URL-safe slug)

Example:zephyr-cloud

Request body

namestring required

Integration name

displayNamestring

Integration display name

delimiter'-' | '.'

Delimiter used in generated deploy URLs

workerNamestring

Cloudflare Worker script name. Alphanumeric characters and dashes only. Must be at most 63 characters after the ze- prefix is applied.

kvEnvsNamespaceNamestring

Cloudflare Workers KV namespace title. Zephyr creates or reuses a namespace with this title.

kvSnapshotsNamespaceNamestring

Cloudflare Workers KV namespace title. Zephyr creates or reuses a namespace with this title.

kvFilesNamespaceNamestring

Cloudflare Workers KV namespace title. Zephyr creates or reuses a namespace with this title.

isDefaultboolean

Set as default integration after successful deployment

dnsAcknowledgedtrue required

Confirms the user acknowledged Cloudflare DNS setup requirements

Example request

{
  "name": "cloudflare-prod",
  "displayName": "Cloudflare Production",
  "delimiter": "-",
  "workerName": "ze-worker-for-static-upload",
  "kvEnvsNamespaceName": "ze_envs",
  "kvSnapshotsNamespaceName": "ze_envs",
  "kvFilesNamespaceName": "ze_envs",
  "dnsAcknowledged": true
}

Response

OAuth URL

Changes

No recorded changes to this operation across all 1 revision of this API.