easy_hunting_hunting_agent_event_tokens
Creates, updates, deletes, gets or lists an easy_hunting_hunting_agent_event_tokens resource.
Overview​
| Name | easy_hunting_hunting_agent_event_tokens |
| Type | Resource |
| Id | ovh.telephony.easy_hunting_hunting_agent_event_tokens |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
token | string |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | agent_id, billing_account, service_name | Get the event token | |
create | insert | agent_id, billing_account, service_name, expiration | Create an event token | |
delete | delete | agent_id, billing_account, service_name | Delete the event token |
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 |
|---|---|---|
agent_id | integer | (wire: agentId) |
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"}}) |
billing_account | string | The name of your billingAccount (wire: billingAccount) |
service_name | string | (wire: serviceName) |
SELECT examples​
- get
Get the event token
SELECT
token
FROM ovh.telephony.easy_hunting_hunting_agent_event_tokens
WHERE agent_id = '{{ agent_id }}' -- required
AND billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;
INSERT examples​
- create
- Manifest
Create an event token
INSERT INTO ovh.telephony.easy_hunting_hunting_agent_event_tokens (
expiration,
agent_id,
billing_account,
service_name
)
SELECT
'{{ expiration }}' /* required */,
'{{ agent_id }}',
'{{ billing_account }}',
'{{ service_name }}'
;
# Description fields are for documentation purposes
- name: easy_hunting_hunting_agent_event_tokens
props:
- name: agent_id
value: {{ agent_id }}
description: Required parameter for the easy_hunting_hunting_agent_event_tokens resource.
- name: billing_account
value: "{{ billing_account }}"
description: Required parameter for the easy_hunting_hunting_agent_event_tokens resource.
- name: service_name
value: "{{ service_name }}"
description: Required parameter for the easy_hunting_hunting_agent_event_tokens resource.
- name: expiration
value: "{{ expiration }}"
description: |
Time to live in seconds for the token
valid_values: ['1 day', '1 hour', '30 days', '5 minutes', 'unlimited']
DELETE examples​
- delete
Delete the event token
DELETE FROM ovh.telephony.easy_hunting_hunting_agent_event_tokens
WHERE agent_id = '{{ agent_id }}' --required
AND billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required
;