eligibilities
Creates, updates, deletes, gets or lists an eligibilities resource.
Overview​
| Name | eligibilities |
| Type | Resource |
| Id | ovh.ssl_gateway.eligibilities |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
domain | string | Customer domain name |
ip_6s | array | Eligible IP(s) v6 for this domain (wire: ip6s) |
ips | array | Eligible IP(s) for this domain |
is_hosted_by_ovh | boolean | Whether this domain is hosted by Ovh or not (wire: isHostedByOvh) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain | Check domain eligibility (Beta version) |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
domain | string | domain to check eligibility for SSL Gateway offer |
SELECT examples​
- get
Check domain eligibility (Beta version)
SELECT
domain,
ip_6s,
ips,
is_hosted_by_ovh
FROM ovh.ssl_gateway.eligibilities
WHERE domain = '{{ domain }}' -- required
;