Domains
extends CloudApiBase
in
implements
CloudApiInterface
Class Domains
Table of Contents
| $client | ClientInterface | |
|---|---|---|
| getAll() | Shows all domains on an environment. | DomainsResponse |
| get() | Return details about a domain. | DomainResponse |
| create() | Adds a domain to an environment. | OperationResponse |
| delete() | Deletes a domain from an environment. | OperationResponse |
| purge() | Purges varnish for selected domains in an environment. | OperationResponse |
| metrics() | Retrieves the scan data for a domain name that is part of this environment. | MetricsResponse |
| status() | Returns details about the domain. | DomainResponse |
| __construct() | Client constructor. | mixed |
Properties
$client
protected
ClientInterface
$client
Methods
getAll()
Shows all domains on an environment.
public
getAll(
$environmentUuid :
string
)
: DomainsResponse
Parameters
- $environmentUuid : string
Return values
DomainsResponseget()
Return details about a domain.
public
get(
$environmentUuid :
string
, $domain :
string
)
: DomainResponse
Parameters
- $environmentUuid : string
- $domain : string
Return values
DomainResponsecreate()
Adds a domain to an environment.
public
create(
$environmentUuid :
string
, $hostname :
string
)
: OperationResponse
Parameters
- $environmentUuid : string
- $hostname : string
Return values
OperationResponsedelete()
Deletes a domain from an environment.
public
delete(
$environmentUuid :
string
, $domain :
string
)
: OperationResponse
Parameters
- $environmentUuid : string
- $domain : string
Return values
OperationResponsepurge()
Purges varnish for selected domains in an environment.
public
purge(
$environmentUuid :
string
, $domains :
array
)
: OperationResponse
Parameters
- $environmentUuid : string
- $domains : array
Return values
OperationResponsemetrics()
Retrieves the scan data for a domain name that is part of this environment.
public
metrics(
$environmentUuid :
string
, $domain :
string
)
: MetricsResponse
Parameters
- $environmentUuid : string
- $domain : string
Return values
MetricsResponsestatus()
Returns details about the domain.
public
status(
$environmentUuid :
string
, $domain :
string
)
: DomainResponse
Parameters
- $environmentUuid : string
- $domain : string
Return values
DomainResponse__construct()
Client constructor.
public
__construct(
$client :
ClientInterface
)
: mixed
Parameters
- $client : ClientInterface