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

    Interface FirewallsRequestBuilder

    Builds and executes requests for operations under /v2/firewalls

    interface FirewallsRequestBuilder {
        byFirewall_id(firewall_id: string): WithFirewall_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                FirewallsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | FirewallsGetResponse>;
        post(
            body: Firewall,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | FirewallsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                FirewallsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Firewall,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): FirewallsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byFirewall_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    post

    • post(
          body: Firewall,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | FirewallsPostResponse>

      To create a new firewall, send a POST request to /v2/firewalls. The requestmust contain at least one inbound or outbound access rule.

      Parameters

      • body: Firewall

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | FirewallsPostResponse>

      error when the service returns a 400 status code

      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 create a new firewall, send a POST request to /v2/firewalls. The requestmust contain at least one inbound or outbound access rule.

      Parameters

      • body: Firewall

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns FirewallsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods