robinbraemer / cloudflareapi

The most complete and extensible Cloudflare API v4 client library for Java.

The Cloudflare - API/Library for Java

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 = "[email protected]";
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

• Check out our users' guide in the wiki, Cloudflare - API/Library explained.
• There is a lot to discover about this api/library.

Licensing

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

cloudflareapi's Issues

Solved

Solved.

Example of getting the ID of a zone

Thank you for building this API wrapper.

Would it be possible, that you could provide an example of how to obtain the ID for a specific zone? Because most zone related methods rely on the zone ID and i would prefer not to hardcode it.

What i've got so far (with my very little JAVA experience):

CloudflareResponse<List<Zone>> response =
    new CloudflareRequest(Category.LIST_ZONES, cfAccess)
        .queryString("name", "mydomain.tld")
        .asObjectList(Zone.class);
        
String jsonString = response.getJson().toString();
String zoneID = JsonPath.read(jsonString, "$.result[0].id");

System.out.print(zoneID);

That seems to work, but i'm curious, if there's an easier way. It would be nice, if we could utilize the methods within the object classes (e.g. Zone.getId(), etc.). Maybe, that's already possible and i'm just too stupid to figure it out 😆

No support for API Tokens

Would it be possible to have support for API tokens (Authorization: Bearer <token>) in addition to API keys?
https://api.cloudflare.com/#getting-started-requests
Thanks

Missing dependencies and faulty documentation

Caused by: java.lang.ClassNotFoundException: io.joshworks.restclient.http.RestClient

there is no constructor for just CF_API_TOKEN

Add Cloudflare Tunnel support

Cloudflare API reference for Cloudflare Tunnel creation:
https://api.cloudflare.com/#cloudflare-tunnel-create-cloudflare-tunnel

Example Cloudflare API call to create a Cloudflare tunnel:

curl --request POST \
  --url https://api.cloudflare.com/client/v4/accounts/ACCOUNT_ID/cfd_tunnel \
  --header 'Authorization: Bearer BEARER_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
	"name": "TUNNEL_NAME",
	"tunnel_secret": "TUNNEL_SECRET_ENCODED_IN_BASE64"
}'

Add Access Service Tokens creation support

Cloudflare API reference for Access Service Tokens creation:
https://api.cloudflare.com/#access-service-tokens-create-access-service-token

Example Cloudflare API call to create Access Service Token:

curl --request POST \
  --url https://api.cloudflare.com/client/v4/accounts/ACCOUNT_ID/access/service_tokens \
  --header 'Authorization: Bearer BEARER_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
	"name": "SERVICE_TOKEN_NAME"
}'

Example of creating zone

Thank You for creating this library. Cloud flares API has a learning curve.

It would be very useful if you can add an example how to create a zone using the library in the wiki.

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: renovate.json
Error type: Invalid JSON (parsing failed)
Message: Syntax error: expecting end of expression or separator near ] "pack

Publish to Maven Central

Obvious question: Can you please publish your library to Maven Central? It would make it a lot easier for end-users to work with it.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency org.projectlombok:lombok to v1.18.32
• Update dependency com.google.code.gson:gson to v2.11.0
• Update dependency com.google.guava:guava to v32.1.3-jre
• Update dependency org.apache.commons:commons-lang3 to v3.14.0
• Update dependency org.apache.maven.plugins:maven-assembly-plugin to v3.7.1
• Update dependency org.apache.maven.plugins:maven-compiler-plugin to v3.13.0
• Update dependency org.apache.maven.plugins:maven-source-plugin to v3.3.1
• Update dependency com.google.guava:guava to v33
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

maven

pom.xml

• org.apache.maven.plugins:maven-compiler-plugin 3.11.0
• org.apache.maven.plugins:maven-assembly-plugin 3.5.0
• org.apache.maven.plugins:maven-source-plugin 3.2.1
• junit:junit 4.13.2
• org.apache.commons:commons-lang3 3.13.0
• com.google.code.gson:gson 2.10.1
• com.google.guava:guava 32.0.0-jre
• org.projectlombok:lombok 1.18.26
• io.joshworks.unirest:unirest-java 1.8.0

---

• Check this box to trigger a request for Renovate to run again on this repository

Bump guava version since it's vulnerable

https://devhub.checkmarx.com/cve-details/CVE-2020-8908/

Add Access Application creation support

Cloudflare API reference for Access Application creation:
https://api.cloudflare.com/#access-applications-create-access-application

Example Cloudflare API call to create Access Application:

curl --request POST \
  --url https://api.cloudflare.com/client/v4/accounts/ACCOUNT_ID/access/apps \
  --header 'Authorization: Bearer BEARER_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
	"name": "ACCESS_APP_NAME",
	"logo_url": "",
	"allowed_idps": [],
	"auto_redirect_to_identity": false,
	"service_auth_401_redirect": false,
	"policies": [
		{
			"decision": "non_identity",
			"name": "POLICY_NAME",
			"include": [
				{
					"service_token": {
						"token_id": "SERVICE_TOKEN_ID"
					}
				}
			],
			"exclude": [],
			"require": [],
			"precedence": 1
		}
	],
	"session_duration": "24h",
	"app_launcher_visible": true,
	"app_groups": [],
	"selected_app_groups": [],
	"is_zt_ssh_app": false,
	"domain": "ZONE_FQDN"
}'

Question about listing and creating dns record.

Hey! i am happy there is a api but my question was if you may can provide a example of creating a dns record and or a dns list because i cannot figure it out :)

Edit: i figured out that you can use .identifiers(ZONEID) on the cloudflare object to add the zone id

Add Token auth support

Add a CloudflareAccess contractor for auth with token.