Class HostingAPI

constructor

• new HostingAPI(client): HostingAPI

• Parameters

  • client: Client

  Returns HostingAPI

Static ReadonlyLOCALITIES

createHosting

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

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

  Parameters

  • request: Readonly<HostingApiCreateHostingRequest>

    The request HostingApiCreateHostingRequest

  Returns Promise<Webhosting.v1.Hosting>

  A Promise of Hosting

createSession

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

• Create a user session.

  Parameters

  • request: Readonly<HostingApiCreateSessionRequest>

    The request HostingApiCreateSessionRequest

  Returns Promise<Webhosting.v1.Session>

  A Promise of Session

deleteHosting

• deleteHosting(request): Promise<Webhosting.v1.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<HostingApiDeleteHostingRequest>

    The request HostingApiDeleteHostingRequest

  Returns Promise<Webhosting.v1.Hosting>

  A Promise of Hosting

getHosting

• getHosting(request): Promise<Webhosting.v1.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<HostingApiGetHostingRequest>

    The request HostingApiGetHostingRequest

  Returns Promise<Webhosting.v1.Hosting>

  A Promise of Hosting

getResourceSummary

• getResourceSummary(request): Promise<ResourceSummary>

• Get the total counts of websites, databases, email accounts, and FTP accounts of a Web Hosting plan.

  Parameters

  • request: Readonly<HostingApiGetResourceSummaryRequest>

    The request HostingApiGetResourceSummaryRequest

  Returns Promise<ResourceSummary>

  A Promise of ResourceSummary

listHostings

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

• 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.v1.HostingApiListHostingsRequest> = {}

    The request HostingApiListHostingsRequest

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

  A Promise of ListHostingsResponse

resetHostingPassword

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

• Reset a Web Hosting plan password.

  Parameters

  • request: Readonly<HostingApiResetHostingPasswordRequest>

    The request HostingApiResetHostingPasswordRequest

  Returns Promise<Webhosting.v1.ResetHostingPasswordResponse>

  A Promise of ResetHostingPasswordResponse

updateHosting

• updateHosting(request): Promise<Webhosting.v1.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<HostingApiUpdateHostingRequest>

    The request HostingApiUpdateHostingRequest

  Returns Promise<Webhosting.v1.Hosting>

  A Promise of Hosting

waitForHosting

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

• Waits for Hosting to be in a final state.

  Parameters

  • request: Readonly<HostingApiGetHostingRequest>

    The request HostingApiGetHostingRequest
  • Optionaloptions: Readonly<WaitForOptions<Webhosting.v1.Hosting>>

    The waiting options

  Returns Promise<Webhosting.v1.Hosting>

  A Promise of Hosting