Class API

constructor

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

• Parameters

  • client: Client

  Returns BareMetal.v1.API

Static ReadonlyLOCALITIES

addOptionServer

• addOptionServer(request): Promise<BareMetal.v1.Server>

• Add server option. Add an option, such as Private Networks, to a specific server.

  Parameters

  • request: Readonly<AddOptionServerRequest>

    The request AddOptionServerRequest

  Returns Promise<BareMetal.v1.Server>

  A Promise of Server

createServer

• createServer(request): Promise<BareMetal.v1.Server>

• Create an Elastic Metal server. Create a new Elastic Metal server. Once the server is created, proceed with the installation of an OS.

  Parameters

  • request: Readonly<BareMetal.v1.CreateServerRequest>

    The request CreateServerRequest

  Returns Promise<BareMetal.v1.Server>

  A Promise of Server

deleteOptionServer

• deleteOptionServer(request): Promise<BareMetal.v1.Server>

• Delete server option. Delete an option from a specific server.

  Parameters

  • request: Readonly<DeleteOptionServerRequest>

    The request DeleteOptionServerRequest

  Returns Promise<BareMetal.v1.Server>

  A Promise of Server

deleteServer

• deleteServer(request): Promise<BareMetal.v1.Server>

• Delete an Elastic Metal server. Delete the server associated with the ID.

  Parameters

  • request: Readonly<BareMetal.v1.DeleteServerRequest>

    The request DeleteServerRequest

  Returns Promise<BareMetal.v1.Server>

  A Promise of Server

getBMCAccess

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

• Get BMC access. Get the BMC (Baseboard Management Controller) access associated with the ID, including the URL and login information needed to connect.

  Parameters

  • request: Readonly<BareMetal.v1.GetBMCAccessRequest>

    The request GetBMCAccessRequest

  Returns Promise<BareMetal.v1.BMCAccess>

  A Promise of BMCAccess

getDefaultPartitioningSchema

• getDefaultPartitioningSchema(request): Promise<Schema>

• Get default partitioning schema. Get the default partitioning schema for the given offer ID and OS ID.

  Parameters

  • request: Readonly<GetDefaultPartitioningSchemaRequest>

    The request GetDefaultPartitioningSchemaRequest

  Returns Promise<Schema>

  A Promise of Schema

getOS

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

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

  Parameters

  • request: Readonly<BareMetal.v1.GetOSRequest>

    The request GetOSRequest

  Returns Promise<BareMetal.v1.OS>

  A Promise of OS

getOffer

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

• Get offer. Get details of an offer identified by its offer ID.

  Parameters

  • request: Readonly<BareMetal.v1.GetOfferRequest>

    The request GetOfferRequest

  Returns Promise<BareMetal.v1.Offer>

  A Promise of Offer

getOption

• getOption(request): Promise<Option>

• Get option. Return specific option for the ID.

  Parameters

  • request: Readonly<GetOptionRequest>

    The request GetOptionRequest

  Returns Promise<Option>

  A Promise of Option

getServer

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

• Get a specific Elastic Metal server. Get full details of an existing Elastic Metal server associated with the ID.

  Parameters

  • request: Readonly<BareMetal.v1.GetServerRequest>

    The request GetServerRequest

  Returns Promise<BareMetal.v1.Server>

  A Promise of Server

getServerMetrics

• getServerMetrics(request): Promise<GetServerMetricsResponse>

• Return server metrics. Get the ping status of the server associated with the ID.

  Parameters

  • request: Readonly<GetServerMetricsRequest>

    The request GetServerMetricsRequest

  Returns Promise<GetServerMetricsResponse>

  A Promise of GetServerMetricsResponse

installServer

• installServer(request): Promise<BareMetal.v1.Server>

• Install an Elastic Metal server. Install an Operating System (OS) on the Elastic Metal server with a specific ID.

  Parameters

  • request: Readonly<BareMetal.v1.InstallServerRequest>

    The request InstallServerRequest

  Returns Promise<BareMetal.v1.Server>

  A Promise of Server

listOS

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

• List available OSes. List all OSes that are available for installation on Elastic Metal servers.

  Parameters

  • request: Readonly<BareMetal.v1.ListOSRequest> = {}

    The request ListOSRequest

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

  A Promise of ListOSResponse

listOffers

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

• List offers. List all available Elastic Metal server configurations.

  Parameters

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

    The request ListOffersRequest

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

  A Promise of ListOffersResponse

listOptions

• listOptions(request?): Promise<ListOptionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Option[], void, void>);
      all: (() => Promise<Option[]>);
  }

• List options. List all options matching with filters.

  Parameters

  • request: Readonly<BareMetal.v1.ListOptionsRequest> = {}

    The request ListOptionsRequest

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

  A Promise of ListOptionsResponse

listServerEvents

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

• List server events. List event (i.e. start/stop/reboot) associated to the server ID.

  Parameters

  • request: Readonly<BareMetal.v1.ListServerEventsRequest>

    The request ListServerEventsRequest

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

  A Promise of ListServerEventsResponse

listServers

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

• List Elastic Metal servers for an Organization. List Elastic Metal servers for a specific Organization.

  Parameters

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

    The request ListServersRequest

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

  A Promise of ListServersResponse

listSettings

• listSettings(request?): Promise<ListSettingsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<BareMetal.v1.Setting[], void, void>);
      all: (() => Promise<BareMetal.v1.Setting[]>);
  }

• List all settings. Return all settings for a Project ID.

  Parameters

  • request: Readonly<BareMetal.v1.ListSettingsRequest> = {}

    The request ListSettingsRequest

  Returns Promise<ListSettingsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<BareMetal.v1.Setting[], void, void>);
      all: (() => Promise<BareMetal.v1.Setting[]>);
  }

  A Promise of ListSettingsResponse

rebootServer

• rebootServer(request): Promise<BareMetal.v1.Server>

• Reboot an Elastic Metal server. Reboot the Elastic Metal server associated with the ID, use the boot_type rescue to reboot the server in rescue mode.

  Parameters

  • request: Readonly<BareMetal.v1.RebootServerRequest>

    The request RebootServerRequest

  Returns Promise<BareMetal.v1.Server>

  A Promise of Server

startBMCAccess

• startBMCAccess(request): Promise<BareMetal.v1.BMCAccess>

• Start BMC access. Start BMC (Baseboard Management Controller) access associated with the ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. After adding the BMC option, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do not forget to delete the Option after use.

  Parameters

  • request: Readonly<BareMetal.v1.StartBMCAccessRequest>

    The request StartBMCAccessRequest

  Returns Promise<BareMetal.v1.BMCAccess>

  A Promise of BMCAccess

startServer

• startServer(request): Promise<BareMetal.v1.Server>

• Start an Elastic Metal server. Start the server associated with the ID.

  Parameters

  • request: Readonly<BareMetal.v1.StartServerRequest>

    The request StartServerRequest

  Returns Promise<BareMetal.v1.Server>

  A Promise of Server

stopBMCAccess

• stopBMCAccess(request): Promise<void>

• Stop BMC access. Stop BMC (Baseboard Management Controller) access associated with the ID.

  Parameters

  • request: Readonly<BareMetal.v1.StopBMCAccessRequest>

    The request StopBMCAccessRequest

  Returns Promise<void>

stopServer

• stopServer(request): Promise<BareMetal.v1.Server>

• Stop an Elastic Metal server. Stop the server associated with the ID. The server remains allocated to your account and all data remains on the local storage of the server.

  Parameters

  • request: Readonly<BareMetal.v1.StopServerRequest>

    The request StopServerRequest

  Returns Promise<BareMetal.v1.Server>

  A Promise of Server

updateIP

• updateIP(request): Promise<BareMetal.v1.IP>

• Update IP. Configure the IP address associated with the server ID and IP ID. You can use this method to set a reverse DNS for an IP address.

  Parameters

  • request: Readonly<BareMetal.v1.UpdateIPRequest>

    The request UpdateIPRequest

  Returns Promise<BareMetal.v1.IP>

  A Promise of IP

updateServer

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

• Update an Elastic Metal server. Update the server associated with the ID. You can update parameters such as the server's name, tags and description. Any parameters left null in the request body are not updated.

  Parameters

  • request: Readonly<BareMetal.v1.UpdateServerRequest>

    The request UpdateServerRequest

  Returns Promise<BareMetal.v1.Server>

  A Promise of Server

updateSetting

• updateSetting(request): Promise<BareMetal.v1.Setting>

• Update setting. Update a setting for a Project ID (enable or disable).

  Parameters

  • request: Readonly<UpdateSettingRequest>

    The request UpdateSettingRequest

  Returns Promise<BareMetal.v1.Setting>

  A Promise of Setting

validatePartitioningSchema

• validatePartitioningSchema(request): Promise<void>

• Validate client partitioning schema. Validate the incoming partitioning schema from a user before installing the server. Return default ErrorCode if invalid.

  Parameters

  • request: Readonly<ValidatePartitioningSchemaRequest>

    The request ValidatePartitioningSchemaRequest

  Returns Promise<void>

waitForServer

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

• Waits for Server to be in a final state.

  Parameters

  • request: Readonly<BareMetal.v1.GetServerRequest>

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

    The waiting options

  Returns Promise<BareMetal.v1.Server>

  A Promise of Server

waitForServerInstall

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

• Waits for ServerInstall to be in a final state.

  Parameters

  • request: Readonly<BareMetal.v1.GetServerRequest>

    The request GetServerRequest
  • Optionaloptions: Readonly<WaitForOptions<BareMetal.v1.ServerInstall>>

    The waiting options

  Returns Promise<BareMetal.v1.ServerInstall>

  A Promise of ServerInstall