consents

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

Overview

Name	consents
Type	Resource
Id	ovh.me.consents

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Campaign name
description	string	Campaign description
type	string	Campaign type (OPTIN, OPTOUT)

list

Consent campaign

Name	Datatype	Description
name	string	Campaign name
description	string	Campaign description
type	string	Campaign type (OPTIN, OPTOUT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	campaign_name		Retrieve information about a consent campaign
list	select			List all consent campaign available

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"}})
campaign_name	string	Campaign name (wire: campaignName)

SELECT examples

get

Retrieve information about a consent campaign

SELECT
name,
description,
type
FROM ovh.me.consents
WHERE campaign_name = '{{ campaign_name }}' -- required
;

list

List all consent campaign available

SELECT
name,
description,
type
FROM ovh.me.consents
;