Type Alias CreateServerRequest

CreateServerRequest: {
    adminPasswordEncryptionSshKeyId?: string;
    bootType?: BootType;
    commercialType: string;
    dynamicIpRequired?: boolean;
    enableIpv6?: boolean;
    image?: string;
    name?: string;
    organization?: string;
    placementGroup?: string;
    project?: string;
    publicIp?: string;
    publicIps?: string[];
    routedIpEnabled?: boolean;
    securityGroup?: string;
    tags?: string[];
    volumes?: Record<string, VolumeServerTemplate>;
    zone?: Zone;
}

Type declaration

  • OptionaladminPasswordEncryptionSshKeyId?: string

    The public_key value of this key is used to encrypt the admin password.

  • OptionalbootType?: BootType

    Boot type to use.

  • commercialType: string

    Define the Instance commercial type (i.e. GP1-S).

  • OptionaldynamicIpRequired?: boolean

    Define if a dynamic IPv4 is required for the Instance.

  • OptionalenableIpv6?: boolean

    Deprecated

    True if IPv6 is enabled on the server (deprecated and always False when routed_ip_enabled is True).

  • Optionalimage?: string

    Instance image ID or label.

  • Optionalname?: string

    Instance name.

  • Optionalorganization?: string

    Deprecated

    Instance Organization ID.

    One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.

  • OptionalplacementGroup?: string

    Placement group ID if Instance must be part of a placement group.

  • Optionalproject?: string

    Instance Project ID.

    One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.

  • OptionalpublicIp?: string

    Deprecated

    ID of the reserved IP to attach to the Instance.

  • OptionalpublicIps?: string[]

    A list of reserved IP IDs to attach to the Instance.

  • OptionalroutedIpEnabled?: boolean

    Deprecated

    If true, configure the Instance so it uses the new routed IP mode.

  • OptionalsecurityGroup?: string

    Security group ID.

  • Optionaltags?: string[]

    Instance tags.

  • Optionalvolumes?: Record<string, VolumeServerTemplate>

    Volumes attached to the server.

  • Optionalzone?: Zone

    Zone to target. If none is passed will use default zone from the config.

Settings