API Reference

Katapult Core API

Resources & Endpoints

Update DNS record

Update a DNS record properties.

PATCH
https://api.katapult.io/core/v1/dns_records/{dns_record}

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

dns_record Required

DNS Record Lookup None

properties Required

DNSRecordArguments None

Potential Errors

The following errors may occur during this request.

Details HTTP status

dns_record_not_found

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

 404 Not Found

validation_error

A validation error occurred with the object that was being created/updated/deleted

 422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    dns_record: DNSRecord {
        id: String
        name: String?
        full_name: String
        ttl: Integer?
        type: DNS record types
        priority: Integer?
        content: String
        content_attributes: DNSRecordContentAttributes {
            A: RecordContentAttributesForA? {
                ip_address: String?
            }
            AAAA: RecordContentAttributesForAAAA? {
                ip_address: String?
            }
            ALIAS: RecordContentAttributesForALIAS? {
                hostname: String?
            }
            CAA: RecordContentAttributesForCAA? {
                flag: String?
                tag: String?
                value: String?
            }
            CNAME: RecordContentAttributesForCNAME? {
                hostname: String?
            }
            IPS: RecordContentAttributesForIPS? {
                ip_addresses: String?
            }
            MX: RecordContentAttributesForMX? {
                hostname: String?
            }
            NS: RecordContentAttributesForNS? {
                hostname: String?
            }
            PTR: RecordContentAttributesForPTR? {
                hostname: String?
            }
            SOA: RecordContentAttributesForSOA? {
            }
            SRV: RecordContentAttributesForSRV? {
                weight: String?
                port: String?
                target: String?
            }
            SSHFP: RecordContentAttributesForSSHFP? {
                algorithm: String?
                fingerprint_type: String?
                fingerprint: String?
            }
            TXT: RecordContentAttributesForTXT? {
                content: String?
            }
            VirtualMachine: RecordContentAttributesForVirtualMachine? {
                virtual_machine: String?
            }
        }
    }
}