subscriptions
Creates, updates, deletes, gets or lists a subscriptions resource.
Overview​
| Name | subscriptions |
| Type | Resource |
| Id | ovh.me.subscriptions |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
registered | boolean | Determine whether you are registered or not |
type | string | The type of subscription |
List of all OVH things you can subscribe to
| Name | Datatype | Description |
|---|---|---|
registered | boolean | Determine whether you are registered or not |
type | string | The type of subscription |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscription_type | Get this object properties (Deprecated, will be removed) | |
list | select | x_pagination_mode | List of all OVH things you can subscribe to (Deprecated, will be removed) | |
update | update | subscription_type | Alter this object properties (Deprecated, will be removed) |
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"}}) |
subscription_type | string | The type of subscription (wire: subscriptionType) |
x_pagination_mode | string | Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode) |
SELECT examples​
- get
- list
Get this object properties (Deprecated, will be removed)
SELECT
registered,
type
FROM ovh.me.subscriptions
WHERE subscription_type = '{{ subscription_type }}' -- required
;
List of all OVH things you can subscribe to (Deprecated, will be removed)
SELECT
registered,
type
FROM ovh.me.subscriptions
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;
UPDATE examples​
- update
Alter this object properties (Deprecated, will be removed)
UPDATE ovh.me.subscriptions
SET
registered = {{ registered }}
WHERE
subscription_type = '{{ subscription_type }}' --required;