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

    Interface RegionsRequestBuilder

    Builds and executes requests for operations under /v2/regions

    interface RegionsRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                RegionsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | RegionsGetResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                RegionsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): RegionsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • To list all of the regions that are available, send a GET request to /v2/regions.The response will be a JSON object with a key called regions. The value of this will be an array of region objects, each of which will contain the standard region attributes.

      Parameters

      Returns Promise<undefined | RegionsGetResponse>

      error when the service returns a 401 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 list all of the regions that are available, send a GET request to /v2/regions.The response will be a JSON object with a key called regions. The value of this will be an array of region objects, each of which will contain the standard region attributes.

      Parameters

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns RegionsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods