https://api.katapult.io/core/v1/dns_zones/dns_zone/records
| Code | Error | When it happens |
|---|---|---|
|
|
missing_api_token
|
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer |
|
|
unauthorized_network_for_api_token
|
Network is not allowed to access the API with this API token |
|
|
invalid_api_token
|
The API token provided was not valid (it may not exist or have expired) |
|
|
token_owner_suspended
|
The user that owns the API token has been suspended |
|
|
invalid_capabilities_token
|
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key) |
|
|
scope_not_granted
|
The scope required for this endpoint has not been granted to the authenticating identity |
|
|
permission_denied
|
The authenticated identity is not permitted to perform this action |
|
|
dns_zone_not_found
|
No DNS zone was found matching any of the criteria provided in the arguments |
|
|
validation_error
|
A validation error occurred with the object that was being created/updated/deleted |
|
|
rate_limit_reached
|
You have reached the rate limit for this type of request |
|
|
service_unavailable
|
The service is currently unavailable, please try again later |
dns_zone
object
required
body
All 'dns_zone[]' params are mutually exclusive, only one can be provided.
id
string
name
string
properties
object
required
body
name
string
The name of the record
type
string
ttl
integer
priority
integer
content
object
A
object
ip_address
string
AAAA
object
ip_address
string
ALIAS
object
hostname
string
CAA
object
flag
string
tag
string
value
string
CNAME
object
hostname
string
HTTPRedirect
object
url
string
http_status
string
IPS
object
ip_addresses
string
MX
object
hostname
string
NS
object
hostname
string
PTR
object
hostname
string
SOA
object
SRV
object
weight
string
port
string
target
string
SSHFP
object
algorithm
string
fingerprint_type
string
fingerprint
string
TXT
object
content
string
VirtualMachine
object
virtual_machine
string
dns_record
object
id
string
name
string
full_name
string
ttl
integer
type
string
priority
integer
content
string
content_attributes
object
A
AAAA
ALIAS
CAA
CNAME
HTTPRedirect
IPS
MX
NS
PTR
SOA
object
SRV
SSHFP
TXT
VirtualMachine
{
"dns_record": {
"id": "string",
"name": "string",
"full_name": "string",
"ttl": 0,
"type": "A",
"priority": 0,
"content": "string",
"content_attributes": {
"A": "string",
"AAAA": "string",
"ALIAS": "string",
"CAA": "string",
"CNAME": "string",
"HTTPRedirect": "string",
"IPS": "string",
"MX": "string",
"NS": "string",
"PTR": "string",
"SOA": {},
"SRV": "string",
"SSHFP": "string",
"TXT": "string",
"VirtualMachine": "string"
}
}
}Sent to https://api.katapult.io/core/v1 as a bearer token and never to Krystal Documentation. It isn't stored anywhere, so paste it again on each endpoint page.
Pre-filled with the endpoint's shape — declared defaults where it has them, otherwise a placeholder per type. Edit it before executing; the Arguments tab documents every field.