Skip to main content

List DNS records

GET 

/dns_zones/dns_zone/records

Return a list of all DNS records in a zone

Scopes

  • dns
  • dns:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

    dns_zone[id] string

    All 'dns_zone[]' params are mutually exclusive, only one can be provided.

    dns_zone[name] string

    All 'dns_zone[]' params are mutually exclusive, only one can be provided.

Responses

Return a list of all DNS records in a zone

Schema

    dns_records

    object[]

    required

    The DNS record for the provided zone

  • Array [

  • id string
    name stringnullable
    full_name string
    ttl integernullable
    type DNSRecordTypesEnum (string)

    Possible values: [A, AAAA, ALIAS, CAA, CNAME, IPS, MX, NS, PTR, SOA, SRV, SSHFP, TXT, VirtualMachine]

    priority integernullable
    content string

    content_attributes

    object

    A

    object

    nullable

    ip_address stringnullable

    AAAA

    object

    nullable

    ip_address stringnullable

    ALIAS

    object

    nullable

    hostname stringnullable

    CAA

    object

    nullable

    flag stringnullable
    tag stringnullable
    value stringnullable

    CNAME

    object

    nullable

    hostname stringnullable

    IPS

    object

    nullable

    ip_addresses stringnullable

    MX

    object

    nullable

    hostname stringnullable

    NS

    object

    nullable

    hostname stringnullable

    PTR

    object

    nullable

    hostname stringnullable
    SOA objectnullable

    SRV

    object

    nullable

    weight stringnullable
    port stringnullable
    target stringnullable

    SSHFP

    object

    nullable

    algorithm stringnullable
    fingerprint_type stringnullable
    fingerprint stringnullable

    TXT

    object

    nullable

    content stringnullable

    VirtualMachine

    object

    nullable

    virtual_machine stringnullable
  • ]

Loading...