Class API

constructor

• new API(client: Client): Instance.v1.API

• Parameters

  • client: Client

  Returns Instance.v1.API

Static ReadonlyLOCALITIES

applyBlockMigration

• applyBlockMigration(
      request: Readonly<ApplyBlockMigrationRequest>,
  ): Promise<void>

• Migrate a volume and/or snapshots to SBS (Scaleway Block Storage). To be used, the call to this endpoint must be preceded by a call to the Get a volume or snapshot's migration plan endpoint. To migrate all resources mentioned in the migration plan, the validation_key returned in the plan must be provided.

  Parameters

  • request: Readonly<ApplyBlockMigrationRequest>

    The request ApplyBlockMigrationRequest

  Returns Promise<void>

attachServerVolume

• attachServerVolume(
      request: Readonly<AttachServerVolumeRequest>,
  ): Promise<AttachServerVolumeResponse>

• Parameters

  • request: Readonly<AttachServerVolumeRequest>

  Returns Promise<AttachServerVolumeResponse>

attachVolume

• attachVolume(
      request: Readonly<AttachVolumeRequest>,
  ): Promise<AttachVolumeResponse>

• Attaches a volume to a server.

  Parameters

  • request: Readonly<AttachVolumeRequest>

    The request AttachVolumeRequest

  Returns Promise<AttachVolumeResponse>

  A Promise of AttachVolumeResponse

checkBlockMigrationOrganizationQuotas

• checkBlockMigrationOrganizationQuotas(
      request?: Readonly<CheckBlockMigrationOrganizationQuotasRequest>,
  ): Promise<void>

• Parameters

  • request: Readonly<CheckBlockMigrationOrganizationQuotasRequest> = {}

  Returns Promise<void>

createImage

• createImage(request: Readonly<CreateImageRequest>): Promise<CreateImageResponse>

• Create an Instance image. Create an Instance image from the specified snapshot ID.

  Parameters

  • request: Readonly<CreateImageRequest>

    The request CreateImageRequest

  Returns Promise<CreateImageResponse>

  A Promise of CreateImageResponse

createIp

• createIp(
      request?: Readonly<Instance.v1.CreateIpRequest>,
  ): Promise<CreateIpResponse>

• Reserve a flexible IP. Reserve a flexible IP and attach it to the specified Instance.

  Parameters

  • request: Readonly<Instance.v1.CreateIpRequest> = {}

    The request CreateIpRequest

  Returns Promise<CreateIpResponse>

  A Promise of CreateIpResponse

createPlacementGroup

• createPlacementGroup(
      request?: Readonly<CreatePlacementGroupRequest>,
  ): Promise<CreatePlacementGroupResponse>

• Create a placement group. Create a new placement group in a specified Availability Zone.

  Parameters

  • request: Readonly<CreatePlacementGroupRequest> = {}

    The request CreatePlacementGroupRequest

  Returns Promise<CreatePlacementGroupResponse>

  A Promise of CreatePlacementGroupResponse

createPrivateNIC

• createPrivateNIC(
      request: Readonly<CreatePrivateNICRequest>,
  ): Promise<CreatePrivateNICResponse>

• Create a private NIC connecting an Instance to a Private Network.

  Parameters

  • request: Readonly<CreatePrivateNICRequest>

    The request CreatePrivateNICRequest

  Returns Promise<CreatePrivateNICResponse>

  A Promise of CreatePrivateNICResponse

createSecurityGroup

• createSecurityGroup(
      request: Readonly<CreateSecurityGroupRequest>,
  ): Promise<CreateSecurityGroupResponse>

• Create a security group. Create a security group with a specified name and description.

  Parameters

  • request: Readonly<CreateSecurityGroupRequest>

    The request CreateSecurityGroupRequest

  Returns Promise<CreateSecurityGroupResponse>

  A Promise of CreateSecurityGroupResponse

createSecurityGroupRule

• createSecurityGroupRule(
      request: Readonly<CreateSecurityGroupRuleRequest>,
  ): Promise<CreateSecurityGroupRuleResponse>

• Create rule. Create a rule in the specified security group ID.

  Parameters

  • request: Readonly<CreateSecurityGroupRuleRequest>

    The request CreateSecurityGroupRuleRequest

  Returns Promise<CreateSecurityGroupRuleResponse>

  A Promise of CreateSecurityGroupRuleResponse

createServer

• createServer(
      request: Readonly<Instance.v1.CreateServerRequest>,
  ): Promise<CreateServerResponse>

• Creates a server.

  Parameters

  • request: Readonly<Instance.v1.CreateServerRequest>

    The request CreateServerRequest

  Returns Promise<CreateServerResponse>

  A Promise of CreateServerResponse

createSnapshot

• createSnapshot(
      request?: Readonly<Instance.v1.CreateSnapshotRequest>,
  ): Promise<CreateSnapshotResponse>

• Create a snapshot from a specified volume or from a QCOW2 file. Create a snapshot from a specified volume or from a QCOW2 file in a specified Availability Zone.

  Parameters

  • request: Readonly<Instance.v1.CreateSnapshotRequest> = {}

    The request CreateSnapshotRequest

  Returns Promise<CreateSnapshotResponse>

  A Promise of CreateSnapshotResponse

createVolume

• createVolume(
      request?: Readonly<Instance.v1.CreateVolumeRequest>,
  ): Promise<CreateVolumeResponse>

• Create a volume. Create a volume of a specified type in an Availability Zone.

  Parameters

  • request: Readonly<Instance.v1.CreateVolumeRequest> = {}

    The request CreateVolumeRequest

  Returns Promise<CreateVolumeResponse>

  A Promise of CreateVolumeResponse

deleteImage

• deleteImage(request: Readonly<Instance.v1.DeleteImageRequest>): Promise<void>

• Delete an Instance image. Delete the image with the specified ID.

  Parameters

  • request: Readonly<Instance.v1.DeleteImageRequest>

    The request DeleteImageRequest

  Returns Promise<void>

deleteIp

• deleteIp(request: Readonly<DeleteIpRequest>): Promise<void>

• Delete a flexible IP. Delete the IP with the specified ID.

  Parameters

  • request: Readonly<DeleteIpRequest>

    The request DeleteIpRequest

  Returns Promise<void>

deletePlacementGroup

• deletePlacementGroup(
      request: Readonly<DeletePlacementGroupRequest>,
  ): Promise<void>

• Delete the specified placement group.

  Parameters

  • request: Readonly<DeletePlacementGroupRequest>

    The request DeletePlacementGroupRequest

  Returns Promise<void>

deletePrivateNIC

• deletePrivateNIC(request: Readonly<DeletePrivateNICRequest>): Promise<void>

• Delete a private NIC.

  Parameters

  • request: Readonly<DeletePrivateNICRequest>

    The request DeletePrivateNICRequest

  Returns Promise<void>

deleteSecurityGroup

• deleteSecurityGroup(
      request: Readonly<DeleteSecurityGroupRequest>,
  ): Promise<void>

• Delete a security group. Delete a security group with the specified ID.

  Parameters

  • request: Readonly<DeleteSecurityGroupRequest>

    The request DeleteSecurityGroupRequest

  Returns Promise<void>

deleteSecurityGroupRule

• deleteSecurityGroupRule(
      request: Readonly<DeleteSecurityGroupRuleRequest>,
  ): Promise<void>

• Delete rule. Delete a security group rule with the specified ID.

  Parameters

  • request: Readonly<DeleteSecurityGroupRuleRequest>

    The request DeleteSecurityGroupRuleRequest

  Returns Promise<void>

deleteServer

• deleteServer(request: Readonly<Instance.v1.DeleteServerRequest>): Promise<void>

• Delete an Instance. Delete the Instance with the specified ID.

  Parameters

  • request: Readonly<Instance.v1.DeleteServerRequest>

    The request DeleteServerRequest

  Returns Promise<void>

deleteServerUserData

• deleteServerUserData(
      request: Readonly<DeleteServerUserDataRequest>,
  ): Promise<void>

• Delete user data. Delete the specified key from an Instance's user data.

  Parameters

  • request: Readonly<DeleteServerUserDataRequest>

    The request DeleteServerUserDataRequest

  Returns Promise<void>

deleteSnapshot

• deleteSnapshot(
      request: Readonly<Instance.v1.DeleteSnapshotRequest>,
  ): Promise<void>

• Delete a snapshot. Delete the snapshot with the specified ID.

  Parameters

  • request: Readonly<Instance.v1.DeleteSnapshotRequest>

    The request DeleteSnapshotRequest

  Returns Promise<void>

deleteVolume

• deleteVolume(request: Readonly<Instance.v1.DeleteVolumeRequest>): Promise<void>

• Delete a volume. Delete the volume with the specified ID.

  Parameters

  • request: Readonly<Instance.v1.DeleteVolumeRequest>

    The request DeleteVolumeRequest

  Returns Promise<void>

detachServerVolume

• detachServerVolume(
      request: Readonly<DetachServerVolumeRequest>,
  ): Promise<DetachServerVolumeResponse>

• Parameters

  • request: Readonly<DetachServerVolumeRequest>

  Returns Promise<DetachServerVolumeResponse>

detachVolume

• detachVolume(request: DetachVolumeRequest): Promise<DetachVolumeResponse>

• Detaches a volume from a server.

  Parameters

  • request: DetachVolumeRequest

    The request DetachVolumeRequest

  Returns Promise<DetachVolumeResponse>

  A Promise of DetachVolumeResponse

exportSnapshot

• exportSnapshot(
      request: Readonly<ExportSnapshotRequest>,
  ): Promise<ExportSnapshotResponse>

• Export a snapshot. Export a snapshot to a specified Object Storage bucket in the same region.

  Parameters

  • request: Readonly<ExportSnapshotRequest>

    The request ExportSnapshotRequest

  Returns Promise<ExportSnapshotResponse>

  A Promise of ExportSnapshotResponse

getDashboard

• getDashboard(
      request?: Readonly<GetDashboardRequest>,
  ): Promise<GetDashboardResponse>

• Parameters

  • request: Readonly<GetDashboardRequest> = {}

  Returns Promise<GetDashboardResponse>

getImage

• getImage(
      request: Readonly<Instance.v1.GetImageRequest>,
  ): Promise<GetImageResponse>

• Get an Instance image. Get details of an image with the specified ID.

  Parameters

  • request: Readonly<Instance.v1.GetImageRequest>

    The request GetImageRequest

  Returns Promise<GetImageResponse>

  A Promise of GetImageResponse

getIp

• getIp(request: Readonly<Instance.v1.GetIpRequest>): Promise<GetIpResponse>

• Get a flexible IP. Get details of an IP with the specified ID or address.

  Parameters

  • request: Readonly<Instance.v1.GetIpRequest>

    The request GetIpRequest

  Returns Promise<GetIpResponse>

  A Promise of GetIpResponse

getPlacementGroup

• getPlacementGroup(
      request: Readonly<GetPlacementGroupRequest>,
  ): Promise<GetPlacementGroupResponse>

• Get a placement group. Get the specified placement group.

  Parameters

  • request: Readonly<GetPlacementGroupRequest>

    The request GetPlacementGroupRequest

  Returns Promise<GetPlacementGroupResponse>

  A Promise of GetPlacementGroupResponse

getPlacementGroupServers

• getPlacementGroupServers(
      request: Readonly<GetPlacementGroupServersRequest>,
  ): Promise<GetPlacementGroupServersResponse>

• Get placement group servers. Get all Instances belonging to the specified placement group.

  Parameters

  • request: Readonly<GetPlacementGroupServersRequest>

    The request GetPlacementGroupServersRequest

  Returns Promise<GetPlacementGroupServersResponse>

  A Promise of GetPlacementGroupServersResponse

getPrivateNIC

• getPrivateNIC(
      request: Readonly<GetPrivateNICRequest>,
  ): Promise<GetPrivateNICResponse>

• Get a private NIC. Get private NIC properties.

  Parameters

  • request: Readonly<GetPrivateNICRequest>

    The request GetPrivateNICRequest

  Returns Promise<GetPrivateNICResponse>

  A Promise of GetPrivateNICResponse

getSecurityGroup

• getSecurityGroup(
      request: Readonly<GetSecurityGroupRequest>,
  ): Promise<GetSecurityGroupResponse>

• Get a security group. Get the details of a security group with the specified ID.

  Parameters

  • request: Readonly<GetSecurityGroupRequest>

    The request GetSecurityGroupRequest

  Returns Promise<GetSecurityGroupResponse>

  A Promise of GetSecurityGroupResponse

getSecurityGroupRule

• getSecurityGroupRule(
      request: Readonly<GetSecurityGroupRuleRequest>,
  ): Promise<GetSecurityGroupRuleResponse>

• Get rule. Get details of a security group rule with the specified ID.

  Parameters

  • request: Readonly<GetSecurityGroupRuleRequest>

    The request GetSecurityGroupRuleRequest

  Returns Promise<GetSecurityGroupRuleResponse>

  A Promise of GetSecurityGroupRuleResponse

getServer

• getServer(
      request: Readonly<Instance.v1.GetServerRequest>,
  ): Promise<GetServerResponse>

• Get an Instance. Get the details of a specified Instance.

  Parameters

  • request: Readonly<Instance.v1.GetServerRequest>

    The request GetServerRequest

  Returns Promise<GetServerResponse>

  A Promise of GetServerResponse

getServerTypesAvailability

• getServerTypesAvailability(
      request?: Readonly<GetServerTypesAvailabilityRequest>,
  ): Promise<GetServerTypesAvailabilityResponse>

• Get availability. Get availability for all Instance types.

  Parameters

  • request: Readonly<GetServerTypesAvailabilityRequest> = {}

    The request GetServerTypesAvailabilityRequest

  Returns Promise<GetServerTypesAvailabilityResponse>

  A Promise of GetServerTypesAvailabilityResponse

getServerUserData

• getServerUserData(request: Readonly<GetServerUserDataRequest>): Promise<string>

• Get the content of a user data on a server for the given key.

  Parameters

  • request: Readonly<GetServerUserDataRequest>

    The request GetServerUserDataRequest

  Returns Promise<string>

  The content of the key

getSnapshot

• getSnapshot(
      request: Readonly<Instance.v1.GetSnapshotRequest>,
  ): Promise<GetSnapshotResponse>

• Get a snapshot. Get details of a snapshot with the specified ID.

  Parameters

  • request: Readonly<Instance.v1.GetSnapshotRequest>

    The request GetSnapshotRequest

  Returns Promise<GetSnapshotResponse>

  A Promise of GetSnapshotResponse

getVolume

• getVolume(
      request: Readonly<Instance.v1.GetVolumeRequest>,
  ): Promise<GetVolumeResponse>

• Get a volume. Get details of a volume with the specified ID.

  Parameters

  • request: Readonly<Instance.v1.GetVolumeRequest>

    The request GetVolumeRequest

  Returns Promise<GetVolumeResponse>

  A Promise of GetVolumeResponse

listDefaultSecurityGroupRules

• listDefaultSecurityGroupRules(
      request?: Readonly<ListDefaultSecurityGroupRulesRequest>,
  ): Promise<ListSecurityGroupRulesResponse>

• Get default rules. Lists the default rules applied to all the security groups.

  Parameters

  • request: Readonly<ListDefaultSecurityGroupRulesRequest> = {}

    The request ListDefaultSecurityGroupRulesRequest

  Returns Promise<ListSecurityGroupRulesResponse>

  A Promise of ListSecurityGroupRulesResponse

listImages

• listImages(
      request?: Readonly<Instance.v1.ListImagesRequest>,
  ): Promise<Instance.v1.ListImagesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Instance.v1.Image[], void, void>;
      all: () => Promise<Instance.v1.Image[]>;
  }

• List Instance images. List all existing Instance images.

  Parameters

  • request: Readonly<Instance.v1.ListImagesRequest> = {}

    The request ListImagesRequest

  Returns Promise<Instance.v1.ListImagesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Instance.v1.Image[], void, void>;
      all: () => Promise<Instance.v1.Image[]>;
  }

  A Promise of ListImagesResponse

listIps

• listIps(
      request?: Readonly<ListIpsRequest>,
  ): Promise<Instance.v1.ListIpsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Instance.v1.Ip[], void, void>;
      all: () => Promise<Instance.v1.Ip[]>;
  }

• List all flexible IPs. List all flexible IPs in a specified zone.

  Parameters

  • request: Readonly<ListIpsRequest> = {}

    The request ListIpsRequest

  Returns Promise<Instance.v1.ListIpsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Instance.v1.Ip[], void, void>;
      all: () => Promise<Instance.v1.Ip[]>;
  }

  A Promise of ListIpsResponse

listPlacementGroups

• listPlacementGroups(
      request?: Readonly<ListPlacementGroupsRequest>,
  ): Promise<ListPlacementGroupsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<PlacementGroup[], void, void>;
      all: () => Promise<PlacementGroup[]>;
  }

• List placement groups. List all placement groups in a specified Availability Zone.

  Parameters

  • request: Readonly<ListPlacementGroupsRequest> = {}

    The request ListPlacementGroupsRequest

  Returns Promise<ListPlacementGroupsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<PlacementGroup[], void, void>;
      all: () => Promise<PlacementGroup[]>;
  }

  A Promise of ListPlacementGroupsResponse

listPrivateNICs

• listPrivateNICs(
      request: Readonly<ListPrivateNICsRequest>,
  ): Promise<ListPrivateNICsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<PrivateNIC[], void, void>;
      all: () => Promise<PrivateNIC[]>;
  }

• List all private NICs. List all private NICs of a specified Instance.

  Parameters

  • request: Readonly<ListPrivateNICsRequest>

    The request ListPrivateNICsRequest

  Returns Promise<ListPrivateNICsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<PrivateNIC[], void, void>;
      all: () => Promise<PrivateNIC[]>;
  }

  A Promise of ListPrivateNICsResponse

listSecurityGroupRules

• listSecurityGroupRules(
      request: Readonly<ListSecurityGroupRulesRequest>,
  ): Promise<ListSecurityGroupRulesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<SecurityGroupRule[], void, void>;
      all: () => Promise<SecurityGroupRule[]>;
  }

• List rules. List the rules of the a specified security group ID.

  Parameters

  • request: Readonly<ListSecurityGroupRulesRequest>

    The request ListSecurityGroupRulesRequest

  Returns Promise<ListSecurityGroupRulesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<SecurityGroupRule[], void, void>;
      all: () => Promise<SecurityGroupRule[]>;
  }

  A Promise of ListSecurityGroupRulesResponse

listSecurityGroups

• listSecurityGroups(
      request?: Readonly<ListSecurityGroupsRequest>,
  ): Promise<ListSecurityGroupsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<SecurityGroup[], void, void>;
      all: () => Promise<SecurityGroup[]>;
  }

• List security groups. List all existing security groups.

  Parameters

  • request: Readonly<ListSecurityGroupsRequest> = {}

    The request ListSecurityGroupsRequest

  Returns Promise<ListSecurityGroupsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<SecurityGroup[], void, void>;
      all: () => Promise<SecurityGroup[]>;
  }

  A Promise of ListSecurityGroupsResponse

listServerActions

• listServerActions(
      request: Readonly<ListServerActionsRequest>,
  ): Promise<ListServerActionsResponse>

• List Instance actions. List all actions (e.g. power on, power off, reboot) that can currently be performed on an Instance.

  Parameters

  • request: Readonly<ListServerActionsRequest>

    The request ListServerActionsRequest

  Returns Promise<ListServerActionsResponse>

  A Promise of ListServerActionsResponse

listServers

• listServers(
      request?: Readonly<Instance.v1.ListServersRequest>,
  ): Promise<Instance.v1.ListServersResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Instance.v1.Server[],
          void,
          void,
      >;
      all: () => Promise<Instance.v1.Server[]>;
  }

• List all Instances. List all Instances in a specified Availability Zone, e.g. fr-par-1.

  Parameters

  • request: Readonly<Instance.v1.ListServersRequest> = {}

    The request ListServersRequest

  Returns Promise<Instance.v1.ListServersResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Instance.v1.Server[],
          void,
          void,
      >;
      all: () => Promise<Instance.v1.Server[]>;
  }

  A Promise of ListServersResponse

listServersTypes

• listServersTypes(
      request?: Readonly<ListServersTypesRequest>,
  ): Promise<ListServersTypesResponse>

• List Instance types. List available Instance types and their technical details.

  Parameters

  • request: Readonly<ListServersTypesRequest> = {}

    The request ListServersTypesRequest

  Returns Promise<ListServersTypesResponse>

  A Promise of ListServersTypesResponse

listServerUserData

• listServerUserData(
      request: Readonly<ListServerUserDataRequest>,
  ): Promise<ListServerUserDataResponse>

• List user data. List all user data keys registered on a specified Instance.

  Parameters

  • request: Readonly<ListServerUserDataRequest>

    The request ListServerUserDataRequest

  Returns Promise<ListServerUserDataResponse>

  A Promise of ListServerUserDataResponse

listSnapshots

• listSnapshots(
      request?: Readonly<Instance.v1.ListSnapshotsRequest>,
  ): Promise<Instance.v1.ListSnapshotsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Instance.v1.Snapshot[],
          void,
          void,
      >;
      all: () => Promise<Instance.v1.Snapshot[]>;
  }

• List snapshots. List all snapshots of an Organization in a specified Availability Zone.

  Parameters

  • request: Readonly<Instance.v1.ListSnapshotsRequest> = {}

    The request ListSnapshotsRequest

  Returns Promise<Instance.v1.ListSnapshotsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Instance.v1.Snapshot[],
          void,
          void,
      >;
      all: () => Promise<Instance.v1.Snapshot[]>;
  }

  A Promise of ListSnapshotsResponse

listVolumes

• listVolumes(
      request?: Readonly<Instance.v1.ListVolumesRequest>,
  ): Promise<Instance.v1.ListVolumesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Instance.v1.Volume[],
          void,
          void,
      >;
      all: () => Promise<Instance.v1.Volume[]>;
  }

• List volumes. List volumes in the specified Availability Zone. You can filter the output by volume type.

  Parameters

  • request: Readonly<Instance.v1.ListVolumesRequest> = {}

    The request ListVolumesRequest

  Returns Promise<Instance.v1.ListVolumesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Instance.v1.Volume[],
          void,
          void,
      >;
      all: () => Promise<Instance.v1.Volume[]>;
  }

  A Promise of ListVolumesResponse

listVolumesTypes

• listVolumesTypes(
      request?: Readonly<ListVolumesTypesRequest>,
  ): Promise<ListVolumesTypesResponse>

• List volume types. List all volume types and their technical details.

  Parameters

  • request: Readonly<ListVolumesTypesRequest> = {}

    The request ListVolumesTypesRequest

  Returns Promise<ListVolumesTypesResponse>

  A Promise of ListVolumesTypesResponse

planBlockMigration

• planBlockMigration(
      request?: Readonly<PlanBlockMigrationRequest>,
  ): Promise<MigrationPlan>

• Get a volume or snapshot's migration plan. Given a volume or snapshot, returns the migration plan but does not perform the actual migration. To perform the migration, you have to call the Migrate a volume and/or snapshots to SBS endpoint afterward. The endpoint returns the resources that should be migrated together:

  • The volume and any snapshots created from the volume, if the call was made to plan a volume migration.
  • The base volume of the snapshot (if the volume is not deleted) and its related snapshots, if the call was made to plan a snapshot migration. The endpoint also returns the validation_key, which must be provided to the Migrate a volume and/or snapshots to SBS endpoint to confirm that all resources listed in the plan should be migrated.

  Parameters

  • request: Readonly<PlanBlockMigrationRequest> = {}

    The request PlanBlockMigrationRequest

  Returns Promise<MigrationPlan>

  A Promise of MigrationPlan

serverAction

• serverAction(
      request: Readonly<ServerActionRequest>,
  ): Promise<ServerActionResponse>

• Perform action. Perform an action on an Instance. Available actions are: poweron: Start a stopped Instance. poweroff: Fully stop the Instance and release the hypervisor slot. stop_in_place: Stop the Instance, but keep the slot on the hypervisor. reboot: Stop the instance and restart it. backup: Create an image with all the volumes of an Instance. terminate: Delete the Instance along with its attached volumes, except for SBS volumes. enable_routed_ip: Migrate the Instance to the new network stack.

  The terminate action will result in the deletion of l_ssd, b_ssd and scratch volumes types, sbs_volume volumes type will only be detached. If you want to preserve your volumes, you should detach them before the Instance deletion or terminate action.

  The backup action can be done with: No volumes key in the body: an image is created with snapshots of all the server volumes, except for the scratch volumes types. volumes key in the body with a dictionary as value, in this dictionary volumes UUID as keys and empty dictionaries as values : an image is created with the snapshots of the volumes in volumes key. scratch volumes types can't be shapshotted.

  Parameters

  • request: Readonly<ServerActionRequest>

    The request ServerActionRequest

  Returns Promise<ServerActionResponse>

  A Promise of ServerActionResponse

serverActionAndWait

• serverActionAndWait(
      request: ServerActionRequest,
      options?: Readonly<WaitForOptions<Instance.v1.Server>>,
  ): Promise<Instance.v1.Server>

• Starts an action and wait for the server to be in the correct "terminal state" expected by this action.

  Parameters

  • request: ServerActionRequest

    The request ServerActionRequest
  • Optionaloptions: Readonly<WaitForOptions<Instance.v1.Server>>

  Returns Promise<Instance.v1.Server>

  A Promise of Server

setPlacementGroup

• setPlacementGroup(
      request: Readonly<SetPlacementGroupRequest>,
  ): Promise<SetPlacementGroupResponse>

• Set placement group. Set all parameters of the specified placement group.

  Parameters

  • request: Readonly<SetPlacementGroupRequest>

    The request SetPlacementGroupRequest

  Returns Promise<SetPlacementGroupResponse>

  A Promise of SetPlacementGroupResponse

setPlacementGroupServers

• setPlacementGroupServers(
      request: Readonly<SetPlacementGroupServersRequest>,
  ): Promise<SetPlacementGroupServersResponse>

• Set placement group servers. Set all Instances belonging to the specified placement group.

  Parameters

  • request: Readonly<SetPlacementGroupServersRequest>

    The request SetPlacementGroupServersRequest

  Returns Promise<SetPlacementGroupServersResponse>

  A Promise of SetPlacementGroupServersResponse

setSecurityGroupRules

• setSecurityGroupRules(
      request: Readonly<SetSecurityGroupRulesRequest>,
  ): Promise<SetSecurityGroupRulesResponse>

• Update all the rules of a security group. Replaces the existing rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request.

  Parameters

  • request: Readonly<SetSecurityGroupRulesRequest>

    The request SetSecurityGroupRulesRequest

  Returns Promise<SetSecurityGroupRulesResponse>

  A Promise of SetSecurityGroupRulesResponse

setServerUserData

• setServerUserData(request: Readonly<SetServerUserDataRequest>): Promise<void>

• Sets the content of a user data on a server for the given key.

  Parameters

  • request: Readonly<SetServerUserDataRequest>

    The request SetServerUserDataRequest

  Returns Promise<void>

updateImage

• updateImage(
      request: Readonly<Instance.v1.UpdateImageRequest>,
  ): Promise<UpdateImageResponse>

• Update image. Update the properties of an image.

  Parameters

  • request: Readonly<Instance.v1.UpdateImageRequest>

    The request UpdateImageRequest

  Returns Promise<UpdateImageResponse>

  A Promise of UpdateImageResponse

updateIp

• updateIp(
      request: Readonly<Instance.v1.UpdateIpRequest>,
  ): Promise<UpdateIpResponse>

• Update a flexible IP. Update a flexible IP in the specified zone with the specified ID.

  Parameters

  • request: Readonly<Instance.v1.UpdateIpRequest>

    The request UpdateIpRequest

  Returns Promise<UpdateIpResponse>

  A Promise of UpdateIpResponse

updatePlacementGroup

• updatePlacementGroup(
      request: Readonly<UpdatePlacementGroupRequest>,
  ): Promise<UpdatePlacementGroupResponse>

• Update a placement group. Update one or more parameter of the specified placement group.

  Parameters

  • request: Readonly<UpdatePlacementGroupRequest>

    The request UpdatePlacementGroupRequest

  Returns Promise<UpdatePlacementGroupResponse>

  A Promise of UpdatePlacementGroupResponse

updatePlacementGroupServers

• updatePlacementGroupServers(
      request: Readonly<UpdatePlacementGroupServersRequest>,
  ): Promise<UpdatePlacementGroupServersResponse>

• Update placement group servers. Update all Instances belonging to the specified placement group.

  Parameters

  • request: Readonly<UpdatePlacementGroupServersRequest>

    The request UpdatePlacementGroupServersRequest

  Returns Promise<UpdatePlacementGroupServersResponse>

  A Promise of UpdatePlacementGroupServersResponse

updatePrivateNIC

• updatePrivateNIC(
      request: Readonly<UpdatePrivateNICRequest>,
  ): Promise<PrivateNIC>

• Update a private NIC. Update one or more parameter(s) of a specified private NIC.

  Parameters

  • request: Readonly<UpdatePrivateNICRequest>

    The request UpdatePrivateNICRequest

  Returns Promise<PrivateNIC>

  A Promise of PrivateNIC

updateSecurityGroup

• updateSecurityGroup(
      request: Readonly<UpdateSecurityGroupRequest>,
  ): Promise<UpdateSecurityGroupResponse>

• Update a security group. Update the properties of security group.

  Parameters

  • request: Readonly<UpdateSecurityGroupRequest>

    The request UpdateSecurityGroupRequest

  Returns Promise<UpdateSecurityGroupResponse>

  A Promise of UpdateSecurityGroupResponse

updateSecurityGroupRule

• updateSecurityGroupRule(
      request: Readonly<UpdateSecurityGroupRuleRequest>,
  ): Promise<UpdateSecurityGroupRuleResponse>

• Update security group rule. Update the properties of a rule from a specified security group.

  Parameters

  • request: Readonly<UpdateSecurityGroupRuleRequest>

    The request UpdateSecurityGroupRuleRequest

  Returns Promise<UpdateSecurityGroupRuleResponse>

  A Promise of UpdateSecurityGroupRuleResponse

updateServer

• updateServer(
      request: Instance.v1.UpdateServerRequest,
  ): Promise<UpdateServerResponse>

• Updates a server.

  Parameters

  • request: Instance.v1.UpdateServerRequest

    The request UpdateServerRequest

  Returns Promise<UpdateServerResponse>

  A Promise of UpdateServerResponse

updateSnapshot

• updateSnapshot(
      request: Readonly<Instance.v1.UpdateSnapshotRequest>,
  ): Promise<UpdateSnapshotResponse>

• Update a snapshot. Update the properties of a snapshot.

  Parameters

  • request: Readonly<Instance.v1.UpdateSnapshotRequest>

    The request UpdateSnapshotRequest

  Returns Promise<UpdateSnapshotResponse>

  A Promise of UpdateSnapshotResponse

updateVolume

• updateVolume(
      request: Readonly<Instance.v1.UpdateVolumeRequest>,
  ): Promise<UpdateVolumeResponse>

• Update a volume. Replace the name and/or size properties of a volume specified by its ID, with the specified value(s). Any volume name can be changed, however only b_ssd volumes can currently be increased in size.

  Parameters

  • request: Readonly<Instance.v1.UpdateVolumeRequest>

    The request UpdateVolumeRequest

  Returns Promise<UpdateVolumeResponse>

  A Promise of UpdateVolumeResponse

waitForImage

• waitForImage(
      request: Readonly<Instance.v1.GetImageRequest>,
      options?: Readonly<WaitForOptions<Instance.v1.Image>>,
  ): Promise<Instance.v1.Image>

• Waits for Image to be in a final state.

  Parameters

  • request: Readonly<Instance.v1.GetImageRequest>

    The request GetImageRequest
  • Optionaloptions: Readonly<WaitForOptions<Instance.v1.Image>>

    The waiting options

  Returns Promise<Instance.v1.Image>

  A Promise of Image

waitForPrivateNIC

• waitForPrivateNIC(
      request: Readonly<GetPrivateNICRequest>,
      options?: Readonly<WaitForOptions<PrivateNIC>>,
  ): Promise<PrivateNIC>

• Waits for PrivateNIC to be in a final state.

  Parameters

  • request: Readonly<GetPrivateNICRequest>

    The request GetPrivateNICRequest
  • Optionaloptions: Readonly<WaitForOptions<PrivateNIC>>

    The waiting options

  Returns Promise<PrivateNIC>

  A Promise of PrivateNIC

waitForServer

• waitForServer(
      request: Readonly<Instance.v1.GetServerRequest>,
      options?: Readonly<WaitForOptions<Instance.v1.Server>>,
  ): Promise<Instance.v1.Server>

• Waits for Server to be in a final state.

  Parameters

  • request: Readonly<Instance.v1.GetServerRequest>

    The request GetServerRequest
  • Optionaloptions: Readonly<WaitForOptions<Instance.v1.Server>>

    The waiting options

  Returns Promise<Instance.v1.Server>

  A Promise of Server

waitForSnapshot

• waitForSnapshot(
      request: Readonly<Instance.v1.GetSnapshotRequest>,
      options?: Readonly<WaitForOptions<Instance.v1.Snapshot>>,
  ): Promise<Instance.v1.Snapshot>

• Waits for Server to be in a final state.

  Parameters

  • request: Readonly<Instance.v1.GetSnapshotRequest>

    The request GetServerRequest
  • Optionaloptions: Readonly<WaitForOptions<Instance.v1.Snapshot>>

    The waiting options

  Returns Promise<Instance.v1.Snapshot>

  A Promise of Server

waitForVolume

• waitForVolume(
      request: Readonly<Instance.v1.GetVolumeRequest>,
      options?: Readonly<WaitForOptions<Instance.v1.Volume>>,
  ): Promise<Instance.v1.Volume>

• Waits for Volume to be in a final state.

  Parameters

  • request: Readonly<Instance.v1.GetVolumeRequest>

    The request GetVolumeRequest
  • Optionaloptions: Readonly<WaitForOptions<Instance.v1.Volume>>

    The waiting options

  Returns Promise<Instance.v1.Volume>

  A Promise of Volume