delegations
Creates, updates, deletes, gets or lists a delegations resource.
Overview​
| Name | delegations |
| Type | Resource |
| Id | ovh.ip.delegations |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
target | string | NS target for delegation |
Your reverse delegations on IPv6 subnet
| Name | Datatype | Description |
|---|---|---|
target | string | NS target for delegation |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | ip, target | Get a reverse delegation. Returns the name server that this delegation points the reverse zone of the IPv6 block to. | |
list | select | ip | x_pagination_mode | List reverse delegations. Returns the name servers the reverse zone of the IPv6 block is delegated to. Reverse delegation applies to IPv6 blocks only. |
create | insert | ip, target | Create a reverse delegation. Delegates the reverse zone of the IPv6 block to the given name server, and returns the new delegation. | |
delete | delete | ip, target | Delete a reverse delegation. Removes this name server from the reverse delegation of the IPv6 block. The call returns no content. |
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"}}) |
ip | string (ip-block) | |
target | string | NS target for delegation |
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 a reverse delegation. Returns the name server that this delegation points the reverse zone of the IPv6 block to.
SELECT
target
FROM ovh.ip.delegations
WHERE ip = '{{ ip }}' -- required
AND target = '{{ target }}' -- required
;
List reverse delegations. Returns the name servers the reverse zone of the IPv6 block is delegated to. Reverse delegation applies to IPv6 blocks only.
SELECT
target
FROM ovh.ip.delegations
WHERE ip = '{{ ip }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;
INSERT examples​
- create
- Manifest
Create a reverse delegation. Delegates the reverse zone of the IPv6 block to the given name server, and returns the new delegation.
INSERT INTO ovh.ip.delegations (
target,
ip
)
SELECT
'{{ target }}' /* required */,
'{{ ip }}'
RETURNING
target
;
# Description fields are for documentation purposes
- name: delegations
props:
- name: ip
value: "{{ ip }}"
description: Required parameter for the delegations resource.
- name: target
value: "{{ target }}"
description: |
Target for reverse delegation on IPv6
DELETE examples​
- delete
Delete a reverse delegation. Removes this name server from the reverse delegation of the IPv6 block. The call returns no content.
DELETE FROM ovh.ip.delegations
WHERE ip = '{{ ip }}' --required
AND target = '{{ target }}' --required
;