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

    Interface NeighborsRequestBuilder

    Builds and executes requests for operations under /v2/droplets/{droplet_id}/neighbors

    interface NeighborsRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | NeighborsGetResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): NeighborsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • To retrieve a list of any "neighbors" (i.e. Droplets that are co-located onthe same physical hardware) for a specific Droplet, send a GET request to/v2/droplets/$DROPLET_ID/neighbors.The results will be returned as a JSON object with a key of droplets. Thiswill be set to an array containing objects representing any other Dropletsthat share the same physical hardware. An empty array indicates that theDroplet is not co-located any other Droplets associated with your account.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | NeighborsGetResponse>

      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 retrieve a list of any "neighbors" (i.e. Droplets that are co-located onthe same physical hardware) for a specific Droplet, send a GET request to/v2/droplets/$DROPLET_ID/neighbors.The results will be returned as a JSON object with a key of droplets. Thiswill be set to an array containing objects representing any other Dropletsthat share the same physical hardware. An empty array indicates that theDroplet is not co-located any other Droplets associated with your account.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns NeighborsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods