PHP Class Cloudflare\Zone\CustomSSL

Custom SSL for a Zone

Author: James Bell ([email protected])

Inheritance: extends CloudFlare\Zone

Show file Open project: jamesryanbell/cloudflare

Public Methods

Method	Description
create ( string $zone_identifier, string $certificate, string $private_key, string \| null $bundle_method = null )	Create SSL configuration (permission needed: #ssl:edit) Upload a new SSL certificate for a zone
delete_ssl ( string $zone_identifier, string $identifier )	Delete an SSL certificate (permission needed: #ssl:edit)
details ( string $zone_identifier, string $identifier )	SSL configuration details (permission needed: #ssl:read)
list_certificates ( string $zone_identifier, string \| null $status = null, integer \| null $page = null, integer \| null $per_page = null, string \| null $order = null, string \| null $direction = null, string \| null $match = null )	List SSL configurations (permission needed: #ssl:edit) List, search, sort, and filter all of your custom SSL certificates
prioritize ( string $zone_identifier, array $certificates )	Re-prioritize SSL certificates (permission needed: #ssl:edit) If a zone has multiple SSL certificates, you can set the order in which they should be used during a request.
update ( string $zone_identifier, string $identifier, string $private_key, string $certificate, string \| null $bundle_method = null )	Create a Keyless SSL configuration (permission needed: #ssl:edit)

Method Details

create() public method

Create SSL configuration (permission needed: #ssl:edit) Upload a new SSL certificate for a zone

public create ( string $zone_identifier, string $certificate, string $private_key, string \| null $bundle_method = null )
$zone_identifier	string	API item identifier tag
$certificate	string	The zone's private key
$private_key	string	The zone's SSL certificate or certificate and the intermediate(s)
$bundle_method	string \| null	A ubiquitous bundle is a bundle that has a higher probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle is a bundle with the shortest chain and newest intermediates. A forced method attempt to use the certificate/chain as defined by the input "ubiquitous"

delete_ssl() public method

Delete an SSL certificate (permission needed: #ssl:edit)

public delete_ssl ( string $zone_identifier, string $identifier )
$zone_identifier	string	API item identifier tag
$identifier	string

details() public method

SSL configuration details (permission needed: #ssl:read)

public details ( string $zone_identifier, string $identifier )
$zone_identifier	string	API item identifier tag
$identifier	string

list_certificates() public method

List SSL configurations (permission needed: #ssl:edit) List, search, sort, and filter all of your custom SSL certificates

public list_certificates ( string $zone_identifier, string \| null $status = null, integer \| null $page = null, integer \| null $per_page = null, string \| null $order = null, string \| null $direction = null, string \| null $match = null )
$zone_identifier	string	API item identifier tag
$status	string \| null	Status of the zone's custom SSL
$page	integer \| null	Page number of paginated results
$per_page	integer \| null	Number of zones per page
$order	string \| null	Field to order certificates by (status, issuer, priority, expires_on)
$direction	string \| null	Direction to order domains (asc, desc)
$match	string \| null	Whether to match all search requirements or at least one (any) (any, all)

prioritize() public method

Re-prioritize SSL certificates (permission needed: #ssl:edit) If a zone has multiple SSL certificates, you can set the order in which they should be used during a request.

public prioritize ( string $zone_identifier, array $certificates )
$zone_identifier	string	API item identifier tag
$certificates	array	Array of ordered certificates.

update() public method

Create a Keyless SSL configuration (permission needed: #ssl:edit)

public update ( string $zone_identifier, string $identifier, string $private_key, string $certificate, string \| null $bundle_method = null )
$zone_identifier	string	API item identifier tag
$identifier	string
$private_key	string	The zone's SSL certificate or certificate and the intermediate(s)
$certificate	string	The zone's private key
$bundle_method	string \| null	A ubiquitous bundle is a bundle that has a higher probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle is a bundle with the shortest chain and newest intermediates. A forced method attempt to use the certificate/chain as defined by the input "ubiquitous"