fax_custom_domains

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

Overview

Name	fax_custom_domains
Type	Resource
Id	ovh.me.fax_custom_domains

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
domain	string	The custom domain of your fax services

list

Custom domains of your fax services

Name	Datatype	Description
id	integer
domain	string	The custom domain of your fax services

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Get this object properties
list	select		x_pagination_mode	Get the fax custom domains linked to the customer account
create	insert	domain		Create a custom domain for your fax services
delete	delete	id		Delete a custom domain of your fax services

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"}})
id	integer
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

Get this object properties

SELECT
id,
domain
FROM ovh.me.fax_custom_domains
WHERE id = '{{ id }}' -- required
;

list

Get the fax custom domains linked to the customer account

SELECT
id,
domain
FROM ovh.me.fax_custom_domains
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a custom domain for your fax services

INSERT INTO ovh.me.fax_custom_domains (
domain
)
SELECT 
'{{ domain }}' /* required */
RETURNING
id,
domain
;

Manifest

# Description fields are for documentation purposes
- name: fax_custom_domains
props:
  - name: domain
    value: "{{ domain }}"
    description: |
      The custom domain of your fax services

DELETE examples

delete

Delete a custom domain of your fax services

DELETE FROM ovh.me.fax_custom_domains
WHERE id = '{{ id }}' --required
;