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

    Interface WithAction_ItemRequestBuilder

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

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

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • To retrieve a Droplet action, send a GET request to/v2/droplets/$DROPLET_ID/actions/$ACTION_ID.The response will be a JSON object with a key called action. The value willbe a Droplet action object.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithAction_GetResponse>

      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 Droplet action, send a GET request to/v2/droplets/$DROPLET_ID/actions/$ACTION_ID.The response will be a JSON object with a key called action. The value willbe a Droplet action object.

      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