LiveDNS API

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

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • href ⁠string
      URL of the key
    • id ⁠string
      Identifier of the key
    • key_name ⁠string
      Unique "name" for the key, based on its id
    • secret ⁠string
      shared secret of the key
  Example:

  [
    {
      "href": "https://api.test/v5/livedns/axfr/tsig/2e21af2b-3d85-4ad9-b51b-698c242a13e5",
      "id": "2e21af2b-3d85-4ad9-b51b-698c242a13e5",
      "key_name": "2e21af2b-3d85-4ad9-b51b-698c242a13e5.gandi.net",
      "secret": "aiG5ji3Necheisho"
    }
  ]

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠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

Headers

• • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • href ⁠string
    URL of the key
  • id ⁠string
    Identifier of the key
  • key_name ⁠string
    Unique "name" for the key, based on its id
  Example:

  {
    "href": "https://api.test/v5/livedns/axfr/tsig/2e21af2b-3d85-4ad9-b51b-698c242a13e5",
    "id": "2e21af2b-3d85-4ad9-b51b-698c242a13e5",
    "key_name": "2e21af2b-3d85-4ad9-b51b-698c242a13e5.gandi.net"
  }

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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

Body

• application/json

  ⁠object

  With the following properties:

  • config_samples ⁠object
    URL samples for each of those software

    With the following properties:

    • bind ⁠string
    • knot ⁠string
    • nsd ⁠string
    • powerdns ⁠string
  • href ⁠string
    URL of the key
  • id ⁠string
    Identifier of the key
  • key_name ⁠string
    Unique "name" for the key, based on its id
  • secret ⁠string
    shared secret of the key
  Example:

  {
    "href": "https://api.test/v5/v5/livedns/axfr/tsig/2e21af2b-3d85-4ad9-b51b-698c242a13e5",
    "id": "2e21af2b-3d85-4ad9-b51b-698c242a13e5",
    "key_name": "2e21af2b-3d85-4ad9-b51b-698c242a13e5.gandi.net",
    "secret": "aiG5ji3Necheisho",
    "config_samples": {
      "bind": "https://api.test/v5/v5/livedns/axfr/tsig/id-tsig-001/config/bind",
      "knot": "https://api.test/v5/v5/livedns/axfr/tsig/id-tsig-001/config/knot",
      "nsd": "https://api.test/v5/v5/livedns/axfr/tsig/id-tsig-001/config/nsd",
      "powerdns": "hhttps://api.test/v5/v5/livedns/axfr/tsig/id-tsig-001/config/"
    }
  }

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • id ⁠string
  • software ⁠string

    One of: "bind", "knot", "nsd", "powerdns"

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

  ⁠string
  String representation of the configuration for that key

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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

  ⁠array[ string ]

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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

Headers

• • Filtered-Count ⁠integer
    Number of items returned by the API call.
  • Total-Count ⁠integer
    Total number of items.

  Optional

  • Link ⁠string
    Links to next and last page.

Body

• application/json

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • domain_href ⁠string
    • domain_records_href ⁠string
    • fqdn ⁠string
  Example:

  [
    {
      "fqdn": "example.org",
      "domain_href": "https://api.test/v5/livedns/domains/example.org",
      "domain_records_href": "https://api.test/v5/livedns/domains/example.org/records"
    },
    {
      "fqdn": "example.net",
      "domain_href": "https://api.test/v5/livedns/domains/example.net",
      "domain_records_href": "https://api.test/v5/livedns/domains/example.net/records"
    }
  ]

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠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

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", "HTTPS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "SVCB", "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"
          ]
        }
      ]
    }
  }

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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:

  • automatic_snapshots ⁠boolean
    True if new snapshots are automatically created when a modification is made to this domain's records
  • domain_href ⁠string
  • domain_keys_href ⁠string
  • domain_records_href ⁠string
  • fqdn ⁠string
  Example:

  {
    "fqdn": "example.com",
    "domain_href": "https://api.test/v5/livedns/domains/example.com",
    "domain_records_href": "https://api.test/v5/livedns/domains/example.com/records",
    "domain_keys_href": "https://api.test/v5/livedns/domains/example.com/keys",
    "automatic_snapshots": true
  }

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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
  }

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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

  ⁠array[ string ]
  A simple list of IP addresses
  Example:

  [
    "192.0.2.1",
    "2001:0db8:0000:0000:0000:0000:0000:0001"
  ]

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • fqdn ⁠string
    Domain name.
  • ip ⁠string
    IP address (v4 or v6)

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

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • fqdn ⁠string
    Domain name.
  • ip ⁠string
    IP address (v4 or v6)

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:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • href ⁠string
      URL of the key
    • id ⁠string
      Identifier of the key
    • key_name ⁠string
      Unique "name" for the key, based on its id
  Example:

  [
    {
      "id": "9c87db4b-5624-4547-a006-8ac5c9343c6a",
      "key_name": "9c87db4b-5624-4547-a006-8ac5c9343c6a.gandi.net",
      "href": "https://api.test/v5/livedns/domains/example.com/axfr/tsig/9c87db4b-5624-4547-a006-8ac5c9343c6a"
    }
  ]

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • algorithm ⁠integer
      Algorithm number (see IANA for full list)
    • algorithm_name ⁠string
      Algorithm as "human readable" (eg: ECDSAP256SHA256)
    • deleted ⁠boolean
      Is this key deleted? (no longer active)
    • ds ⁠string
      DS record as RFC1035 line (absolute)
    • flags ⁠integer

      One of: 256, 257

      Key flags
    • fqdn ⁠string
      associated domain name
    • id ⁠string
      Identifier of the key
    • key_href ⁠string
      URL of the key
    • status ⁠string
      Current status of the key
  Example:

  [
    {
      "algorithm": 13,
      "algorithm_name": "ECDSAP256SHA256",
      "deleted": false,
      "ds": "example.com. 3600 IN DS 50651 13 2 01cc01ee6b2750339245aba473340f589356b889a360380e80a11a36824dfb0d",
      "flags": 257,
      "fqdn": "example.com",
      "key_href": "https://api.test/v5/livedns//domains/example.com/keys/key-001",
      "status": "active",
      "id": "key-001"
    }
  ]

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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
  }

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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:

  • algorithm ⁠integer
    Algorithm number (see IANA for full list)
  • algorithm_name ⁠string
    Algorithm as "human readable" (eg: ECDSAP256SHA256)
  • deleted ⁠boolean
    Is this key deleted? (no longer active)
  • ds ⁠string
    DS record as RFC1035 line (absolute)
  • fingerprint ⁠string
    The digest of the key
  • flags ⁠integer

    One of: 256, 257

    Key flags
  • fqdn ⁠string
    associated domain name
  • id ⁠string
    Identifier of the key
  • key_href ⁠string
    URL of the key
  • public_key ⁠string
    Public part of the key
  • status ⁠string
    Current status of the key
  • tag ⁠integer
    Extracted tag number of the key
  Example:

  {
    "algorithm": 13,
    "algorithm_name": "ECDSAP256SHA256",
    "deleted": false,
    "ds": "example.com. 3600 IN DS 50651 13 2 01cc01ee6b2750339245aba473340f589356b889a360380e80a11a36824dfb0d",
    "fingerprint": "ed5317ae0f6726cc694332d2d636e72f7ec616b96475a0cf3dd9801d0d64f619",
    "flags": 257,
    "fqdn": "example.com",
    "id": "key-001",
    "key_href": "https://api.test/v5/livedns//domains/example.com/keys/key-001",
    "public_key": "rtvYYzLKH/O9IlWUyP5/eMNymj1svKZhK9PVcih019T0KyJ99eyfL6VeOVys22+JQ0Xua7b/0B0RNFfEBsIImg==",
    "status": "active",
    "tag": 33695
  }

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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
  }

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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

  ⁠array[ string ]
  List of nameservers
  Example:

  [
    "ns-154-a.gandi.net",
    "ns-232-b.gandi.net",
    "ns-109-c.gandi.net"
  ]

  Example:

  [
    "ns1.example.net",
    "ns2.example.net"
  ]

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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", "HTTPS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "SVCB", "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)

Headers

• • Filtered-Count ⁠integer
    Number of items returned by the API call.
  • Total-Count ⁠integer
    Total number of items.

  Optional

  • Link ⁠string
    Links to next and last page.

Body

• application/json

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • rrset_href ⁠string
      URL for the record
    • rrset_name ⁠string
      Name of the record
    • rrset_type ⁠string

      One of: "A", "AAAA", "ALIAS", "CAA", "CDS", "CNAME", "DNAME", "DS", "HTTPS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "SVCB", "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": "@",
      "rrset_ttl": 10800,
      "rrset_type": "A",
      "rrset_values": [
        "192.0.2.1"
      ],
      "rrset_href": "https://api.test/v5/livedns/domains/example.com/records/%40/A"
    },
    {
      "rrset_name": "www",
      "rrset_ttl": 10800,
      "rrset_type": "CNAME",
      "rrset_values": [
        "www.example.net."
      ],
      "rrset_href": "https://api.test/v5/livedns/domains/example.com/records/www/CNAME"
    }
  ]

• text/plain

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

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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", "HTTPS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "SVCB", "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\""
    ]
  }

Headers

• • Location ⁠string
    URL of record

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Headers

• • Location ⁠string
    URL of record

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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", "HTTPS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "SVCB", "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)

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • rrset_href ⁠string
      URL for the record
    • rrset_name ⁠string
      Name of the record
    • rrset_type ⁠string

      One of: "A", "AAAA", "ALIAS", "CAA", "CDS", "CNAME", "DNAME", "DS", "HTTPS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "SVCB", "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"
      ],
      "rrset_ttl": 320,
      "rrset_href": "https://api.test/v5/livedns/domains/example.com/records/www/A"
    },
    {
      "rrset_name": "www",
      "rrset_type": "TXT",
      "rrset_values": [
        "some-text-value"
      ],
      "rrset_ttl": 320,
      "rrset_href": "https://api.test/v5/livedns/domains/example.com/records/www/TXT"
    }
  ]

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

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", "HTTPS", "KEY", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "SVCB", "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"
    ]
  }

Headers

• • Location ⁠string
    URL of record

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Headers

• • Location ⁠string
    URL of record

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

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