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

    Interface Service_keyRequestBuilder

    Builds and executes requests for operations under /v2/partner_network_connect/attachments/{pa_id}/service_key

    interface Service_keyRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Service_keyGetResponse>;
        post(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Service_keyPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Service_keyRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To get the current service key for a partner attachment, send a GET request to/v2/partner_network_connect/attachments/{pa_id}/service_key.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Service_keyGetResponse>

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

      This operation generates a new service key for the specified partner attachment. The operation is asynchronous, and the response is an empty JSON object returned with a 202 status code. To poll for the new service key, send a GET request to /v2/partner_network_connect/attachments/{pa_id}/service_key.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Service_keyPostResponse>

      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 get the current service key for a partner attachment, send a GET request to/v2/partner_network_connect/attachments/{pa_id}/service_key.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • This operation generates a new service key for the specified partner attachment. The operation is asynchronous, and the response is an empty JSON object returned with a 202 status code. To poll for the new service key, send a GET request to /v2/partner_network_connect/attachments/{pa_id}/service_key.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods