ds_records

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

Overview

Name	ds_records
Type	Resource
Id	ovh.domain.ds_records

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	ID of the DNSSEC key
algorithm	integer	Algorithm number of the DNSSEC key (3, 5, 6, 7, 8, 10, 12, 13, 14, 15, 16)
flags	integer	Flag of the DNSSEC key (256, 257)
public_key	string	Public key (wire: publicKey)
status	string	Key status of the DNSSEC key (active, generated, published, removed, retired, revoked)
tag	integer	Tag of the DNSSEC key

list

Domain's DNSSEC Key

Name	Datatype	Description
id	integer	ID of the DNSSEC key
algorithm	integer	Algorithm number of the DNSSEC key (3, 5, 6, 7, 8, 10, 12, 13, 14, 15, 16)
flags	integer	Flag of the DNSSEC key (256, 257)
public_key	string	Public key (wire: publicKey)
status	string	Key status of the DNSSEC key (active, generated, published, removed, retired, revoked)
tag	integer	Tag of the DNSSEC key

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get details on this DS Record
list	select	service_name	flags, status, x_pagination_mode	List of domain's DS Records
create	insert	service_name, keys		Update DS records

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	Id
service_name	string	Service name (wire: serviceName)
flags	integer	Filter the value of flags property (=)
status	string	Filter the value of status property (=)
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 details on this DS Record

SELECT
id,
algorithm,
flags,
public_key,
status,
tag
FROM ovh.domain.ds_records
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List of domain's DS Records

SELECT
id,
algorithm,
flags,
public_key,
status,
tag
FROM ovh.domain.ds_records
WHERE service_name = '{{ service_name }}' -- required
AND flags = '{{ flags }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Update DS records

INSERT INTO ovh.domain.ds_records (
keys,
service_name
)
SELECT 
'{{ keys }}' /* required */,
'{{ service_name }}'
RETURNING
id,
can_accelerate,
can_cancel,
can_relaunch,
comment,
creation_date,
domain,
done_date,
function,
last_update,
status,
todo_date,
type
;

Manifest

# Description fields are for documentation purposes
- name: ds_records
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ds_records resource.
  - name: keys
    description: |
      New Keys
    value:
      - algorithm: {{ algorithm }}
        flags: {{ flags }}
        id: {{ id }}
        publicKey: "{{ publicKey }}"
        status: "{{ status }}"
        tag: {{ tag }}