Class ZonedAPI

constructor

• new ZonedAPI(client: Client): ZonedAPI

• Parameters

  • client: Client

  Returns ZonedAPI

Static ReadonlyLOCALITIES

addBackendServers

• addBackendServers(
      request: Readonly<ZonedApiAddBackendServersRequest>,
  ): Promise<Backend>

• Add a set of backend servers to a given backend. For a given backend specified by its backend ID, add a set of backend servers (identified by their IP addresses) it should forward traffic to. These will be appended to any existing set of backend servers for this backend.

  Parameters

  • request: Readonly<ZonedApiAddBackendServersRequest>

    The request ZonedApiAddBackendServersRequest

  Returns Promise<Backend>

  A Promise of Backend

attachPrivateNetwork

• attachPrivateNetwork(
      request: Readonly<ZonedApiAttachPrivateNetworkRequest>,
  ): Promise<LB.v1.PrivateNetwork>

• Attach a Load Balancer to a Private Network. Attach a specified Load Balancer to a specified Private Network, defining a static or DHCP configuration for the Load Balancer on the network.

  Parameters

  • request: Readonly<ZonedApiAttachPrivateNetworkRequest>

    The request ZonedApiAttachPrivateNetworkRequest

  Returns Promise<LB.v1.PrivateNetwork>

  A Promise of PrivateNetwork

createAcl

• createAcl(request: Readonly<ZonedApiCreateAclRequest>): Promise<Acl>

• Create an ACL for a given frontend. Create a new ACL for a given frontend. Each ACL must have a name, an action to perform (allow or deny), and a match rule (the action is carried out when the incoming traffic matches the rule).

  Parameters

  • request: Readonly<ZonedApiCreateAclRequest>

    The request ZonedApiCreateAclRequest

  Returns Promise<Acl>

  A Promise of Acl

createBackend

• createBackend(request: Readonly<ZonedApiCreateBackendRequest>): Promise<Backend>

• Create a backend for a given Load Balancer. Create a new backend for a given Load Balancer, specifying its full configuration including protocol, port and forwarding algorithm.

  Parameters

  • request: Readonly<ZonedApiCreateBackendRequest>

    The request ZonedApiCreateBackendRequest

  Returns Promise<Backend>

  A Promise of Backend

createCertificate

• createCertificate(
      request: Readonly<ZonedApiCreateCertificateRequest>,
  ): Promise<LB.v1.Certificate>

• Create an SSL/TLS certificate. Generate a new SSL/TLS certificate for a given Load Balancer. You can choose to create a Let's Encrypt certificate, or import a custom certificate.

  Parameters

  • request: Readonly<ZonedApiCreateCertificateRequest>

    The request ZonedApiCreateCertificateRequest

  Returns Promise<LB.v1.Certificate>

  A Promise of Certificate

createFrontend

• createFrontend(
      request: Readonly<ZonedApiCreateFrontendRequest>,
  ): Promise<Frontend>

• Create a frontend in a given Load Balancer. Create a new frontend for a given Load Balancer, specifying its configuration including the port it should listen on and the backend to attach it to.

  Parameters

  • request: Readonly<ZonedApiCreateFrontendRequest>

    The request ZonedApiCreateFrontendRequest

  Returns Promise<Frontend>

  A Promise of Frontend

createIp

• createIp(request: Readonly<ZonedApiCreateIpRequest>): Promise<LB.v1.Ip>

• Create an IP address. Create a new Load Balancer flexible IP address, in the specified Scaleway Project. This can be attached to new Load Balancers created in the future.

  Parameters

  • request: Readonly<ZonedApiCreateIpRequest>

    The request ZonedApiCreateIpRequest

  Returns Promise<LB.v1.Ip>

  A Promise of Ip

createLb

• createLb(request: Readonly<ZonedApiCreateLbRequest>): Promise<LB.v1.Lb>

• Create a Load Balancer. Create a new Load Balancer. Note that the Load Balancer will be created without frontends or backends; these must be created separately via the dedicated endpoints.

  Parameters

  • request: Readonly<ZonedApiCreateLbRequest>

    The request ZonedApiCreateLbRequest

  Returns Promise<LB.v1.Lb>

  A Promise of Lb

createRoute

• createRoute(request: Readonly<ZonedApiCreateRouteRequest>): Promise<LB.v1.Route>

• Create a route. Create a new route on a given frontend. To configure a route, specify the backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).

  Parameters

  • request: Readonly<ZonedApiCreateRouteRequest>

    The request ZonedApiCreateRouteRequest

  Returns Promise<LB.v1.Route>

  A Promise of Route

createSubscriber

• createSubscriber(
      request: Readonly<ZonedApiCreateSubscriberRequest>,
  ): Promise<Subscriber>

• Create a subscriber. Create a new subscriber, either with an email configuration or a webhook configuration, for a specified Scaleway Project.

  Parameters

  • request: Readonly<ZonedApiCreateSubscriberRequest>

    The request ZonedApiCreateSubscriberRequest

  Returns Promise<Subscriber>

  A Promise of Subscriber

deleteAcl

• deleteAcl(request: Readonly<ZonedApiDeleteAclRequest>): Promise<void>

• Delete an ACL. Delete an ACL, specified by its ACL ID. Deleting an ACL is irreversible and cannot be undone.

  Parameters

  • request: Readonly<ZonedApiDeleteAclRequest>

    The request ZonedApiDeleteAclRequest

  Returns Promise<void>

deleteBackend

• deleteBackend(request: Readonly<ZonedApiDeleteBackendRequest>): Promise<void>

• Delete a backend of a given Load Balancer. Delete a backend of a given Load Balancer, specified by its backend ID. This action is irreversible and cannot be undone.

  Parameters

  • request: Readonly<ZonedApiDeleteBackendRequest>

    The request ZonedApiDeleteBackendRequest

  Returns Promise<void>

deleteCertificate

• deleteCertificate(
      request: Readonly<ZonedApiDeleteCertificateRequest>,
  ): Promise<void>

• Delete an SSL/TLS certificate. Delete an SSL/TLS certificate, specified by its certificate ID. Deleting a certificate is irreversible and cannot be undone.

  Parameters

  • request: Readonly<ZonedApiDeleteCertificateRequest>

    The request ZonedApiDeleteCertificateRequest

  Returns Promise<void>

deleteFrontend

• deleteFrontend(request: Readonly<ZonedApiDeleteFrontendRequest>): Promise<void>

• Delete a frontend. Delete a given frontend, specified by its frontend ID. This action is irreversible and cannot be undone.

  Parameters

  • request: Readonly<ZonedApiDeleteFrontendRequest>

    The request ZonedApiDeleteFrontendRequest

  Returns Promise<void>

deleteLb

• deleteLb(request: Readonly<ZonedApiDeleteLbRequest>): Promise<void>

• Delete a Load Balancer. Delete an existing Load Balancer, specified by its Load Balancer ID. Deleting a Load Balancer is permanent, and cannot be undone. The Load Balancer's flexible IP address can either be deleted with the Load Balancer, or kept in your account for future use.

  Parameters

  • request: Readonly<ZonedApiDeleteLbRequest>

    The request ZonedApiDeleteLbRequest

  Returns Promise<void>

deleteRoute

• deleteRoute(request: Readonly<ZonedApiDeleteRouteRequest>): Promise<void>

• Delete a route. Delete an existing route, specified by its route ID. Deleting a route is permanent, and cannot be undone.

  Parameters

  • request: Readonly<ZonedApiDeleteRouteRequest>

    The request ZonedApiDeleteRouteRequest

  Returns Promise<void>

deleteSubscriber

• deleteSubscriber(
      request: Readonly<ZonedApiDeleteSubscriberRequest>,
  ): Promise<void>

• Delete a subscriber. Delete an existing subscriber, specified by its subscriber ID. Deleting a subscriber is permanent, and cannot be undone.

  Parameters

  • request: Readonly<ZonedApiDeleteSubscriberRequest>

    The request ZonedApiDeleteSubscriberRequest

  Returns Promise<void>

detachPrivateNetwork

• detachPrivateNetwork(
      request: Readonly<ZonedApiDetachPrivateNetworkRequest>,
  ): Promise<void>

• Detach Load Balancer from Private Network. Detach a specified Load Balancer from a specified Private Network.

  Parameters

  • request: Readonly<ZonedApiDetachPrivateNetworkRequest>

    The request ZonedApiDetachPrivateNetworkRequest

  Returns Promise<void>

getAcl

• getAcl(request: Readonly<ZonedApiGetAclRequest>): Promise<Acl>

• Get an ACL. Get information for a particular ACL, specified by its ACL ID. The response returns full details of the ACL, including its name, action, match rule and frontend.

  Parameters

  • request: Readonly<ZonedApiGetAclRequest>

    The request ZonedApiGetAclRequest

  Returns Promise<Acl>

  A Promise of Acl

getBackend

• getBackend(request: Readonly<ZonedApiGetBackendRequest>): Promise<Backend>

• Get a backend of a given Load Balancer. Get the full details of a given backend, specified by its backend ID. The response contains the backend's full configuration parameters including protocol, port and forwarding algorithm.

  Parameters

  • request: Readonly<ZonedApiGetBackendRequest>

    The request ZonedApiGetBackendRequest

  Returns Promise<Backend>

  A Promise of Backend

getCertificate

• getCertificate(
      request: Readonly<ZonedApiGetCertificateRequest>,
  ): Promise<LB.v1.Certificate>

• Get an SSL/TLS certificate. Get information for a particular SSL/TLS certificate, specified by its certificate ID. The response returns full details of the certificate, including its type, main domain name, and alternative domain names.

  Parameters

  • request: Readonly<ZonedApiGetCertificateRequest>

    The request ZonedApiGetCertificateRequest

  Returns Promise<LB.v1.Certificate>

  A Promise of Certificate

getFrontend

• getFrontend(request: Readonly<ZonedApiGetFrontendRequest>): Promise<Frontend>

• Get a frontend. Get the full details of a given frontend, specified by its frontend ID. The response contains the frontend's full configuration parameters including the backend it is attached to, the port it listens on, and any certificates it has.

  Parameters

  • request: Readonly<ZonedApiGetFrontendRequest>

    The request ZonedApiGetFrontendRequest

  Returns Promise<Frontend>

  A Promise of Frontend

getIp

• getIp(request: Readonly<ZonedApiGetIpRequest>): Promise<LB.v1.Ip>

• Get an IP address. Retrieve the full details of a Load Balancer flexible IP address.

  Parameters

  • request: Readonly<ZonedApiGetIpRequest>

    The request ZonedApiGetIpRequest

  Returns Promise<LB.v1.Ip>

  A Promise of Ip

getLb

• getLb(request: Readonly<ZonedApiGetLbRequest>): Promise<LB.v1.Lb>

• Get a Load Balancer. Retrieve information about an existing Load Balancer, specified by its Load Balancer ID. Its full details, including name, status and IP address, are returned in the response object.

  Parameters

  • request: Readonly<ZonedApiGetLbRequest>

    The request ZonedApiGetLbRequest

  Returns Promise<LB.v1.Lb>

  A Promise of Lb

getLbStats

• getLbStats(request: Readonly<ZonedApiGetLbStatsRequest>): Promise<LbStats>

• Get usage statistics of a given Load Balancer.

  Parameters

  • request: Readonly<ZonedApiGetLbStatsRequest>

    The request ZonedApiGetLbStatsRequest

  Returns Promise<LbStats>

  A Promise of LbStats

  Deprecated

getRoute

• getRoute(request: Readonly<ZonedApiGetRouteRequest>): Promise<LB.v1.Route>

• Get a route. Retrieve information about an existing route, specified by its route ID. Its full details, origin frontend, target backend and match condition, are returned in the response object.

  Parameters

  • request: Readonly<ZonedApiGetRouteRequest>

    The request ZonedApiGetRouteRequest

  Returns Promise<LB.v1.Route>

  A Promise of Route

getSubscriber

• getSubscriber(
      request: Readonly<ZonedApiGetSubscriberRequest>,
  ): Promise<Subscriber>

• Get a subscriber. Retrieve information about an existing subscriber, specified by its subscriber ID. Its full details, including name and email/webhook configuration, are returned in the response object.

  Parameters

  • request: Readonly<ZonedApiGetSubscriberRequest>

    The request ZonedApiGetSubscriberRequest

  Returns Promise<Subscriber>

  A Promise of Subscriber

listAcls

• listAcls(
      request: Readonly<ZonedApiListAclsRequest>,
  ): Promise<ListAclResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Acl[], void, void>;
      all: () => Promise<Acl[]>;
  }

• List ACLs for a given frontend. List the ACLs for a given frontend, specified by its frontend ID. The response is an array of ACL objects, each one representing an ACL that denies or allows traffic based on certain conditions.

  Parameters

  • request: Readonly<ZonedApiListAclsRequest>

    The request ZonedApiListAclsRequest

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

  A Promise of ListAclResponse

listBackends

• listBackends(
      request: Readonly<ZonedApiListBackendsRequest>,
  ): Promise<ListBackendsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Backend[], void, void>;
      all: () => Promise<Backend[]>;
  }

• List the backends of a given Load Balancer. List all the backends of a Load Balancer, specified by its Load Balancer ID. By default, results are returned in ascending order by the creation date of each backend. The response is an array of backend objects, containing full details of each one including their configuration parameters such as protocol, port and forwarding algorithm.

  Parameters

  • request: Readonly<ZonedApiListBackendsRequest>

    The request ZonedApiListBackendsRequest

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

  A Promise of ListBackendsResponse

listBackendStats

• listBackendStats(
      request: Readonly<ZonedApiListBackendStatsRequest>,
  ): Promise<ListBackendStatsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          BackendServerStats[],
          void,
          void,
      >;
      all: () => Promise<BackendServerStats[]>;
  }

• List backend server statistics. List information about your backend servers, including their state and the result of their last health check.

  Parameters

  • request: Readonly<ZonedApiListBackendStatsRequest>

    The request ZonedApiListBackendStatsRequest

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

  A Promise of ListBackendStatsResponse

listCertificates

• listCertificates(
      request: Readonly<ZonedApiListCertificatesRequest>,
  ): Promise<ListCertificatesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<LB.v1.Certificate[], void, void>;
      all: () => Promise<LB.v1.Certificate[]>;
  }

• List all SSL/TLS certificates on a given Load Balancer. List all the SSL/TLS certificates on a given Load Balancer. The response is an array of certificate objects, which are by default listed in ascending order of creation date.

  Parameters

  • request: Readonly<ZonedApiListCertificatesRequest>

    The request ZonedApiListCertificatesRequest

  Returns Promise<ListCertificatesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<LB.v1.Certificate[], void, void>;
      all: () => Promise<LB.v1.Certificate[]>;
  }

  A Promise of ListCertificatesResponse

listFrontends

• listFrontends(
      request: Readonly<ZonedApiListFrontendsRequest>,
  ): Promise<ListFrontendsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Frontend[], void, void>;
      all: () => Promise<Frontend[]>;
  }

• List frontends of a given Load Balancer. List all the frontends of a Load Balancer, specified by its Load Balancer ID. By default, results are returned in ascending order by the creation date of each frontend. The response is an array of frontend objects, containing full details of each one including the port they listen on and the backend they are attached to.

  Parameters

  • request: Readonly<ZonedApiListFrontendsRequest>

    The request ZonedApiListFrontendsRequest

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

  A Promise of ListFrontendsResponse

listIPs

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

• List IP addresses. List the Load Balancer flexible IP addresses held in the account (filtered by Organization ID or Project ID). It is also possible to search for a specific IP address.

  Parameters

  • request: Readonly<ZonedApiListIPsRequest> = {}

    The request ZonedApiListIPsRequest

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

  A Promise of ListIpsResponse

listLbPrivateNetworks

• listLbPrivateNetworks(
      request: Readonly<ZonedApiListLbPrivateNetworksRequest>,
  ): Promise<ListLbPrivateNetworksResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          LB.v1.PrivateNetwork[],
          void,
          void,
      >;
      all: () => Promise<LB.v1.PrivateNetwork[]>;
  }

• List Private Networks attached to a Load Balancer. List the Private Networks attached to a given Load Balancer, specified by its Load Balancer ID. The response is an array of Private Network objects, giving information including the status, configuration, name and creation date of each Private Network.

  Parameters

  • request: Readonly<ZonedApiListLbPrivateNetworksRequest>

    The request ZonedApiListLbPrivateNetworksRequest

  Returns Promise<ListLbPrivateNetworksResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          LB.v1.PrivateNetwork[],
          void,
          void,
      >;
      all: () => Promise<LB.v1.PrivateNetwork[]>;
  }

  A Promise of ListLbPrivateNetworksResponse

listLbs

• listLbs(
      request?: Readonly<ZonedApiListLbsRequest>,
  ): Promise<ListLbsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<LB.v1.Lb[], void, void>;
      all: () => Promise<LB.v1.Lb[]>;
  }

• List Load Balancers. List all Load Balancers in the specified zone, for a Scaleway Organization or Scaleway Project. By default, the Load Balancers returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<ZonedApiListLbsRequest> = {}

    The request ZonedApiListLbsRequest

  Returns Promise<ListLbsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<LB.v1.Lb[], void, void>;
      all: () => Promise<LB.v1.Lb[]>;
  }

  A Promise of ListLbsResponse

listLbTypes

• listLbTypes(
      request?: Readonly<ZonedApiListLbTypesRequest>,
  ): Promise<ListLbTypesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<LbType[], void, void>;
      all: () => Promise<LbType[]>;
  }

• List all Load Balancer offer types. List all the different commercial Load Balancer types. The response includes an array of offer types, each with a name, description, and information about its stock availability.

  Parameters

  • request: Readonly<ZonedApiListLbTypesRequest> = {}

    The request ZonedApiListLbTypesRequest

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

  A Promise of ListLbTypesResponse

listRoutes

• listRoutes(
      request?: Readonly<ZonedApiListRoutesRequest>,
  ): Promise<LB.v1.ListRoutesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<LB.v1.Route[], void, void>;
      all: () => Promise<LB.v1.Route[]>;
  }

• List all routes. List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).

  Parameters

  • request: Readonly<ZonedApiListRoutesRequest> = {}

    The request ZonedApiListRoutesRequest

  Returns Promise<LB.v1.ListRoutesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<LB.v1.Route[], void, void>;
      all: () => Promise<LB.v1.Route[]>;
  }

  A Promise of ListRoutesResponse

listSubscriber

• listSubscriber(
      request?: Readonly<ZonedApiListSubscriberRequest>,
  ): Promise<ListSubscriberResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Subscriber[], void, void>;
      all: () => Promise<Subscriber[]>;
  }

• List all subscribers. List all subscribers to Load Balancer alerts. By default, returns all subscribers to Load Balancer alerts for the Organization associated with the authentication token used for the request.

  Parameters

  • request: Readonly<ZonedApiListSubscriberRequest> = {}

    The request ZonedApiListSubscriberRequest

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

  A Promise of ListSubscriberResponse

migrateLb

• migrateLb(request: Readonly<ZonedApiMigrateLbRequest>): Promise<LB.v1.Lb>

• Migrate a Load Balancer. Migrate an existing Load Balancer from one commercial type to another. Allows you to scale your Load Balancer up or down in terms of bandwidth or multi-cloud provision.

  Parameters

  • request: Readonly<ZonedApiMigrateLbRequest>

    The request ZonedApiMigrateLbRequest

  Returns Promise<LB.v1.Lb>

  A Promise of Lb

releaseIp

• releaseIp(request: Readonly<ZonedApiReleaseIpRequest>): Promise<void>

• Delete an IP address. Delete a Load Balancer flexible IP address. This action is irreversible, and cannot be undone.

  Parameters

  • request: Readonly<ZonedApiReleaseIpRequest>

    The request ZonedApiReleaseIpRequest

  Returns Promise<void>

removeBackendServers

• removeBackendServers(
      request: Readonly<ZonedApiRemoveBackendServersRequest>,
  ): Promise<Backend>

• Remove a set of servers for a given backend. For a given backend specified by its backend ID, remove the specified backend servers (identified by their IP addresses) so that it no longer forwards traffic to them.

  Parameters

  • request: Readonly<ZonedApiRemoveBackendServersRequest>

    The request ZonedApiRemoveBackendServersRequest

  Returns Promise<Backend>

  A Promise of Backend

setAcls

• setAcls(request: Readonly<ZonedApiSetAclsRequest>): Promise<SetAclsResponse>

• Define all ACLs for a given frontend. For a given frontend specified by its frontend ID, define and add the complete set of ACLS for that frontend. Any existing ACLs on this frontend will be removed.

  Parameters

  • request: Readonly<ZonedApiSetAclsRequest>

    The request ZonedApiSetAclsRequest

  Returns Promise<SetAclsResponse>

  A Promise of SetAclsResponse

setBackendServers

• setBackendServers(
      request: Readonly<ZonedApiSetBackendServersRequest>,
  ): Promise<Backend>

• Define all backend servers for a given backend. For a given backend specified by its backend ID, define the set of backend servers (identified by their IP addresses) that it should forward traffic to. Any existing backend servers configured for this backend will be removed.

  Parameters

  • request: Readonly<ZonedApiSetBackendServersRequest>

    The request ZonedApiSetBackendServersRequest

  Returns Promise<Backend>

  A Promise of Backend

subscribeToLb

• subscribeToLb(
      request: Readonly<ZonedApiSubscribeToLbRequest>,
  ): Promise<LB.v1.Lb>

• Subscribe a subscriber to alerts for a given Load Balancer. Subscribe an existing subscriber to alerts for a given Load Balancer.

  Parameters

  • request: Readonly<ZonedApiSubscribeToLbRequest>

    The request ZonedApiSubscribeToLbRequest

  Returns Promise<LB.v1.Lb>

  A Promise of Lb

unsubscribeFromLb

• unsubscribeFromLb(
      request: Readonly<ZonedApiUnsubscribeFromLbRequest>,
  ): Promise<LB.v1.Lb>

• Unsubscribe a subscriber from alerts for a given Load Balancer. Unsubscribe a subscriber from alerts for a given Load Balancer. The subscriber is not deleted, and can be resubscribed in the future if necessary.

  Parameters

  • request: Readonly<ZonedApiUnsubscribeFromLbRequest>

    The request ZonedApiUnsubscribeFromLbRequest

  Returns Promise<LB.v1.Lb>

  A Promise of Lb

updateAcl

• updateAcl(request: Readonly<ZonedApiUpdateAclRequest>): Promise<Acl>

• Update an ACL. Update a particular ACL, specified by its ACL ID. You can update details including its name, action and match rule.

  Parameters

  • request: Readonly<ZonedApiUpdateAclRequest>

    The request ZonedApiUpdateAclRequest

  Returns Promise<Acl>

  A Promise of Acl

updateBackend

• updateBackend(request: Readonly<ZonedApiUpdateBackendRequest>): Promise<Backend>

• Update a backend of a given Load Balancer. Update a backend of a given Load Balancer, specified by its backend ID. Note that the request type is PUT and not PATCH. You must set all parameters.

  Parameters

  • request: Readonly<ZonedApiUpdateBackendRequest>

    The request ZonedApiUpdateBackendRequest

  Returns Promise<Backend>

  A Promise of Backend

updateCertificate

• updateCertificate(
      request: Readonly<ZonedApiUpdateCertificateRequest>,
  ): Promise<LB.v1.Certificate>

• Update an SSL/TLS certificate. Update the name of a particular SSL/TLS certificate, specified by its certificate ID.

  Parameters

  • request: Readonly<ZonedApiUpdateCertificateRequest>

    The request ZonedApiUpdateCertificateRequest

  Returns Promise<LB.v1.Certificate>

  A Promise of Certificate

updateFrontend

• updateFrontend(
      request: Readonly<ZonedApiUpdateFrontendRequest>,
  ): Promise<Frontend>

• Update a frontend. Update a given frontend, specified by its frontend ID. You can update configuration parameters including its name and the port it listens on. Note that the request type is PUT and not PATCH. You must set all parameters.

  Parameters

  • request: Readonly<ZonedApiUpdateFrontendRequest>

    The request ZonedApiUpdateFrontendRequest

  Returns Promise<Frontend>

  A Promise of Frontend

updateHealthCheck

• updateHealthCheck(
      request: Readonly<ZonedApiUpdateHealthCheckRequest>,
  ): Promise<HealthCheck>

• Update a health check for a given backend. Update the configuration of the health check performed by a given backend to verify the health of its backend servers, identified by its backend ID. Note that the request type is PUT and not PATCH. You must set all parameters.

  Parameters

  • request: Readonly<ZonedApiUpdateHealthCheckRequest>

    The request ZonedApiUpdateHealthCheckRequest

  Returns Promise<HealthCheck>

  A Promise of HealthCheck

updateIp

• updateIp(request: Readonly<ZonedApiUpdateIpRequest>): Promise<LB.v1.Ip>

• Update an IP address. Update the reverse DNS of a Load Balancer flexible IP address.

  Parameters

  • request: Readonly<ZonedApiUpdateIpRequest>

    The request ZonedApiUpdateIpRequest

  Returns Promise<LB.v1.Ip>

  A Promise of Ip

updateLb

• updateLb(request: Readonly<ZonedApiUpdateLbRequest>): Promise<LB.v1.Lb>

• Update a Load Balancer. Update the parameters of an existing Load Balancer, specified by its Load Balancer ID. Note that the request type is PUT and not PATCH. You must set all parameters.

  Parameters

  • request: Readonly<ZonedApiUpdateLbRequest>

    The request ZonedApiUpdateLbRequest

  Returns Promise<LB.v1.Lb>

  A Promise of Lb

updateRoute

• updateRoute(request: Readonly<ZonedApiUpdateRouteRequest>): Promise<LB.v1.Route>

• Update a route. Update the configuration of an existing route, specified by its route ID.

  Parameters

  • request: Readonly<ZonedApiUpdateRouteRequest>

    The request ZonedApiUpdateRouteRequest

  Returns Promise<LB.v1.Route>

  A Promise of Route

updateSubscriber

• updateSubscriber(
      request: Readonly<ZonedApiUpdateSubscriberRequest>,
  ): Promise<Subscriber>

• Update a subscriber. Update the parameters of a given subscriber (e.g. name, webhook configuration, email configuration), specified by its subscriber ID.

  Parameters

  • request: Readonly<ZonedApiUpdateSubscriberRequest>

    The request ZonedApiUpdateSubscriberRequest

  Returns Promise<Subscriber>

  A Promise of Subscriber

waitForCertificate

• waitForCertificate(
      request: Readonly<ZonedApiGetCertificateRequest>,
      options?: Readonly<WaitForOptions<LB.v1.Certificate>>,
  ): Promise<LB.v1.Certificate>

• Waits for Certificate to be in a final state.

  Parameters

  • request: Readonly<ZonedApiGetCertificateRequest>

    The request ZonedApiGetCertificateRequest
  • Optionaloptions: Readonly<WaitForOptions<LB.v1.Certificate>>

    The waiting options

  Returns Promise<LB.v1.Certificate>

  A Promise of Certificate

waitForLb

• waitForLb(
      request: Readonly<ZonedApiGetLbRequest>,
      options?: Readonly<WaitForOptions<LB.v1.Lb>>,
  ): Promise<LB.v1.Lb>

• Waits for Lb to be in a final state.

  Parameters

  • request: Readonly<ZonedApiGetLbRequest>

    The request ZonedApiGetLbRequest
  • Optionaloptions: Readonly<WaitForOptions<LB.v1.Lb>>

    The waiting options

  Returns Promise<LB.v1.Lb>

  A Promise of Lb

waitForLbInstances

• waitForLbInstances(
      request: Readonly<GetLbRequest>,
      options?: Readonly<WaitForOptions<LB.v1.Lb>>,
  ): Promise<LB.v1.Lb>

• Waits for all instances of a (zoned) load balancer to be in a final state.

  Parameters

  • request: Readonly<GetLbRequest>

    The request GetLbRequest
  • Optionaloptions: Readonly<WaitForOptions<LB.v1.Lb>>

    The waiting options

  Returns Promise<LB.v1.Lb>

  A Promise of Lb

waitForLbPrivateNetworks

• waitForLbPrivateNetworks(
      request: Readonly<ZonedWaitForLbPrivateNetworksRequest>,
      options?: Readonly<WaitForOptions<ListLbPrivateNetworksResponse>>,
  ): Promise<ListLbPrivateNetworksResponse>

• Waits for all private networks of a (zoned) load balancer to be in a final state.

  Parameters

  • request: Readonly<ZonedWaitForLbPrivateNetworksRequest>

    The request ZonedWaitForLbPrivateNetworksRequest
  • Optionaloptions: Readonly<WaitForOptions<ListLbPrivateNetworksResponse>>

    The waiting options

  Returns Promise<ListLbPrivateNetworksResponse>

  A Promise of ListLbPrivateNetworksResponse