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

    Interface Droplet_neighbors_idsRequestBuilder

    Builds and executes requests for operations under /v2/reports/droplet_neighbors_ids

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

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • To retrieve a list of all Droplets that are co-located on the same physicalhardware, send a GET request to /v2/reports/droplet_neighbors_ids.The results will be returned as a JSON object with a key of neighbor_ids.This will be set to an array of arrays. Each array will contain a set ofDroplet IDs for Droplets that share a physical server. An empty arrayindicates that all Droplets associated with your account are located onseparate physical hardware.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Neighbor_ids>

      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 all Droplets that are co-located on the same physicalhardware, send a GET request to /v2/reports/droplet_neighbors_ids.The results will be returned as a JSON object with a key of neighbor_ids.This will be set to an array of arrays. Each array will contain a set ofDroplet IDs for Droplets that share a physical server. An empty arrayindicates that all Droplets associated with your account are located onseparate physical hardware.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods