device_available_actions
Creates, updates, deletes, gets or lists a device_available_actions resource.
Overview​
| Name | device_available_actions |
| Type | Resource |
| Id | ovh.over_the_box.device_available_actions |
Fields​
The following fields are returned by SELECT queries:
- list
Device action
| Name | Datatype | Description |
|---|---|---|
name | string | Name of the action |
description | string | Description of the action |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | service_name | List the actions available on an OverTheBox device. Returns the name and description of each action that can be created on the device. |
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
List the actions available on an OverTheBox device. Returns the name and description of each action that can be created on the device.
SELECT
name,
description
FROM ovh.over_the_box.device_available_actions
WHERE service_name = '{{ service_name }}' -- required
;