Skip to content

robinbraemer/CloudflareAPI

Repository files navigation

The Cloudflare - API/Library for Java

Jitpack-Month JitPack Travis License

This Cloudflare API/Library interacts with Cloudflare's fast API v4 and allows you to access every single feature (even if it isn't added yet) of Cloudflare's API faster and much easier!

To add a dependency on this Cloudflare-API/Library using Maven or Gradle use the following:

Maven:

<dependency>
  <groupId>com.github.robinbraemer</groupId>
  <artifactId>cloudflareapi</artifactId>
  <version>GIT_COMMIT_SHA</version>
</dependency>
	
<repositories>
  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>

Gradle:

dependencies {
  compile 'com.github.robinbraemer:cloudflareapi:<GIT_COMMIT_SHA>'
}

allprojects {
  repositories {
    maven { url 'https://jitpack.io' }
  }
}

Features

  • easy to build cloudflare requests (builder pattern)
  • able to access every corner of cloudflare's api
  • parsing results as objects (object oriented representation)
  • it is an extremely flexible api
  • asynchronicity support
  • token & key+email authentication support

Getting Started

First, you define the access object.

String CF_API_TOKEN = "your_cloudflare_api_token";
CloudflareAccess cfAccess = new CloudflareAccess(CF_API_TOKEN);

Or use key+email authentication:

String CF_API_KEY = "your_cloudflare_api_key";
String CF_EMAIL = "your_cloudflare@email.com";
CloudflareAccess cfAccess = new CloudflareAccess(CF_API_KEY, CF_EMAIL);

Then you can create cloudflare requests.

CloudflareResponse<List<Zone>> response =
    new CloudflareRequest( Category.LIST_ZONES, cfAccess )
        .asObjectList( Zone.class );

Learn more about the Cloudflare - client library

Licensing

Licensed under the Apache License 2.0. See the LICENSE file for details.