Skip to main content
POST
/
unified
/
proxy
Proxy Request (Legacy)
curl --request POST \
  --url https://api.stackone.com/unified/proxy \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "url": "https://api.sample-integration.com/v1",
  "method": "get",
  "path": "/employees/directory",
  "headers": {
    "Content-Type": "application/json"
  },
  "body": {}
}
'
import requests

url = "https://api.stackone.com/unified/proxy"

payload = {
    "url": "https://api.sample-integration.com/v1",
    "method": "get",
    "path": "/employees/directory",
    "headers": { "Content-Type": "application/json" },
    "body": {}
}
headers = {
    "x-account-id": "<x-account-id>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-account-id': '<x-account-id>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://api.sample-integration.com/v1',
    method: 'get',
    path: '/employees/directory',
    headers: {'Content-Type': 'application/json'},
    body: JSON.stringify({})
  })
};

fetch('https://api.stackone.com/unified/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://api.stackone.com/unified/proxy",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://api.sample-integration.com/v1',
    'method' => 'get',
    'path' => '/employees/directory',
    'headers' => [
        'Content-Type' => 'application/json'
    ],
    'body' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json",
    "x-account-id: <x-account-id>"
  ],
]);

$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://api.stackone.com/unified/proxy"

	payload := strings.NewReader("{\n  \"url\": \"https://api.sample-integration.com/v1\",\n  \"method\": \"get\",\n  \"path\": \"/employees/directory\",\n  \"headers\": {\n    \"Content-Type\": \"application/json\"\n  },\n  \"body\": {}\n}")

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

	req.Header.Add("x-account-id", "<x-account-id>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.post("https://api.stackone.com/unified/proxy")
  .header("x-account-id", "<x-account-id>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://api.sample-integration.com/v1\",\n  \"method\": \"get\",\n  \"path\": \"/employees/directory\",\n  \"headers\": {\n    \"Content-Type\": \"application/json\"\n  },\n  \"body\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.stackone.com/unified/proxy")

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

request = Net::HTTP::Post.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://api.sample-integration.com/v1\",\n  \"method\": \"get\",\n  \"path\": \"/employees/directory\",\n  \"headers\": {\n    \"Content-Type\": \"application/json\"\n  },\n  \"body\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "status": 200,
  "headers": {
    "content-type": "application/json",
    "x-request-id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "data": {
    "id": "123",
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.someprovider.com/v1/endpoint",
      "raw": {
        "error": "Bad Request",
        "message": "The supplied data is invalid"
      },
      "headers": {
        "date": "Tue, 02 Apr 2024 13:52:01 GMT",
        "content-type": "application/json; charset=utf-8"
      }
    }
  ]
}
{
  "status": 200,
  "headers": {
    "content-type": "application/json",
    "x-request-id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "data": {
    "id": "123",
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.someprovider.com/v1/endpoint",
      "raw": {
        "error": "Bad Request",
        "message": "The supplied data is invalid"
      },
      "headers": {
        "date": "Tue, 02 Apr 2024 13:52:01 GMT",
        "content-type": "application/json; charset=utf-8"
      }
    }
  ]
}
{
  "status": 200,
  "headers": {
    "content-type": "application/json",
    "x-request-id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "data": {
    "id": "123",
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.someprovider.com/v1/endpoint",
      "raw": {
        "error": "Bad Request",
        "message": "The supplied data is invalid"
      },
      "headers": {
        "date": "Tue, 02 Apr 2024 13:52:01 GMT",
        "content-type": "application/json; charset=utf-8"
      }
    }
  ]
}
{
  "status": 200,
  "headers": {
    "content-type": "application/json",
    "x-request-id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "data": {
    "id": "123",
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.someprovider.com/v1/endpoint",
      "raw": {
        "error": "Bad Request",
        "message": "The supplied data is invalid"
      },
      "headers": {
        "date": "Tue, 02 Apr 2024 13:52:01 GMT",
        "content-type": "application/json; charset=utf-8"
      }
    }
  ]
}
{
  "statusCode": 400,
  "message": "Bad Request",
  "timestamp": "2023-05-30T00:00:00.000Z",
  "data": {
    "statusCode": 400,
    "message": "Bad Request",
    "headers": {
      "content-type": "application/json",
      "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
    }
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.provider.com/v1/resource",
      "raw": {
        "message": "Invalid input parameters"
      },
      "headers": {
        "content-type": "application/json",
        "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
      }
    }
  ]
}
{
  "statusCode": 401,
  "message": "Unauthorized",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 403,
  "message": "Forbidden resource",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 404,
  "message": "Not Found",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 408,
  "message": "Request timed out",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 409,
  "message": "Conflict",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 412,
  "message": "Precondition failed",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 422,
  "message": "Unprocessable Entity",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 429,
  "message": "Too many requests",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 500,
  "message": "Internal server error",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 501,
  "message": "Not Implemented",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 502,
  "message": "Bad Gateway",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
This endpoint is deprecated

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

​
Prefer
string

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example:

"heartbeat"

Body

application/json

The request body

​
url
string | null

The base url of the request

Example:

"https://api.sample-integration.com/v1"

​
method
enum<string> | null
default:get

The method of the request

Available options:
get,
post,
put,
delete,
patch,
null
​
path
string | null

The path of the request including any query parameters

Example:

"/employees/directory"

​
headers
object | null

The headers to send in the request

Example:
{ "Content-Type": "application/json" }
​
body
object | null

The body of the request

Response

The proxy request was successful.

​
status
number
required

The HTTP status code returned by the provider

Example:

200

​
headers
object | null

The headers returned by the provider

Example:
{
  "content-type": "application/json",
  "x-request-id": "123e4567-e89b-12d3-a456-426614174000"
}
​
data

The response data from the provider. Can be an object, array, or primitive value.

Example:
{
  "id": "123",
  "name": "John Doe",
  "email": "john.doe@example.com"
}
​
provider_errors
object[] | null

Provider-specific errors if any occurred

Example:
[
  {
    "status": 400,
    "url": "https://api.someprovider.com/v1/endpoint",
    "raw": {
      "error": "Bad Request",
      "message": "The supplied data is invalid"
    },
    "headers": {
      "date": "Tue, 02 Apr 2024 13:52:01 GMT",
      "content-type": "application/json; charset=utf-8"
    }
  }
]