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

    Interface VpcsRequestBuilder

    Builds and executes requests for operations under /v2/vpcs

    interface VpcsRequestBuilder {
        byVpc_id(vpc_id: string): WithVpc_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                VpcsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | VpcsGetResponse>;
        post(
            body: VpcsPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | VpcsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                VpcsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: VpcsPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): VpcsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byVpc_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all of the VPCs on your account, send a GET request to /v2/vpcs.

      Parameters

      Returns Promise<undefined | VpcsGetResponse>

      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

    post

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

      To create a VPC, send a POST request to /v2/vpcs specifying the attributesin the table below in the JSON body.Note: If you do not currently have a VPC network in a specific datacenterregion, the first one that you create will be set as the default for thatregion. The default VPC for a region cannot be changed or deleted.

      Parameters

      • body: VpcsPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | VpcsPostResponse>

      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 VPC, send a POST request to /v2/vpcs specifying the attributesin the table below in the JSON body.Note: If you do not currently have a VPC network in a specific datacenterregion, the first one that you create will be set as the default for thatregion. The default VPC for a region cannot be changed or deleted.

      Parameters

      • body: VpcsPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns VpcsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods