Skip to main content

user_logs_tokens

Creates, updates, deletes, gets or lists a user_logs_tokens resource.

Overview​

Nameuser_logs_tokens
TypeResource
Idovh.hosting_web.user_logs_tokens

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
valuestring (password)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectservice_nameattached_domain, remote_check, ttlGet a logs interface token. Returns a temporary token to access the logs interface. Set its lifetime in seconds with ttl, its scope with attachedDomain, and remoteCheck to limit it to the caller IP.

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.

NameDatatypeDescription
api_hoststringThe 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_namestringThe internal name of your hosting (wire: serviceName)
attached_domainstringSpecific attached domain to be included in the scope of your token (wire: attachedDomain)
remote_checkbooleanWhether to limit the use of the token to the remote IPv4 of API caller (wire: remoteCheck)
ttlintegerExpiration of your token (in seconds)

SELECT examples​

Get a logs interface token. Returns a temporary token to access the logs interface. Set its lifetime in seconds with ttl, its scope with attachedDomain, and remoteCheck to limit it to the caller IP.

SELECT
value
FROM ovh.hosting_web.user_logs_tokens
WHERE service_name = '{{ service_name }}' -- required
AND attached_domain = '{{ attached_domain }}'
AND remote_check = '{{ remote_check }}'
AND ttl = '{{ ttl }}'
;