Class API

constructor

• new API(client): Dedibox.v1.API

• Parameters

  • client: Client

  Returns Dedibox.v1.API

Static ReadonlyLOCALITIES

attachFailoverIPToMacAddress

• attachFailoverIPToMacAddress(request): Promise<Dedibox.v1.IP>

• Attach a failover IP to a MAC address.

  Parameters

  • request: Readonly<Dedibox.v1.AttachFailoverIPToMacAddressRequest>

    The request AttachFailoverIPToMacAddressRequest

  Returns Promise<Dedibox.v1.IP>

  A Promise of IP

attachFailoverIPs

• attachFailoverIPs(request): Promise<void>

• Attach failovers on baremetal server. Attach failovers on the server associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.AttachFailoverIPsRequest>

    The request AttachFailoverIPsRequest

  Returns Promise<void>

cancelServerInstall

• cancelServerInstall(request): Promise<void>

• Cancels the current (running) server installation. Cancels the current server installation associated with the given server ID.

  Parameters

  • request: Readonly<Dedibox.v1.CancelServerInstallRequest>

    The request CancelServerInstallRequest

  Returns Promise<void>

createFailoverIPs

• createFailoverIPs(request): Promise<CreateFailoverIPsResponse>

• Order failover IPs. Order X failover IPs.

  Parameters

  • request: Readonly<CreateFailoverIPsRequest>

    The request CreateFailoverIPsRequest

  Returns Promise<CreateFailoverIPsResponse>

  A Promise of CreateFailoverIPsResponse

createServer

• createServer(request): Promise<Service>

• Create a baremetal server. Create a new baremetal server. The order return you a service ID to follow the provisionning status you could call GetService.

  Parameters

  • request: Readonly<Dedibox.v1.CreateServerRequest>

    The request CreateServerRequest

  Returns Promise<Service>

  A Promise of Service

deleteFailoverIP

• deleteFailoverIP(request): Promise<void>

• Delete a failover server. Delete the failover associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.DeleteFailoverIPRequest>

    The request DeleteFailoverIPRequest

  Returns Promise<void>

deleteServer

• deleteServer(request): Promise<void>

• Delete a baremetal server. Delete the server associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.DeleteServerRequest>

    The request DeleteServerRequest

  Returns Promise<void>

deleteService

• deleteService(request): Promise<Service>

• Delete a specific service. Delete the service associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.DeleteServiceRequest>

    The request DeleteServiceRequest

  Returns Promise<Service>

  A Promise of Service

detachFailoverIPFromMacAddress

• detachFailoverIPFromMacAddress(request): Promise<Dedibox.v1.IP>

• Detach a failover IP from a MAC address.

  Parameters

  • request: Readonly<Dedibox.v1.DetachFailoverIPFromMacAddressRequest>

    The request DetachFailoverIPFromMacAddressRequest

  Returns Promise<Dedibox.v1.IP>

  A Promise of IP

detachFailoverIPs

• detachFailoverIPs(request): Promise<void>

• Detach failovers on baremetal server. Detach failovers on the server associated with the given ID.

  Parameters

  • request: Readonly<DetachFailoverIPsRequest>

    The request DetachFailoverIPsRequest

  Returns Promise<void>

getBMCAccess

• getBMCAccess(request): Promise<Dedibox.v1.BMCAccess>

• Get BMC (Baseboard Management Controller) access for a given baremetal server. Get the BMC (Baseboard Management Controller) access associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.GetBMCAccessRequest>

    The request GetBMCAccessRequest

  Returns Promise<Dedibox.v1.BMCAccess>

  A Promise of BMCAccess

getFailoverIP

• getFailoverIP(request): Promise<FailoverIP>

• Get a specific baremetal server. Get the server associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.GetFailoverIPRequest>

    The request GetFailoverIPRequest

  Returns Promise<FailoverIP>

  A Promise of FailoverIP

getOS

• getOS(request): Promise<Dedibox.v1.OS>

• Get an OS with a given ID. Return specific OS for the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.GetOSRequest>

    The request GetOSRequest

  Returns Promise<Dedibox.v1.OS>

  A Promise of OS

getOffer

• getOffer(request): Promise<Dedibox.v1.Offer>

• Get offer. Return specific offer for the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.GetOfferRequest>

    The request GetOfferRequest

  Returns Promise<Dedibox.v1.Offer>

  A Promise of Offer

getOrderedService

• getOrderedService(request): Promise<Service>

• Parameters

  • request: Readonly<Dedibox.v1.GetOrderedServiceRequest>

  Returns Promise<Service>

getRaid

• getRaid(request): Promise<Raid>

• Get raid. Return raid for the given server ID.

  Parameters

  • request: Readonly<Dedibox.v1.GetRaidRequest>

    The request GetRaidRequest

  Returns Promise<Raid>

  A Promise of Raid

getRemainingQuota

• getRemainingQuota(request?): Promise<GetRemainingQuotaResponse>

• Get remaining quota.

  Parameters

  • request: Readonly<GetRemainingQuotaRequest> = {}

    The request GetRemainingQuotaRequest

  Returns Promise<GetRemainingQuotaResponse>

  A Promise of GetRemainingQuotaResponse

getRescue

• getRescue(request): Promise<Rescue>

• Get rescue information. Return rescue information for the given server ID.

  Parameters

  • request: Readonly<Dedibox.v1.GetRescueRequest>

    The request GetRescueRequest

  Returns Promise<Rescue>

  A Promise of Rescue

getServer

• getServer(request): Promise<Dedibox.v1.Server>

• Get a specific baremetal server. Get the server associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.GetServerRequest>

    The request GetServerRequest

  Returns Promise<Dedibox.v1.Server>

  A Promise of Server

getServerBackup

• getServerBackup(request): Promise<Backup>

• Parameters

  • request: Readonly<Dedibox.v1.GetServerBackupRequest>

  Returns Promise<Backup>

getServerDefaultPartitioning

• getServerDefaultPartitioning(request): Promise<ServerDefaultPartitioning>

• Get server default partitioning. Get the server default partitioning schema associated with the given server ID and OS ID.

  Parameters

  • request: Readonly<GetServerDefaultPartitioningRequest>

    The request GetServerDefaultPartitioningRequest

  Returns Promise<ServerDefaultPartitioning>

  A Promise of ServerDefaultPartitioning

getServerInstall

• getServerInstall(request): Promise<Dedibox.v1.ServerInstall>

• Get a specific server installation status. Get the server installation status associated with the given server ID.

  Parameters

  • request: Readonly<Dedibox.v1.GetServerInstallRequest>

    The request GetServerInstallRequest

  Returns Promise<Dedibox.v1.ServerInstall>

  A Promise of ServerInstall

getService

• getService(request): Promise<Service>

• Get a specific service. Get the service associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.GetServiceRequest>

    The request GetServiceRequest

  Returns Promise<Service>

  A Promise of Service

installServer

• installServer(request): Promise<Dedibox.v1.ServerInstall>

• Install a baremetal server. Install an OS on the server associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.InstallServerRequest>

    The request InstallServerRequest

  Returns Promise<Dedibox.v1.ServerInstall>

  A Promise of ServerInstall

listFailoverIPs

• listFailoverIPs(request?): Promise<ListFailoverIPsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<FailoverIP[], void, void>);
      all: (() => Promise<FailoverIP[]>);
  }

• List failovers for project. List failovers servers for project.

  Parameters

  • request: Readonly<Dedibox.v1.ListFailoverIPsRequest> = {}

    The request ListFailoverIPsRequest

  Returns Promise<ListFailoverIPsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<FailoverIP[], void, void>);
      all: (() => Promise<FailoverIP[]>);
  }

  A Promise of ListFailoverIPsResponse

listOS

• listOS(request): Promise<Dedibox.v1.ListOSResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Dedibox.v1.OS[], void, void>);
      all: (() => Promise<Dedibox.v1.OS[]>);
  }

• List all available OS that can be install on a baremetal server.

  Parameters

  • request: Readonly<Dedibox.v1.ListOSRequest>

    The request ListOSRequest

  Returns Promise<Dedibox.v1.ListOSResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Dedibox.v1.OS[], void, void>);
      all: (() => Promise<Dedibox.v1.OS[]>);
  }

  A Promise of ListOSResponse

listOffers

• listOffers(request?): Promise<Dedibox.v1.ListOffersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Offer[], void, void>);
      all: (() => Promise<Dedibox.v1.Offer[]>);
  }

• List offers. List all available server offers.

  Parameters

  • request: Readonly<Dedibox.v1.ListOffersRequest> = {}

    The request ListOffersRequest

  Returns Promise<Dedibox.v1.ListOffersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Offer[], void, void>);
      all: (() => Promise<Dedibox.v1.Offer[]>);
  }

  A Promise of ListOffersResponse

listServerDisks

• listServerDisks(request): Promise<ListServerDisksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<ServerDisk[], void, void>);
      all: (() => Promise<ServerDisk[]>);
  }

• List server disks. List disks associated to the given server ID.

  Parameters

  • request: Readonly<Dedibox.v1.ListServerDisksRequest>

    The request ListServerDisksRequest

  Returns Promise<ListServerDisksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<ServerDisk[], void, void>);
      all: (() => Promise<ServerDisk[]>);
  }

  A Promise of ListServerDisksResponse

listServerEvents

• listServerEvents(request): Promise<Dedibox.v1.ListServerEventsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Dedibox.v1.ServerEvent[], void, void>);
      all: (() => Promise<Dedibox.v1.ServerEvent[]>);
  }

• List server events. List events associated to the given server ID.

  Parameters

  • request: Readonly<Dedibox.v1.ListServerEventsRequest>

    The request ListServerEventsRequest

  Returns Promise<Dedibox.v1.ListServerEventsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Dedibox.v1.ServerEvent[], void, void>);
      all: (() => Promise<Dedibox.v1.ServerEvent[]>);
  }

  A Promise of ListServerEventsResponse

listServers

• listServers(request?): Promise<Dedibox.v1.ListServersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Dedibox.v1.ServerSummary[], void, void>);
      all: (() => Promise<Dedibox.v1.ServerSummary[]>);
  }

• List baremetal servers for project.

  Parameters

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

    The request ListServersRequest

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

  A Promise of ListServersResponse

listServices

• listServices(request?): Promise<ListServicesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Service[], void, void>);
      all: (() => Promise<Service[]>);
  }

• List services.

  Parameters

  • request: Readonly<Dedibox.v1.ListServicesRequest> = {}

    The request ListServicesRequest

  Returns Promise<ListServicesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Service[], void, void>);
      all: (() => Promise<Service[]>);
  }

  A Promise of ListServicesResponse

listSubscribableServerOptions

• listSubscribableServerOptions(request): Promise<ListSubscribableServerOptionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Offer[], void, void>);
      all: (() => Promise<Dedibox.v1.Offer[]>);
  }

• List subscribable server options. List subscribable options associated to the given server ID.

  Parameters

  • request: Readonly<Dedibox.v1.ListSubscribableServerOptionsRequest>

    The request ListSubscribableServerOptionsRequest

  Returns Promise<ListSubscribableServerOptionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Offer[], void, void>);
      all: (() => Promise<Dedibox.v1.Offer[]>);
  }

  A Promise of ListSubscribableServerOptionsResponse

rebootServer

• rebootServer(request): Promise<void>

• Reboot a baremetal server. Reboot the server associated with the given ID, use boot param to reboot in rescue.

  Parameters

  • request: Readonly<Dedibox.v1.RebootServerRequest>

    The request RebootServerRequest

  Returns Promise<void>

startBMCAccess

• startBMCAccess(request): Promise<void>

• Start BMC (Baseboard Management Controller) access for a given baremetal server. Start BMC (Baseboard Management Controller) access associated with the given ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.

  Parameters

  • request: Readonly<Dedibox.v1.StartBMCAccessRequest>

    The request StartBMCAccessRequest

  Returns Promise<void>

startRescue

• startRescue(request): Promise<Rescue>

• Start in rescue baremetal server. Start in rescue the server associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.StartRescueRequest>

    The request StartRescueRequest

  Returns Promise<Rescue>

  A Promise of Rescue

startServer

• startServer(request): Promise<void>

• Start a baremetal server. Start the server associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.StartServerRequest>

    The request StartServerRequest

  Returns Promise<void>

stopBMCAccess

• stopBMCAccess(request): Promise<void>

• Stop BMC (Baseboard Management Controller) access for a given baremetal server. Stop BMC (Baseboard Management Controller) access associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.StopBMCAccessRequest>

    The request StopBMCAccessRequest

  Returns Promise<void>

stopRescue

• stopRescue(request): Promise<void>

• Stop rescue on baremetal server. Stop rescue on the server associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.StopRescueRequest>

    The request StopRescueRequest

  Returns Promise<void>

stopServer

• stopServer(request): Promise<void>

• Stop a baremetal server. Stop the server associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.StopServerRequest>

    The request StopServerRequest

  Returns Promise<void>

subscribeServerOption

• subscribeServerOption(request): Promise<Service>

• Subscribe server option. Subscribe option for the given server ID.

  Parameters

  • request: Readonly<Dedibox.v1.SubscribeServerOptionRequest>

    The request SubscribeServerOptionRequest

  Returns Promise<Service>

  A Promise of Service

subscribeStorageOptions

• subscribeStorageOptions(request): Promise<SubscribeStorageOptionsResponse>

• Subscribe storage server option. Subscribe storage option for the given server ID.

  Parameters

  • request: Readonly<Dedibox.v1.SubscribeStorageOptionsRequest>

    The request SubscribeStorageOptionsRequest

  Returns Promise<SubscribeStorageOptionsResponse>

  A Promise of SubscribeStorageOptionsResponse

updateRaid

• updateRaid(request): Promise<void>

• Update RAID. Update RAID associated with the given server ID.

  Parameters

  • request: Readonly<Dedibox.v1.UpdateRaidRequest>

    The request UpdateRaidRequest

  Returns Promise<void>

updateReverse

• updateReverse(request): Promise<Dedibox.v1.IP>

• Update reverse of ip. Update reverse of ip associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.UpdateReverseRequest>

    The request UpdateReverseRequest

  Returns Promise<Dedibox.v1.IP>

  A Promise of IP

updateServer

• updateServer(request): Promise<Dedibox.v1.Server>

• Update a baremetal server. Update the server associated with the given ID.

  Parameters

  • request: Readonly<Dedibox.v1.UpdateServerRequest>

    The request UpdateServerRequest

  Returns Promise<Dedibox.v1.Server>

  A Promise of Server

updateServerBackup

• updateServerBackup(request): Promise<Backup>

• Parameters

  • request: Readonly<Dedibox.v1.UpdateServerBackupRequest>

  Returns Promise<Backup>

updateServerTags

• updateServerTags(request): Promise<Dedibox.v1.Server>

• Parameters

  • request: Readonly<Dedibox.v1.UpdateServerTagsRequest>

  Returns Promise<Dedibox.v1.Server>

waitForBMCAccess

• waitForBMCAccess(request, options?): Promise<Dedibox.v1.BMCAccess>

• Waits for BMCAccess to be in a final state.

  Parameters

  • request: Readonly<Dedibox.v1.GetBMCAccessRequest>

    The request GetBMCAccessRequest
  • Optionaloptions: Readonly<WaitForOptions<Dedibox.v1.BMCAccess>>

    The waiting options

  Returns Promise<Dedibox.v1.BMCAccess>

  A Promise of BMCAccess

waitForServer

• waitForServer(request, options?): Promise<Dedibox.v1.Server>

• Waits for Server to be in a final state.

  Parameters

  • request: Readonly<Dedibox.v1.GetServerRequest>

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

    The waiting options

  Returns Promise<Dedibox.v1.Server>

  A Promise of Server

waitForServerInstall

• waitForServerInstall(request, options?): Promise<Dedibox.v1.ServerInstall>

• Waits for ServerInstall to be in a final state.

  Parameters

  • request: Readonly<Dedibox.v1.GetServerInstallRequest>

    The request GetServerInstallRequest
  • Optionaloptions: Readonly<WaitForOptions<Dedibox.v1.ServerInstall>>

    The waiting options

  Returns Promise<Dedibox.v1.ServerInstall>

  A Promise of ServerInstall