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

200

Return a list of all DNS records in a zone

application/json

Schema

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

]

Example (from schema)

{
  "dns_records": [
    {
      "id": "string",
      "name": "string",
      "full_name": "string",
      "ttl": 0,
      "type": "A",
      "priority": 0,
      "content": "string",
      "content_attributes": {
        "A": {
          "ip_address": "string"
        },
        "AAAA": {
          "ip_address": "string"
        },
        "ALIAS": {
          "hostname": "string"
        },
        "CAA": {
          "flag": "string",
          "tag": "string",
          "value": "string"
        },
        "CNAME": {
          "hostname": "string"
        },
        "IPS": {
          "ip_addresses": "string"
        },
        "MX": {
          "hostname": "string"
        },
        "NS": {
          "hostname": "string"
        },
        "PTR": {
          "hostname": "string"
        },
        "SOA": {},
        "SRV": {
          "weight": "string",
          "port": "string",
          "target": "string"
        },
        "SSHFP": {
          "algorithm": "string",
          "fingerprint_type": "string",
          "fingerprint": "string"
        },
        "TXT": {
          "content": "string"
        },
        "VirtualMachine": {
          "virtual_machine": "string"
        }
      }
    }
  ]
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

PermissionDeniedSchema

The authenticated identity is not permitted to perform this action

code PermissionDeniedEnum (string)

Possible values: [permission_denied]

description string

detail

object

details stringnullable

Additional information regarding the reason why permission was denied

Example (from schema)

{}

404

No DNS zone was found matching any of the criteria provided in the arguments

application/json

Schema

Schema

code DNSZoneNotFoundEnum (string)

Possible values: [dns_zone_not_found]

description string
detail object

Example (from schema)

{
  "code": "dns_zone_not_found",
  "description": "string",
  "detail": {}
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...