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

    Interface WithVpc_ItemRequestBuilder

    Builds and executes requests for operations under /v2/vpcs/{vpc_id}

    interface WithVpc_ItemRequestBuilder {
        get members(): MembersRequestBuilder;
        get peerings(): PeeringsRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithVpc_GetResponse>;
        patch(
            body: WithVpc_PatchRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithVpc_PatchResponse>;
        put(
            body: WithVpc_PutRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithVpc_PutResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPatchRequestInformation(
            body: WithVpc_PatchRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: WithVpc_PutRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithVpc_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    members peerings

    Methods

    delete get patch put toDeleteRequestInformation toGetRequestInformation toPatchRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To delete a VPC, send a DELETE request to /v2/vpcs/$VPC_ID. A 204 statuscode with no body will be returned in response to a successful request.The default VPC for a region can not be deleted. Additionally, a VPC can onlybe deleted if it does not contain any member resources. Attempting to deletea region's default VPC or a VPC that still has members will result in a403 Forbidden error response.

      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 VPC, send a GET request to /v2/vpcs/$VPC_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithVpc_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 a subset of information about a VPC, send a PATCH request to/v2/vpcs/$VPC_ID.

      Parameters

      • body: WithVpc_PatchRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithVpc_PatchResponse>

      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 information about a VPC, send a PUT request to /v2/vpcs/$VPC_ID.

      Parameters

      • body: WithVpc_PutRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithVpc_PutResponse>

      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 VPC, send a DELETE request to /v2/vpcs/$VPC_ID. A 204 statuscode with no body will be returned in response to a successful request.The default VPC for a region can not be deleted. Additionally, a VPC can onlybe deleted if it does not contain any member resources. Attempting to deletea region's default VPC or a VPC that still has members will result in a403 Forbidden error response.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To show information about an existing VPC, send a GET request to /v2/vpcs/$VPC_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update a subset of information about a VPC, send a PATCH request to/v2/vpcs/$VPC_ID.

      Parameters

      • body: WithVpc_PatchRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update information about a VPC, send a PUT request to /v2/vpcs/$VPC_ID.

      Parameters

      • body: WithVpc_PutRequestBody

        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