API Reference

Dennis API

Resources & Endpoints

Update zone

PATCH
https://dennis.localhost/api/v1/zones/{zone}

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

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

zone

Zone Lookup None

properties

ZonePropertiesSet None

Potential Errors

The following errors may occur during this request.

Details HTTP status

validation_error

A validation error occurred when saving the object

 422 Unprocessable Entity

zone_not_found

No zone could be found using the given arguments

 404 Not Found

Returned Object

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

{
    zone: Zone {
        id: Integer
        name: String
        group: Group {
            id: Integer
            name: String
            external_reference: String?
            created_at: Unix Timestamp
            updated_at: Unix Timestamp
            nameservers: [ Nameserver {
                id: Integer
                name: String
                server: Integer
                available: Boolean
                created_at: Unix Timestamp
                updated_at: Unix Timestamp
            } ]
        }
        created_at: Unix Timestamp
        updated_at: Unix Timestamp
        serial: Integer
        default_ttl: Integer
        external_reference: String?
        verified: Boolean
        nameservers_verified_at: Unix Timestamp?
        nameservers_checked_at: Unix Timestamp?
        always_verified: Boolean
        nameservers_verified: Boolean
        reverse_dns: Boolean
        stale_verification: Boolean
    }
}