Type Alias UpdateServerRequest

UpdateServerRequest: {
    adminPasswordEncryptionSshKeyId?: string;
    bootType?: BootType;
    commercialType?: string;
    dynamicIpRequired?: boolean;
    enableIpv6?: boolean;
    name?: string;
    placementGroup?: string | null;
    privateNics?: string[];
    protected?: boolean;
    publicIps?: string[];
    routedIpEnabled?: boolean;
    securityGroup?: SecurityGroupTemplate;
    serverId: 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. When set to an empty string, reset this value and admin_password_encrypted_value to an empty string so a new password may be generated.

  • OptionalbootType?: BootType
  • OptionalcommercialType?: string

    Warning: This field has some restrictions:

    • Cannot be changed if the Instance is not in stopped state.
    • Cannot be changed if the Instance is in a placement group.
    • Cannot be changed from/to a Windows offer to/from a Linux offer.
    • Local storage requirements of the target commercial_types must be fulfilled (i.e. if an Instance has 80GB of local storage, it can be changed into a GP1-XS, which has a maximum of 150GB, but it cannot be changed into a DEV1-S, which has only 20GB).
  • OptionaldynamicIpRequired?: boolean
  • OptionalenableIpv6?: boolean

    Deprecated

  • Optionalname?: string

    Name of the Instance.

  • OptionalplacementGroup?: string | null

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

  • OptionalprivateNics?: string[]

    Instance private NICs.

  • Optionalprotected?: boolean
  • OptionalpublicIps?: string[]

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

  • OptionalroutedIpEnabled?: boolean

    Deprecated

    True to configure the instance so it uses the new routed IP mode (once this is set to True you cannot set it back to False).

  • OptionalsecurityGroup?: SecurityGroupTemplate
  • serverId: string

    UUID of the Instance.

  • Optionaltags?: string[]

    Tags of the Instance.

  • Optionalvolumes?: Record<string, VolumeServerTemplate>
  • Optionalzone?: Zone

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

Settings