LiveDNS API

TSIG keys ¶

https://api.sandbox.gandi.net/v5/livedns/axfr/tsig

get List existing TSIG keys ¶

Note that the list of TSIG keys is relative to the optional sharing_id passed as argument (default to user_id)

Query String

Optional
- sharing_id ⁠string
  Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

post Creates a new TSIG key ¶

Warning the optional sharing_id parameter (as query string) will determine the one of the new key

Query String

Optional
- sharing_id ⁠string
  Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Manage TSIG keys ¶

https://api.sandbox.gandi.net/v5/livedns/axfr/tsig/{id}

get GET information about a TSIG key ¶

URI Parameters

- id ⁠string

Query String

Optional
- sharing_id ⁠string
  Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Software configuration information ¶

https://api.sandbox.gandi.net/v5/livedns/axfr/tsig/{id}/config/{software}

get Software configuration information ¶

List accepted record types ¶

https://api.sandbox.gandi.net/v5/livedns/dns/rrtypes

get List record types ¶

Domains ¶

https://api.sandbox.gandi.net/v5/livedns/domains

get List of domains handled by LiveDNS ¶

Warning: The current behavior will only list domains directly under your Organization. You can use the sharing_id query string filter to list domains associated with another Organization

Query String

Optional
- page ⁠integer
  Default: 1
  Minimum: 1
  Which result page to retrieve. If the number is greater than the last page, an empty list is returned.
- per_page ⁠integer
  Minimum: 1
  How many items to display per page.
- sharing_id ⁠string
  Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

post Add a new domain to LiveDNS ¶

This will add a new domain to the LiveDNS database. Please note that you need sufficient permissions to manage this domain at Gandi to perform this action

Query String

Optional
- sharing_id ⁠string
  Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Required
- fqdn ⁠string
  The domain name
Optional
- zone ⁠object
  With the following properties:
  Optional
  - items ⁠array
    Of items of type:
    object
    With the following properties:
    Required
    rrset_name ⁠string
    Name of the record
    rrset_type ⁠string
    One of: "A", "AAAA", "ALIAS", "CAA", "CDS", "CNAME", "DNAME", "DS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SPF", "SRV", "SSHFP", "TLSA", "TXT", "WKS"
    rrset_values ⁠array[ string ]
    A list of values for this record
    Optional
    rrset_ttl ⁠integer
    Minimum: 300
    Maximum: 2592000
    The time in seconds that DNS resolvers should cache this record
  - ttl ⁠integer
    Minimum: 300
    Maximum: 2592000
    The TTL of the SOA record. Note that this is not a default TTL that will be used for the records in the zone.
Example:
```
{
  "fqdn": "example.org"
}
```
Example:
```
{
  "fqdn": "example.org",
  "zone": {
    "items": [
      {
        "rrset_name": "@",
        "rrset_type": "A",
        "rrset_values": [
          "192.0.2.1"
        ]
      }
    ]
  }
}
```

Domain information ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}

get Show domain's properties ¶

URI Parameters

- fqdn ⁠string
  Domain name.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

patch Update domain's properties ¶

Only automatic_snapshots can be currently be changed

URI Parameters

- fqdn ⁠string
  Domain name.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Optional
- automatic_snapshots ⁠boolean
  Enable or disable the automatic creation of new snapshots when records are changed. Disabling this will improve performance of modifications for domains with a large number of records
Example:
```
{
  "automatic_snapshots": true
}
```

Zone transfer slaves ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}/axfr/slaves

get List current slave's IP addresses ¶

Zone slaves' IP ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}/axfr/slaves/{ip}

put Add a new slave IP address to a domain ¶

delete Remove a slave IP address from a domain ¶

TSIG keys associated with a domain ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}/axfr/tsig

get List TSIG keys associated with a domain ¶

URI Parameters

- fqdn ⁠string
  Domain name.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Manage TSIG key association ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}/axfr/tsig/{id}

put Associate a domain with a TSIG key ¶

URI Parameters

- fqdn ⁠string
  Domain name.
- id ⁠string
  TSIG identifier

Query String

Optional
- sharing_id ⁠string
  Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

delete Remove association between a domain and a TSIG key ¶

DNSSEC keys ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}/keys

get List DNSSEC keys of a domain ¶

URI Parameters

- fqdn ⁠string
  Domain name.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

post Creates a new DNSSEC Key ¶

The key is automatically handled by LiveDNS, you can only provide the flags value

URI Parameters

- fqdn ⁠string
  Domain name.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Required
- flags ⁠integer
  One of: 256, 257
  Key flags (ZSK=256, KSK=257)
Example:
```
{
  "flags": 256
}
```
Example:
```
{
  "flags": 257
}
```

Manipulate a specific DNSSEC key ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}/keys/{id}

get Get information about a key ¶

URI Parameters

- fqdn ⁠string
  Domain name.
- id ⁠string
  Key identifier

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

patch Undelete a key ¶

This allows you to restore a previously deleted key

URI Parameters

- fqdn ⁠string
  Domain name.
- id ⁠string
  Key identifier

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Required
- deleted ⁠boolean
  One of: false
Example:
```
{
  "deleted": false
}
```

delete Deletes a key ¶

Domain's nameserver information ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}/nameservers

get Retrieve this domain's nameservers ¶

This route returns the list of nameservers that this domain is using according to LiveDNS' systems.

Either there are no NS records on @ and the 3 hashed nameservers are returned (ns-{123}-{abc}.gandi.net)
Or some NS records exist on @ and it will return those

URI Parameters

- fqdn ⁠string
  Domain name.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Domain's records ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}/records

get List records associated with a domain ¶

URI Parameters

- fqdn ⁠string
  Domain name.

Query String

Optional
- page ⁠integer
  Default: 1
  Minimum: 1
  Which result page to retrieve. If the number is greater than the last page, an empty list is returned.
- per_page ⁠integer
  Minimum: 1
  How many items to display per page.
- rrset_type ⁠string
  One of: "A", "AAAA", "ALIAS", "CAA", "CDS", "CNAME", "DNAME", "DS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SPF", "SRV", "SSHFP", "TLSA", "TXT", "WKS"
  Filter records by type
- sort_by ⁠string
  Default: "rrset_name"

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key
Optional
- Accept ⁠string
  When passed text/plain value, this route will return The contents of the zone as it would appear in a standard master zone file (see RFC1035)

post Creates a new record ¶

Creates a new record. Will raise a 409 conflict if the record already exists, and return a 200 OK if the record already exists with the same values

URI Parameters

- fqdn ⁠string
  Domain name.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Required
- rrset_name ⁠string
  Name of the record
- rrset_type ⁠string
  One of: "A", "AAAA", "ALIAS", "CAA", "CDS", "CNAME", "DNAME", "DS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SPF", "SRV", "SSHFP", "TLSA", "TXT", "WKS"
- rrset_values ⁠array[ string ]
  A list of values for this record
Optional
- rrset_ttl ⁠integer
  Minimum: 300
  Maximum: 2592000
  The time in seconds that DNS resolvers should cache this record
Example:
```
{
  "rrset_name": "www",
  "rrset_type": "A",
  "rrset_values": [
    "192.0.2.1"
  ]
}
```
Example:
```
{
  "rrset_name": "www",
  "rrset_type": "AAAA",
  "rrset_values": [
    "2001:db8::1",
    "2001:db8::2"
  ]
}
```
Example:
```
{
  "rrset_name": "@",
  "rrset_type": "TXT",
  "rrset_values": [
    "\"v=spf1 include:_mailcust.gandi.net ?all\""
  ]
}
```

put Replace the whole zone with new records ¶

URI Parameters

- fqdn ⁠string
  Domain name.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Required
- items ⁠array
  Of items of type:
  - object
    With the following properties:
    Required
    rrset_name ⁠string
    Name of the record
    rrset_type ⁠string
    One of: "A", "AAAA", "ALIAS", "CAA", "CDS", "CNAME", "DNAME", "DS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SPF", "SRV", "SSHFP", "TLSA", "TXT", "WKS"
    rrset_values ⁠array[ string ]
    A list of values for this record
    Optional
    rrset_ttl ⁠integer
    Minimum: 300
    Maximum: 2592000
    The time in seconds that DNS resolvers should cache this record
Optional
- remove_apex_ns ⁠boolean
  Default: false
  The default behavior is to keep the NS records on @ if they already exist and no NS where provided in the body. Setting remove_apex_ns to true will remove the NS records in all cases. (Note that having no NS record is a valid configuration, the default ones will be used by the current nameservers)
Example:
```
{
  "items": [
    {
      "rrset_name": "www",
      "rrset_type": "A",
      "rrset_values": [
        "192.0.2.1"
      ]
    },
    {
      "rrset_name": "www",
      "rrset_type": "AAAA",
      "rrset_values": [
        "2001:db8::1",
        "2001:db8::2"
      ]
    },
    {
      "rrset_name": "@",
      "rrset_type": "TXT",
      "rrset_values": [
        "\"v=spf1 include:_mailcust.gandi.net ?all\""
      ]
    }
  ]
}
```

text/plain
⁠string
The contents of the zone as it would appear in a standard master zone file (see RFC1035)

delete Delete all records ¶

Domain's records, by name ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}/records/{rrset_name}

get Zone records list {rrset_name} linked to a domain ¶

URI Parameters

- fqdn ⁠string
  Domain name.
- rrset_name ⁠string
  Name of the record.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

post Create a new record whose name is defined by the path ¶

Creates a new record. Will raise a 409 conflict if the record already exists, and return a 200 OK if the record already exists with the same values

URI Parameters

- fqdn ⁠string
  Domain name.
- rrset_name ⁠string
  Name of the record.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Required
- rrset_type ⁠string
  One of: "A", "AAAA", "ALIAS", "CAA", "CDS", "CNAME", "DNAME", "DS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SPF", "SRV", "SSHFP", "TLSA", "TXT", "WKS"
- rrset_values ⁠array[ string ]
  A list of values for this record
Optional
- rrset_ttl ⁠integer
  Minimum: 300
  Maximum: 2592000
  The time in seconds that DNS resolvers should cache this record
Example:
```
{
  "rrset_type": "A",
  "rrset_values": [
    "192.0.2.1"
  ]
}
```
Example:
```
{
  "rrset_type": "AAAA",
  "rrset_values": [
    "2001:db8::1",
    "2001:db8::2"
  ]
}
```
Example:
```
{
  "rrset_type": "TXT",
  "rrset_values": [
    "some-text-value"
  ]
}
```

put Replace all records named {rrset_name} ¶

Replaces all records for a given name with the provided list.

URI Parameters

- fqdn ⁠string
  Domain name.
- rrset_name ⁠string
  Name of the record.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Required
- items ⁠array
  Of items of type:
  - object
    With the following properties:
    Required
    rrset_type ⁠string
    One of: "A", "AAAA", "ALIAS", "CAA", "CDS", "CNAME", "DNAME", "DS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SPF", "SRV", "SSHFP", "TLSA", "TXT", "WKS"
    rrset_values ⁠array[ string ]
    A list of values for this record
    Optional
    rrset_ttl ⁠integer
    Minimum: 300
    Maximum: 2592000
    The time in seconds that DNS resolvers should cache this record
Example:
```
{
  "items": [
    {
      "rrset_type": "A",
      "rrset_values": [
        "192.0.2.1"
      ]
    },
    {
      "rrset_type": "AAAA",
      "rrset_values": [
        "2001:db8::1",
        "2001:db8::2"
      ]
    },
    {
      "rrset_type": "TXT",
      "rrset_values": [
        "some-text-value"
      ]
    }
  ]
}
```

delete Delete all records named {rrset_name} ¶

Single domain's record, by name and type ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}/records/{rrset_name}/{rrset_type}

get Get a single single record with its name and type ¶

Will return a 404 if the name/type pair does not exist

URI Parameters

- fqdn ⁠string
  Domain name.
- rrset_name ⁠string
  Name of the record.
- rrset_type ⁠string
  One of: "A", "AAAA", "ALIAS", "CAA", "CDS", "CNAME", "DNAME", "DS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SPF", "SRV", "SSHFP", "TLSA", "TXT", "WKS"
  Type of the record

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

patch Update a record (RRset)in the zone records linked to a domain ¶

Add or remove some values of a Resource Record set (RRset).

URI Parameters

- fqdn ⁠string
  Domain name.
- rrset_name ⁠string
  Name of the record.
- rrset_type ⁠string
  One of: "A", "AAAA", "ALIAS", "CAA", "CDS", "CNAME", "DNAME", "DS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SPF", "SRV", "SSHFP", "TLSA", "TXT", "WKS"
  Type of the record

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Optional
- add_rrset_values ⁠array
  Default: []
  Resource record set values to add in a DNS zone.
  Of items of type:
  - string
    Maximum length: 16384
    Pattern: ^[\x20-\x7E]+$
- remove_rrset_values ⁠array
  Default: []
  Resource record set values to remove from a DNS zone.
  Of items of type:
  - string
    Maximum length: 16384
    Pattern: ^[\x20-\x7E]+$
- rrset_ttl ⁠integer
  Minimum: 300
  Maximum: 2592000
  The time in seconds that DNS resolvers should cache this record.
Example:
```
{
  "add_rrset_values": [
    "www.example.org."
  ],
  "rrset_ttl": 11000
}
```

post Create a new record whose name and type are defined by the path ¶

Creates a new record. Will raise a 409 conflict if the record already exists, and return a 200 OK if the record already exists with the same values

URI Parameters

- fqdn ⁠string
  Domain name.
- rrset_name ⁠string
  Name of the record.
- rrset_type ⁠string
  One of: "A", "AAAA", "ALIAS", "CAA", "CDS", "CNAME", "DNAME", "DS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SPF", "SRV", "SSHFP", "TLSA", "TXT", "WKS"
  Type of the record

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Required
- rrset_values ⁠array[ string ]
  A list of values for this record
Optional
- rrset_ttl ⁠integer
  Minimum: 300
  Maximum: 2592000
  The time in seconds that DNS resolvers should cache this record
Example:
```
{
  "rrset_values": [
    "www.example.org"
  ],
  "rrset_ttl": 320
}
```

put Overwrites a single record with {rrset_name} and {rrset_type} ¶

URI Parameters

- fqdn ⁠string
  Domain name.
- rrset_name ⁠string
  Name of the record.
- rrset_type ⁠string
  One of: "A", "AAAA", "ALIAS", "CAA", "CDS", "CNAME", "DNAME", "DS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SPF", "SRV", "SSHFP", "TLSA", "TXT", "WKS"
  Type of the record

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Required
- rrset_values ⁠array[ string ]
  A list of values for this record
Optional
- rrset_ttl ⁠integer
  Minimum: 300
  Maximum: 2592000
  The time in seconds that DNS resolvers should cache this record
Example:
```
{
  "rrset_values": [
    "www.example.org"
  ],
  "rrset_ttl": 320
}
```

delete Delete record with {rrset_name} and {rrset_type} ¶

Snapshots of a domain ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}/snapshots

get List available snapshots ¶

URI Parameters

- fqdn ⁠string
  Domain name.

Query String

Optional
- automatic ⁠boolean
  Only list automatic/non-automatic snapshots
- page ⁠integer
  Default: 1
  Minimum: 1
  Which result page to retrieve. If the number is greater than the last page, an empty list is returned.
- per_page ⁠integer
  Minimum: 1
  How many items to display per page.
- sort_by ⁠string
  One of: "date_created", "-date_created"
  Default: "date_created"
  Allow sorting result by creation date or reverse creation date

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

post Creates a new snapshot ¶

Creates a new snapshot with the current zone content

URI Parameters

- fqdn ⁠string
  Domain name.

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Optional
- name ⁠string
  Optional name for the snapshot. When not specified, the name will be today's date with an incremental number added to it
Example:
```
{
  "name": "My new snapshot"
}
```

Snapshots operations ¶

https://api.sandbox.gandi.net/v5/livedns/domains/{fqdn}/snapshots/{id}

get Snapshot details ¶

URI Parameters

- fqdn ⁠string
  Domain name.
- id ⁠string
  Snapshot identifier

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key
Optional
- Accept ⁠string
  When passed text/plain value, this route will return The contents of the snapshot as it would appear in a standard master zone file (see RFC1035)

patch Update a snapshot ¶

Only the name can be changed at the moment

URI Parameters

- fqdn ⁠string
  Domain name.
- id ⁠string
  Snapshot identifier

Headers

Required
- Authorization ⁠string
  The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
  Example: Bearer pat_abc-123
  Example: Apikey your-api-key

Body

application/json
⁠object
With the following properties:
Required
- name ⁠string
  New snapshot name
Example:
```
{
  "name": "Snapshot by SRE on 2022-02-06"
}
```

delete Delete a snapshot ¶

Generic nameservers ¶

https://api.sandbox.gandi.net/v5/livedns/nameservers/{fqdn}

TSIG keys ¶

get List existing TSIG keys ¶

Query String

Optional

Headers

Required

200

Body

application/json

403

Body

application/json

401

Body

application/json

403

Body

application/json

Http Authorization Scheme

Headers

Required

post Creates a new TSIG key ¶

Query String

Optional

Headers

Required

201

Headers

Body

application/json

403

Body

application/json

401

Body

application/json

403

Body

application/json

Http Authorization Scheme

Headers

Required

Manage TSIG keys ¶

get GET information about a TSIG key ¶

URI Parameters

Query String

Optional

Headers

Required

200

Body

application/json

403

Body

application/json

401

Body

application/json

403

Body

application/json

Http Authorization Scheme

Headers

Required

Software configuration information ¶

get Software configuration information ¶

URI Parameters

Query String

Optional

Headers

Required

200

Body

application/json

403

Body

application/json

401

Body