Proxy PATCH request to connected app account

Makes a PATCH request to an external API on behalf of a connected app account. The Pipedream proxy handles OAuth credential injection and forwards the request with the provided body to the target API endpoint.

PATCH /app_accounts/{account_id}/proxy

Proxy PATCH request to connected app account

cURL

curl --request PATCH \
  --url https://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>"
}
'

import requests

url = "https://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy"

payload = { "url": "<string>" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>'})
};

fetch('https://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy"

	payload := strings.NewReader("{\n  \"url\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "<string>"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Proxy request failed"
}

Authorizations

X-API-Key · string · header · required

API key required for all endpoints

Headers

X-Target-URL · string<uri>

Alternative way to specify target URL via header

X-PD-Proxy-* · string

Custom headers to forward to the target API. Use X-PD-Proxy- prefix.

Path Parameters

account_id · string · required

The Pipedream account ID for the connected app

Example:

"apn_1234567"

Body

application/json

url · string<uri> · required

The target API endpoint URL

Response

200

application/json

Successful proxy request

Response from the target API