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

    Interface OneClicksRequestBuilder

    Builds and executes requests for operations under /v2/1-clicks

    interface OneClicksRequestBuilder {
        get kubernetes(): KubernetesRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                OneClicksRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | OneClicksGetResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                OneClicksRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): OneClicksRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    Methods

    • To list all available 1-Click applications, send a GET request to /v2/1-clicks. The type maybe provided as query paramater in order to restrict results to a certain type of 1-Click, forexample: /v2/1-clicks?type=droplet. Current supported types are kubernetes and droplet.The response will be a JSON object with a key called 1_clicks. This will be set to an array of1-Click application data, each of which will contain the the slug and type for the 1-Click.

      Parameters

      Returns Promise<undefined | OneClicksGetResponse>

      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 available 1-Click applications, send a GET request to /v2/1-clicks. The type maybe provided as query paramater in order to restrict results to a certain type of 1-Click, forexample: /v2/1-clicks?type=droplet. Current supported types are kubernetes and droplet.The response will be a JSON object with a key called 1_clicks. This will be set to an array of1-Click application data, each of which will contain the the slug and type for the 1-Click.

      Parameters

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns OneClicksRequestBuilder