SslCertificates
extends CloudApiBase
in
implements
CloudApiInterface
Class SslCertificates
Table of Contents
| $client | ClientInterface | |
|---|---|---|
| getAll() | Returns a list of SSL certificates. | SslCertificatesResponse |
| get() | Returns a specific certificate by certificate ID. | SslCertificateResponse |
| create() | Install an SSL certificate. | OperationResponse |
| delete() | Delete a specific certificate by ID. | OperationResponse |
| disable() | Deactivates an active SSL certificate. | OperationResponse |
| enable() | Activates an SSL certificate. | OperationResponse |
| __construct() | Client constructor. | mixed |
Properties
$client
protected
ClientInterface
$client
Methods
getAll()
Returns a list of SSL certificates.
public
getAll(
$environmentUuid :
string
)
: SslCertificatesResponse
Parameters
- $environmentUuid : string
The environment ID
Return values
SslCertificatesResponseget()
Returns a specific certificate by certificate ID.
public
get(
$environmentUuid :
string
, $certificateId :
int
)
: SslCertificateResponse
Parameters
- $environmentUuid : string
The environment ID
- $certificateId : int
Return values
SslCertificateResponsecreate()
Install an SSL certificate.
public
create(
$envUuid :
string
, $label :
string
, $cert :
string
, $key :
string
[, $ca :
string
= null ]
[, $csr :
int
= null ]
[, $legacy :
bool
= false ]
)
: OperationResponse
Parameters
- $envUuid : string
- $label : string
- $cert : string
- $key : string
- $ca : string = null
- $csr : int = null
- $legacy : bool = false
Return values
OperationResponsedelete()
Delete a specific certificate by ID.
public
delete(
$environmentUuid :
string
, $certificateId :
int
)
: OperationResponse
Parameters
- $environmentUuid : string
- $certificateId : int
Return values
OperationResponsedisable()
Deactivates an active SSL certificate.
public
disable(
$environmentUuid :
string
, $certificateId :
int
)
: OperationResponse
Parameters
- $environmentUuid : string
- $certificateId : int
Return values
OperationResponseenable()
Activates an SSL certificate.
public
enable(
$environmentUuid :
string
, $certificateId :
int
)
: OperationResponse
Parameters
- $environmentUuid : string
- $certificateId : int
Return values
OperationResponse__construct()
Client constructor.
public
__construct(
$client :
ClientInterface
)
: mixed
Parameters
- $client : ClientInterface