@akamai/openapi-ts
    Preparing search index...

    Type Alias PutDomainData

    type PutDomainData = {
        body: {
            axfr_ips?: string[];
            description?: string | null;
            domain?: string;
            expire_sec?: number;
            group?: string | null;
            id?: number;
            master_ips?: string[];
            refresh_sec?: number;
            retry_sec?: number;
            soa_email?: string;
            status?: "disabled" | "active";
            tags?: string[];
            ttl_sec?: number;
            type?: "master" | "slave";
        };
        path: { domainId: number };
        query?: never;
        url: "domains/{domainId}";
    }
    Index

    Properties

    body path query? url

    Properties

    body

    body: {
        axfr_ips?: string[];
        description?: string | null;
        domain?: string;
        expire_sec?: number;
        group?: string | null;
        id?: number;
        master_ips?: string[];
        refresh_sec?: number;
        retry_sec?: number;
        soa_email?: string;
        status?: "disabled" | "active";
        tags?: string[];
        ttl_sec?: number;
        type?: "master" | "slave";
    }

    Domain

    A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode's nameservers in order for a domain in our system to be treated as authoritative.

    Type Declaration

    • Optionalaxfr_ips?: string[]

      The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.

      📘

      This is potentially dangerous, and should be set to an empty list unless you intend to use it.

    • Optionaldescription?: string | null

      A description for this domain. This is for display purposes only.

    • Optionaldomain?: string

      Filterable The domain this domain represents. domain labels cannot be longer than 63 characters and must conform to RFC1035. domains must be unique on Linode's platform, including across different Linode accounts; there cannot be two domains representing the same domain.

    • Optionalexpire_sec?: number

      The amount of time in seconds that may pass before this domain is no longer authoritative.

      • Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

      • Any other value is rounded up to the nearest valid value.

      • A value of 0 is equivalent to the default value of 1209600.

    • Optionalgroup?: string | null

      Filterable The group this domain belongs to. This is for display purposes only.

    • Optional Readonlyid?: number

      Read-only This domain's unique ID.

    • Optionalmaster_ips?: string[]

      The IP addresses representing the master DNS for this domain. At least one value is required for type slave domains. The total combined length of all data within this array cannot exceed 1000 characters.

    • Optionalrefresh_sec?: number

      The amount of time in seconds before this domain should be refreshed.

      • Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

      • Any other value is rounded up to the nearest valid value.

      • A value of 0 is equivalent to the default value of 14400.

    • Optionalretry_sec?: number

      The interval, in seconds, at which a failed refresh should be retried.

      • Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

      • Any other value is rounded up to the nearest valid value.

      • A value of 0 is equivalent to the default value of 14400.

    • Optionalsoa_email?: string

      Start of Authority email address. This is required for type master domains.

    • Optionalstatus?: "disabled" | "active"

      Used to control whether this domain is currently being rendered.

    • Optionaltags?: string[]

      Filterable An array of tags applied to this object. Tags are for organizational purposes only.

    • Optionalttl_sec?: number

      "Time to Live" - the amount of time in seconds that this domain's records may be cached by resolvers or other domain servers.

      • Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

      • Any other value is rounded up to the nearest valid value.

      • A value of 0 is equivalent to the default value of 86400.

    • Optionaltype?: "master" | "slave"

      Whether this domain represents the authoritative source of information for the domain it describes (master), or whether it is a read-only copy of a master (slave).

    path: { domainId: number }

    Type Declaration

    • domainId: number

      The ID of the Domain to access.

    query?: never
    url: "domains/{domainId}"

    Settings

    Member Visibility

    On This Page

    Properties