Methods summary
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 )
List SSL configurations (permission needed: #ssl:edit)
List, search, sort, and filter all of your custom SSL certificates
List SSL configurations (permission needed: #ssl:edit)
List, search, sort, and filter all of your custom SSL certificates
Parameters
- $zone_identifier
- API item identifier tag
- $status
- Status of the zone's custom SSL
- $page
- Page number of paginated results
- $per_page
- Number of zones per page
- $order
- Field to order certificates by (status, issuer, priority, expires_on)
- $direction
- Direction to order domains (asc, desc)
- $match
- Whether to match all search requirements or at least one (any) (any, all)
|
public
|
#
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
Create SSL configuration (permission needed: #ssl:edit)
Upload a new SSL certificate for a zone
Parameters
- $zone_identifier
- API item identifier tag
- $certificate
- The zone's private key
- $private_key
- The zone's SSL certificate or certificate and the intermediate(s)
- $bundle_method
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"
|
public
|
#
details( string $zone_identifier, string $identifier )
SSL configuration details (permission needed: #ssl:read)
SSL configuration details (permission needed: #ssl:read)
Parameters
- $zone_identifier
- API item identifier tag
- $identifier
|
public
|
#
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)
Create a Keyless SSL configuration (permission needed: #ssl:edit)
Parameters
- $zone_identifier
- API item identifier tag
- $identifier
- $private_key
- The zone's SSL certificate or certificate and the intermediate(s)
- $certificate
- The zone's private key
- $bundle_method
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"
|
public
|
#
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.
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.
Parameters
- $zone_identifier
- API item identifier tag
- $certificates
- Array of ordered certificates.
|
public
|
#
delete_ssl( string $zone_identifier, string $identifier )
Delete an SSL certificate (permission needed: #ssl:edit)
Delete an SSL certificate (permission needed: #ssl:edit)
Parameters
- $zone_identifier
- API item identifier tag
- $identifier
|