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

    Interface FirewallsRequestBuilder

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

    interface FirewallsRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                FirewallsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | FirewallsGetResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                FirewallsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): FirewallsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • To retrieve a list of all firewalls available to a Droplet, send a GET requestto /v2/droplets/$DROPLET_ID/firewallsThe response will be a JSON object that has a key called firewalls. This willbe set to an array of firewall objects, each of which contain the standardfirewall attributes.

      Parameters

      Returns Promise<undefined | FirewallsGetResponse>

      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 firewalls available to a Droplet, send a GET requestto /v2/droplets/$DROPLET_ID/firewallsThe response will be a JSON object that has a key called firewalls. This willbe set to an array of firewall objects, each of which contain the standardfirewall attributes.

      Parameters

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns FirewallsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods