Skip to main content
Skip table of contents

Cloudflare

Cloudflare is a content delivery network and DDoS mitigation product. Cloudflare acts as a reverse proxy between a website and the hosting provider.

Lucidum uses the Cloudflare connector to ingest data from Cloudflare services

Requirements

To use the Cloudflare Connector in Lucidum:

  1. Before configuring the Cloudflare connector in Lucidum, you must first define an API token in Cloudflare. Lucidum will use the app and its token to access Cloudflare. (https://api.cloudflare.com/#getting-started-requests )

  2. You can then configure the Cloudflare connector in Lucidum and start ingesting data from Cloudflare.

Prerequisite: Defining an API Bearer Token

To define an API token that Lucidum will use to fetch data from Cloudflare:

  1. Log in to the Cloudflare Dashboard (https://dash.cloudflare.com/login ) with the account you want to use with Lucidum.

  2. Go to User Profile > API Tokens.

  3. From the API Token page, select Create Token.

  4. Under API tokens templates, select the template Read all resources. This token allows Lucidum to read all account resources, zone resources, and user resources.

  5. Click Use template.

  6. Accept the default values for the Read all resources template and click Continue to summary.

  7. Select Create Token.

  8. Copy and save the token secret.

  9. To test that your credentials will work with Lucidum, login to a Linux shell.

  10. Execute the following cURL commands:

    CODE
    curl -X GET "https://api.cloudflare.com/client/v4/user/tokens/verify" \
         -H "Authorization: Bearer <token secret>" \
         -H "Content-Type:application/json"

    where:

    • <token secret> is the value you saved in step #8.

  11. If the token is valid, the cURL response will include:

    “This API Token is value and active”

Configuring the Cloudflare Connector

  1. Log in to Lucidum.

  2. In the left pane, click Connector.

  3. In the Connector page, click Add Connector.

  4. Scroll until you find the Connector for Cloudflare. Click Connect. The Settings page appears.

  5. In the Settings page, enter the following:

    • URL. The URL for the Cloudflare API. For example, https://api.cloudflare.com

    • API Token. Cloudflare API bearer token. Enter the token secret. This is the preferred way to access the API. For more details on creating the API token, see https://developers.cloudflare.com/api/tokens/create/

    • Auth Email (optional). The email address associated with your Cloudflare account. This is a legacy setting for use with an API Key.

    • API Key (optional). Legacy option for authentication with Cloudflare.

  6. To test the configuration, click Test.

    • If the connector is configured correctly, Lucidum displays a list of services that are accessible with the connector.

    • If the connector is not configured correctly, Lucidum display an error message.

API Documentation

https://developers.cloudflare.com/api/#getting-started-endpoints

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.