over_the_boxes
Creates, updates, deletes, gets or lists an over_the_boxes resource.
Overview​
| Name | over_the_boxes |
| Type | Resource |
| Id | ovh.order.over_the_boxes |
Fields​
The following fields are returned by SELECT queries:
- list_by_service_name
- list
| Name | Datatype | Description |
|---|---|---|
value | string |
| Name | Datatype | Description |
|---|---|---|
value | string |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_by_service_name | select | service_name | Get allowed options | |
list | select | List OverTheBox services. Returns the names of the OverTheBox services of the account. Each name is the serviceName used by the other OverTheBox calls. |
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"}}) |
service_name | string | The internal name of your overTheBox offer (wire: serviceName) |
SELECT examples​
- list_by_service_name
- list
Get allowed options
SELECT
value
FROM ovh.order.over_the_boxes
WHERE service_name = '{{ service_name }}' -- required
;
List OverTheBox services. Returns the names of the OverTheBox services of the account. Each name is the serviceName used by the other OverTheBox calls.
SELECT
value
FROM ovh.order.over_the_boxes
;