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

    Interface WithFirewall_ItemRequestBuilder

    Builds and executes requests for operations under /v2/firewalls/{firewall_id}

    interface WithFirewall_ItemRequestBuilder {
        get droplets(): DropletsRequestBuilder;
        get rules(): RulesRequestBuilder;
        get tags(): TagsRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithFirewall_GetResponse>;
        put(
            body: Firewall,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithFirewall_PutResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: Firewall,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithFirewall_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    droplets rules tags

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To delete a firewall send a DELETE request to /v2/firewalls/$FIREWALL_ID.No response body will be sent back, but the response code will indicatesuccess. Specifically, the response code will be a 204, which means that theaction was successful with no returned body data.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<void>

      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 show information about an existing firewall, send a GET request to /v2/firewalls/$FIREWALL_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithFirewall_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 update the configuration of an existing firewall, send a PUT request to/v2/firewalls/$FIREWALL_ID. The request should contain a full representationof the firewall including existing attributes. Note that any attributes thatare not provided will be reset to their default values.

      You must have read access (e.g. droplet:read) to all resources attachedto the firewall to successfully update the firewall.

      Parameters

      • body: Firewall

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithFirewall_PutResponse>

      error when the service returns a 400 status code

      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 delete a firewall send a DELETE request to /v2/firewalls/$FIREWALL_ID.No response body will be sent back, but the response code will indicatesuccess. Specifically, the response code will be a 204, which means that theaction was successful with no returned body data.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To show information about an existing firewall, send a GET request to /v2/firewalls/$FIREWALL_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update the configuration of an existing firewall, send a PUT request to/v2/firewalls/$FIREWALL_ID. The request should contain a full representationof the firewall including existing attributes. Note that any attributes thatare not provided will be reset to their default values.

      You must have read access (e.g. droplet:read) to all resources attachedto the firewall to successfully update the firewall.

      Parameters

      • body: Firewall

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods