@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface DropletsRequestBuilder

    Builds and executes requests for operations under /v2/load_balancers/{lb_id}/droplets

    interface DropletsRequestBuilder {
        delete(
            body: DropletsDeleteRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        post(
            body: DropletsPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        toDeleteRequestInformation(
            body: DropletsDeleteRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: DropletsPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): DropletsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete post toDeleteRequestInformation toPostRequestInformation withUrl

    Methods

    • To remove a Droplet from a load balancer instance, send a DELETE request to/v2/load_balancers/$LOAD_BALANCER_ID/droplets. In the body of the request,there should be a droplet_ids attribute containing a list of Droplet IDs.No response body will be sent back, but the response code will indicatesuccess. Specifically, the response code will be a 204, which means that theaction was successful with no returned body data.

      Parameters

      • body: DropletsDeleteRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<void>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    post

    • post(
          body: DropletsPostRequestBody,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<void>

      To assign a Droplet to a load balancer instance, send a POST request to/v2/load_balancers/$LOAD_BALANCER_ID/droplets. In the body of the request,there should be a droplet_ids attribute containing a list of Droplet IDs.Individual Droplets can not be added to a load balancer configured with aDroplet tag. Attempting to do so will result in a "422 Unprocessable Entity"response from the API.No response body will be sent back, but the response code will indicatesuccess. Specifically, the response code will be a 204, which means that theaction was successful with no returned body data.

      Parameters

      • body: DropletsPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<void>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To remove a Droplet from a load balancer instance, send a DELETE request to/v2/load_balancers/$LOAD_BALANCER_ID/droplets. In the body of the request,there should be a droplet_ids attribute containing a list of Droplet IDs.No response body will be sent back, but the response code will indicatesuccess. Specifically, the response code will be a 204, which means that theaction was successful with no returned body data.

      Parameters

      • body: DropletsDeleteRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To assign a Droplet to a load balancer instance, send a POST request to/v2/load_balancers/$LOAD_BALANCER_ID/droplets. In the body of the request,there should be a droplet_ids attribute containing a list of Droplet IDs.Individual Droplets can not be added to a load balancer configured with aDroplet tag. Attempting to do so will result in a "422 Unprocessable Entity"response from the API.No response body will be sent back, but the response code will indicatesuccess. Specifically, the response code will be a 204, which means that theaction was successful with no returned body data.

      Parameters

      • body: DropletsPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns DropletsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods