Class API

constructor

• new API(client): Webhosting.v1alpha1.API

• Parameters

  • client: Client

  Returns Webhosting.v1alpha1.API

Static ReadonlyLOCALITIES

checkUserOwnsDomain

• checkUserOwnsDomain(request): Promise<CheckUserOwnsDomainResponse>

• "Check whether you own this domain or not.".

  Parameters

  • request: Readonly<CheckUserOwnsDomainRequest>

    The request CheckUserOwnsDomainRequest

  Returns Promise<CheckUserOwnsDomainResponse>

  A Promise of CheckUserOwnsDomainResponse

createHosting

• createHosting(request): Promise<Webhosting.v1alpha1.Hosting>

• Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer type required via the offer_id parameter.

  Parameters

  • request: Readonly<CreateHostingRequest>

    The request CreateHostingRequest

  Returns Promise<Webhosting.v1alpha1.Hosting>

  A Promise of Hosting

createSession

• createSession(request): Promise<Webhosting.v1alpha1.Session>

• Create a user session.

  Parameters

  • request: Readonly<Webhosting.v1alpha1.CreateSessionRequest>

    The request CreateSessionRequest

  Returns Promise<Webhosting.v1alpha1.Session>

  A Promise of Session

deleteHosting

• deleteHosting(request): Promise<Webhosting.v1alpha1.Hosting>

• Delete a Web Hosting plan. Delete a Web Hosting plan, specified by its hosting_id. Note that deletion is not immediate: it will take place at the end of the calendar month, after which time your Web Hosting plan and all its data (files and emails) will be irreversibly lost.

  Parameters

  • request: Readonly<DeleteHostingRequest>

    The request DeleteHostingRequest

  Returns Promise<Webhosting.v1alpha1.Hosting>

  A Promise of Hosting

getDomainDnsRecords

• getDomainDnsRecords(request): Promise<DnsRecords>

• Get DNS records. Get the set of DNS records of a specified domain associated with a Web Hosting plan.

  Parameters

  • request: Readonly<GetDomainDnsRecordsRequest>

    The request GetDomainDnsRecordsRequest

  Returns Promise<DnsRecords>

  A Promise of DnsRecords

getHosting

• getHosting(request): Promise<Webhosting.v1alpha1.Hosting>

• Get a Web Hosting plan. Get the details of one of your existing Web Hosting plans, specified by its hosting_id.

  Parameters

  • request: Readonly<GetHostingRequest>

    The request GetHostingRequest

  Returns Promise<Webhosting.v1alpha1.Hosting>

  A Promise of Hosting

listControlPanels

• listControlPanels(request?): Promise<Webhosting.v1alpha1.ListControlPanelsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Webhosting.v1alpha1.ControlPanel[], void, void>);
      all: (() => Promise<Webhosting.v1alpha1.ControlPanel[]>);
  }

• "List the control panels type: cpanel or plesk.".

  Parameters

  • request: Readonly<Webhosting.v1alpha1.ListControlPanelsRequest> = {}

    The request ListControlPanelsRequest

  Returns Promise<Webhosting.v1alpha1.ListControlPanelsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Webhosting.v1alpha1.ControlPanel[], void, void>);
      all: (() => Promise<Webhosting.v1alpha1.ControlPanel[]>);
  }

  A Promise of ListControlPanelsResponse

listHostings

• listHostings(request?): Promise<Webhosting.v1alpha1.ListHostingsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Webhosting.v1alpha1.Hosting[], void, void>);
      all: (() => Promise<Webhosting.v1alpha1.Hosting[]>);
  }

• List all Web Hosting plans. List all of your existing Web Hosting plans. Various filters are available to limit the results, including filtering by domain, status, tag and Project ID.

  Parameters

  • request: Readonly<Webhosting.v1alpha1.ListHostingsRequest> = {}

    The request ListHostingsRequest

  Returns Promise<Webhosting.v1alpha1.ListHostingsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Webhosting.v1alpha1.Hosting[], void, void>);
      all: (() => Promise<Webhosting.v1alpha1.Hosting[]>);
  }

  A Promise of ListHostingsResponse

listOffers

• listOffers(request): Promise<Webhosting.v1alpha1.ListOffersResponse>

• List all offers. List the different Web Hosting offers, and their options, available to order from Scaleway.

  Parameters

  • request: Readonly<Webhosting.v1alpha1.ListOffersRequest>

    The request ListOffersRequest

  Returns Promise<Webhosting.v1alpha1.ListOffersResponse>

  A Promise of ListOffersResponse

resetHostingPassword

• resetHostingPassword(request): Promise<Webhosting.v1alpha1.ResetHostingPasswordResponse>

• Parameters

  • request: Readonly<ResetHostingPasswordRequest>

  Returns Promise<Webhosting.v1alpha1.ResetHostingPasswordResponse>

restoreHosting

• restoreHosting(request): Promise<Webhosting.v1alpha1.Hosting>

• Restore a Web Hosting plan. When you delete a Web Hosting plan, definitive deletion does not take place until the end of the calendar month. In the time between initiating the deletion, and definitive deletion at the end of the month, you can choose to restore the Web Hosting plan, using this endpoint and specifying its hosting_id.

  Parameters

  • request: Readonly<RestoreHostingRequest>

    The request RestoreHostingRequest

  Returns Promise<Webhosting.v1alpha1.Hosting>

  A Promise of Hosting

updateHosting

• updateHosting(request): Promise<Webhosting.v1alpha1.Hosting>

• Update a Web Hosting plan. Update the details of one of your existing Web Hosting plans, specified by its hosting_id. You can update parameters including the contact email address, tags, options and offer.

  Parameters

  • request: Readonly<UpdateHostingRequest>

    The request UpdateHostingRequest

  Returns Promise<Webhosting.v1alpha1.Hosting>

  A Promise of Hosting

waitForHosting

• waitForHosting(request, options?): Promise<Webhosting.v1alpha1.Hosting>

• Waits for Hosting to be in a final state.

  Parameters

  • request: Readonly<GetHostingRequest>

    The request GetHostingRequest
  • Optionaloptions: Readonly<WaitForOptions<Webhosting.v1alpha1.Hosting>>

    The waiting options

  Returns Promise<Webhosting.v1alpha1.Hosting>

  A Promise of Hosting