https://api.katapult.io/core/v1/dns_records/dns_record
| 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 |
|
|
dns_record_not_found
|
No DNS record 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_record
object
required
body
id
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
The DNS record that has been updated
{
"dns_record": "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.