name_task_foas

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

Overview

Name	name_task_foas
Type	Resource
Id	ovh.domain_v2.name_task_foas

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the FOA
checksum	string	Computed hash of the current state of the FOA. Reflects the latest observed state.
current_state	object	Current state of the FOA (wire: currentState)
resource_status	string	Readiness of the FOA resource (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)

list

A Form of Authorization (FOA) attached to a domain name task. They are created by OVHcloud when a trade or an outgoing transfer is requested and validated by the involved contacts via email.

Name	Datatype	Description
id	string (uuid)	Unique identifier of the FOA
checksum	string	Computed hash of the current state of the FOA. Reflects the latest observed state.
current_state	object	Current state of the FOA (wire: currentState)
resource_status	string	Readiness of the FOA resource (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain_name, foa_id, task_id		Get a specific FOA (Form of Authorization) attached to a domain name task (Beta version)
list	select	domain_name, task_id	x_pagination_cursor, x_pagination_size	List the FOAs (Form of Authorization) attached to a domain name task. Trade operations may produce several FOAs (one per involved contact). Outgoing transfers produce a single FOA. (Beta version)
resend	exec	domainName, foaId, taskId		Resend the FOA (Form of Authorization) email to its recipient. Fails when the FOA has already been answered, when it is expired, or when the underlying task has already finished. (Beta version)

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"}})
domainName	string	Domain name
domain_name	string	Domain name (wire: domainName)
foaId	string (uuid)	Foa ID
foa_id	string (uuid)	Foa ID (wire: foaId)
taskId	string (uuid)	Task ID
task_id	string (uuid)	Task ID (wire: taskId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Get a specific FOA (Form of Authorization) attached to a domain name task (Beta version)

SELECT
id,
checksum,
current_state,
resource_status
FROM ovh.domain_v2.name_task_foas
WHERE domain_name = '{{ domain_name }}' -- required
AND foa_id = '{{ foa_id }}' -- required
AND task_id = '{{ task_id }}' -- required
;

list

List the FOAs (Form of Authorization) attached to a domain name task. Trade operations may produce several FOAs (one per involved contact). Outgoing transfers produce a single FOA. (Beta version)

SELECT
id,
checksum,
current_state,
resource_status
FROM ovh.domain_v2.name_task_foas
WHERE domain_name = '{{ domain_name }}' -- required
AND task_id = '{{ task_id }}' -- required
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

resend

Resend the FOA (Form of Authorization) email to its recipient. Fails when the FOA has already been answered, when it is expired, or when the underlying task has already finished. (Beta version)

EXEC ovh.domain_v2.name_task_foas.resend 
@domainName='{{ domainName }}' --required, 
@foaId='{{ foaId }}' --required, 
@taskId='{{ taskId }}' --required
;