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

    Interface PeeringsRequestBuilder

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

    interface PeeringsRequestBuilder {
        byVpc_peering_id(
            vpc_peering_id: string,
        ): WithVpc_peering_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                PeeringsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | PeeringsGetResponse>;
        post(
            body: PeeringsPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | PeeringsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                PeeringsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: PeeringsPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): PeeringsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byVpc_peering_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all of a VPC's peerings, send a GET request to/v2/vpcs/$VPC_ID/peerings.

      Parameters

      Returns Promise<undefined | PeeringsGetResponse>

      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: PeeringsPostRequestBody,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | PeeringsPostResponse>

      To create a new VPC peering for a given VPC, send a POST request to/v2/vpcs/$VPC_ID/peerings.

      Parameters

      • body: PeeringsPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | PeeringsPostResponse>

      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 create a new VPC peering for a given VPC, send a POST request to/v2/vpcs/$VPC_ID/peerings.

      Parameters

      • body: PeeringsPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns PeeringsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods