Create a Cloudflare connector

POST

/api/integrations/cloudflare/connectors

curl --request POST \
  --url https://gateway.example.com/api/integrations/cloudflare/connectors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "enabled": true, "token": "example", "settings": { "autoSyncEnabled": true, "autoSyncIntervalSeconds": 900, "defaultTtl": 1, "defaultProxied": true } }'

• Your Gateway instance

Creates a system-level Cloudflare connector backed by an encrypted API token and syncs available DNS zones.

Authorizations

• bearerAuth

Request Body^required

JSON request body

Media typeapplication/json

object

name

required

string

>= 1 characters <= 255 characters

enabled

boolean

default: true

token

required

string

>= 1 characters <= 4096 characters

settings

object

autoSyncEnabled

boolean

default: true

autoSyncIntervalSeconds

integer

default: 900 >= 300 <= 86400

defaultTtl

integer

default: 1 >= 1 <= 86400

defaultProxied

boolean

default: true

Responses

201

Created

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

provider

required

string

Allowed values: cloudflare

name

required

string

baseUrl

required

string

enabled

required

boolean

allowlistMode

required

string

Allowed values: selected all_visible

settings

required

object

autoSyncEnabled

required

boolean

autoSyncIntervalSeconds

required

number

defaultTtl

required

number

defaultProxied

required

boolean

capabilities

required

object

key

additional properties

boolean

syncStatus

required

string

Allowed values: never idle running success error

syncLastError

string | null

syncFailureCount

required

number

syncStartedAt

string | null

syncFinishedAt

string | null

syncLastOverlapAt

string | null

syncNextRetryAt

string | null

testedAt

string | null

createdAt

required

string

updatedAt

required

string

hasToken

required

boolean

tokenMasked

required

string | null

zones

required

Array<object>

object

id

string format: uuid

connectorId

string format: uuid

remoteId

required

string

name

required

string

status

string | null

accountId

string | null

accountName

string | null

lastSeenAt

string

metadata

object

key

additional properties

createdAt

string

updatedAt

string

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example resource",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:30:00.000Z"
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}