platforms

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

Overview

Name	platforms
Type	Resource
Id	ovh.zimbra.platforms

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Resource identifier in UUID representation
checksum	string	Checksum hash in MD5 representation
current_state	object	Object representing platform (wire: currentState)
current_tasks	array	An array containing tasks responses pending on resource extends AsyncResourceBase object (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Current resource status (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Object representing platform (wire: targetSpec)

list

Response for get platform

Name	Datatype	Description
id	string (uuid)	Resource identifier in UUID representation
checksum	string	Checksum hash in MD5 representation
current_state	object	Object representing platform (wire: currentState)
current_tasks	array	An array containing tasks responses pending on resource extends AsyncResourceBase object (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Current resource status (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Object representing platform (wire: targetSpec)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	platform_id		Returns the name and description of the platform, its number of organizations, its storage quota per account and its account statistics per offer.
list	select		x_pagination_cursor, x_pagination_size, iam_tags, project_id	Returns the platforms of the account with their current state. Filter them by projectId.
update	update	platform_id, target_spec		Updates the name or description of the platform. When set, checksum must match the current checksum of the platform, otherwise the update is rejected.
diagnostic_domain	exec	platformId, domains	X-Pagination-Cursor, X-Pagination-Size	Checks the MX, SPF, DKIM and autodiscover DNS records of the domains listed in domains. Returns, for each domain, the status and errors of each test, the records found and the expected DNS configuration.
refresh_quota_usage	exec	platformId		Recomputes the quota usage (quota.used and quotaRefreshedAt) of every email account of the platform. The refresh runs asynchronously.

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"}})
platformId	string (uuid)	Platform ID
platform_id	string (uuid)	Platform ID (wire: platformId)
X-Pagination-Cursor	string	Pagination cursor
X-Pagination-Size	integer	Pagination size
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
project_id	string (uuid)	Identifier of the project (wire: projectId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the name and description of the platform, its number of organizations, its storage quota per account and its account statistics per offer.

SELECT
id,
checksum,
current_state,
current_tasks,
iam,
resource_status,
target_spec
FROM ovh.zimbra.platforms
WHERE platform_id = '{{ platform_id }}' -- required
;

list

Returns the platforms of the account with their current state. Filter them by projectId.

SELECT
id,
checksum,
current_state,
current_tasks,
iam,
resource_status,
target_spec
FROM ovh.zimbra.platforms
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND iam_tags = '{{ iam_tags }}'
AND project_id = '{{ project_id }}'
;

UPDATE examples

update

Updates the name or description of the platform. When set, checksum must match the current checksum of the platform, otherwise the update is rejected.

UPDATE ovh.zimbra.platforms
SET 
checksum = '{{ checksum }}',
target_spec = '{{ target_spec }}'
WHERE 
platform_id = '{{ platform_id }}' --required
AND target_spec = '{{ target_spec }}' --required
RETURNING
id,
checksum,
current_state,
current_tasks,
resource_status,
target_spec;

Lifecycle Methods

EXEC variables use wire (API) names.

diagnostic_domain

Checks the MX, SPF, DKIM and autodiscover DNS records of the domains listed in domains. Returns, for each domain, the status and errors of each test, the records found and the expected DNS configuration.

EXEC ovh.zimbra.platforms.diagnostic_domain 
@platformId='{{ platformId }}' --required, 
@X-Pagination-Cursor='{{ X-Pagination-Cursor }}', 
@X-Pagination-Size='{{ X-Pagination-Size }}' 
@@json=
'{
"domains": "{{ domains }}"
}'
;

refresh_quota_usage

Recomputes the quota usage (quota.used and quotaRefreshedAt) of every email account of the platform. The refresh runs asynchronously.

EXEC ovh.zimbra.platforms.refresh_quota_usage 
@platformId='{{ platformId }}' --required
;