Overview

Namespaces

  • Cloudflare
    • Organizations
      • Firewall
        • AccessRules
    • User
      • Billing
        • Subscriptions
      • Firewall
    • Zone
      • Firewall
      • SSL
      • WAF
        • Packages

Classes

  • Api
  • Certificates
  • IPs
  • Railguns
  • User
  • Zone
  • Overview
  • Namespace
  • Class

Class Certificates

CloudFlare API wrapper

CloudFlare CA API to create CloudFlare-issued SSL certificates that can be installed on your origin server. Use your Certificates API Key as your User Service Key when calling these endpoints (see the section on request headers for details)

Cloudflare\Api
Extended by Cloudflare\Certificates
Namespace: Cloudflare
Author: James Bell james@james-bell.co.uk
Version: 1
Located at CloudFlare/Certificates.php
Methods summary
public
# certificates( $page = null, $per_page = null, $direction = null )

List Certificates List all existing CloudFlare-issued Certificates for a given zone. Use your Certificates API Key as your User Service Key when calling this endpoint

List Certificates List all existing CloudFlare-issued Certificates for a given zone. Use your Certificates API Key as your User Service Key when calling this endpoint

public
# create( array $hostnames, string $request_type, string $csr, integer|null $requested_validity = null )

Create Certificate Create a CloudFlare-signed certificate. Use your Certificates API Key as your User Service Key when calling this endpoint

Create Certificate Create a CloudFlare-signed certificate. Use your Certificates API Key as your User Service Key when calling this endpoint

Parameters

$hostnames
Array of hostnames or wildcard names (e.g., *.example.com) bound to the certificate
$request_type
Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers)
$csr
The Certificate Signing Request (CSR). Must be newline-encoded.
$requested_validity
The number of days for which the certificate should be valid
public
# details( string $identifier )

Certificate Details Get an existing certificate by its serial number. Use your Certificates API Key as your User Service Key when calling this endpoint

Certificate Details Get an existing certificate by its serial number. Use your Certificates API Key as your User Service Key when calling this endpoint

Parameters

$identifier
API item identifier tag
public
# revoke( string $identifier )

Revoke certificate Revoke a created certificate for a zone. Use your Certificates API Key as your User Service Key when calling this endpoint

Revoke certificate Revoke a created certificate for a zone. Use your Certificates API Key as your User Service Key when calling this endpoint

Parameters

$identifier
API item identifier tag
Methods inherited from Cloudflare\Api
__construct(), delete(), get(), patch(), permissions(), post(), put(), request(), setAuthKey(), setCurlOption(), setEmail()
Properties summary
protected array $permission_level

Default permissions level

Default permissions level

# ['read' => null, 'edit' => null]
Properties inherited from Cloudflare\Api
$auth_key, $curl_options, $email
API documentation generated by ApiGen