Test Cloudflare connection before saving a connector

POST

/api/integrations/cloudflare/connectors/preview-test

curl --request POST \
  --url https://gateway.example.com/api/integrations/cloudflare/connectors/preview-test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

• Your Gateway instance

Uses the submitted Cloudflare token for a one-time connection test. The token is not stored.

Authorizations

• bearerAuth

Request Body^required

JSON request body

Media typeapplication/json

object

token

required

string

>= 1 characters <= 4096 characters

Example^generated

{
  "token": "example"
}

Responses

200

Successful response

Media typeapplication/json

object

data

required

object

capabilities

required

object

key

additional properties

boolean

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"
}