# Proxy API — Execute

> Canonical URL: https://developers.apideck.com/apis/proxy/reference#tag/Execute

This document contains every operation on the `Execute` resource.

---

# GET

> **Proxy API** · `GET /proxy`
> Canonical URL: https://developers.apideck.com/apis/proxy/reference#tag/Execute/operation/getProxy

## Authentication

- Send `Authorization: Bearer $API_KEY` using your Apideck secret API key. Keep the key server-side; never put it in a URL or client-side code.

Use the application, consumer and connector headers listed in Parameters below for this operation.

Proxies a downstream GET request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional security layer and logging without needing to rely on Unify for normalization.
**Note**: Vault will proxy all data to the downstream URL and method/verb in the headers.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | Yes | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
| `x-apideck-unified-api` | header | `string` | No | Specify which unified API to use for the connection lookup. Required for multi-API connectors (e.g., Workday) to ensure the correct credentials are used. |
| `x-apideck-downstream-url` | header | `string` | Yes | Downstream URL |
| `x-apideck-downstream-authorization` | header | `string` | No | Downstream authorization header. This will skip the Vault token injection. |
| `x-apideck-timeout` | header | `integer` | No | Override the default downstream request timeout in milliseconds. The default is 28000 (28 seconds). |
| `x-apideck-follow-redirects` | header | `boolean` | No | Set to `false` to opt out of the redirect to the presigned download URL. Instead of a `30x` response, you receive a `200` JSON body `{ url, expires_at }` containing the URL and its expiry, which you can fetch explicitly. Use this if your client automatically forwards the `Authorization` header onto redirects, since the downstream storage provider will reject that request. Any value other than `false` (or omitting the header) preserves the default redirect behavior. |

### Responses

#### 200 — Ok. When the request includes `x-apideck-follow-redirects: false` and the downstream response would otherwise redirect to a presigned URL (oversized responses), the body is instead an `application/json` object `{ url, expires_at }` — fetch `url` explicitly (without the Authorization header) to retrieve the payload.

#### 401 — Unauthorized

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### default — Proxy error

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

---

# PUT

> **Proxy API** · `PUT /proxy`
> Canonical URL: https://developers.apideck.com/apis/proxy/reference#tag/Execute/operation/putProxy

## Authentication

- Send `Authorization: Bearer $API_KEY` using your Apideck secret API key. Keep the key server-side; never put it in a URL or client-side code.

Use the application, consumer and connector headers listed in Parameters below for this operation.

Proxies a downstream PUT request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional security layer and logging without needing to rely on Unify for normalization.
**Note**: Vault will proxy all data to the downstream URL and method/verb in the headers.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | Yes | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
| `x-apideck-unified-api` | header | `string` | No | Specify which unified API to use for the connection lookup. Required for multi-API connectors (e.g., Workday) to ensure the correct credentials are used. |
| `x-apideck-downstream-url` | header | `string` | Yes | Downstream URL |
| `x-apideck-downstream-authorization` | header | `string` | No | Downstream authorization header. This will skip the Vault token injection. |
| `x-apideck-timeout` | header | `integer` | No | Override the default downstream request timeout in milliseconds. The default is 28000 (28 seconds). |
| `x-apideck-follow-redirects` | header | `boolean` | No | Set to `false` to opt out of the redirect to the presigned download URL. Instead of a `30x` response, you receive a `200` JSON body `{ url, expires_at }` containing the URL and its expiry, which you can fetch explicitly. Use this if your client automatically forwards the `Authorization` header onto redirects, since the downstream storage provider will reject that request. Any value other than `false` (or omitting the header) preserves the default redirect behavior. |

### Responses

#### 200 — Ok. When the request includes `x-apideck-follow-redirects: false` and the downstream response would otherwise redirect to a presigned URL (oversized responses), the body is instead an `application/json` object `{ url, expires_at }` — fetch `url` explicitly (without the Authorization header) to retrieve the payload.

#### 401 — Unauthorized

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### default — Proxy error

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

---

# POST

> **Proxy API** · `POST /proxy`
> Canonical URL: https://developers.apideck.com/apis/proxy/reference#tag/Execute/operation/postProxy

## Authentication

- Send `Authorization: Bearer $API_KEY` using your Apideck secret API key. Keep the key server-side; never put it in a URL or client-side code.

Use the application, consumer and connector headers listed in Parameters below for this operation.

Proxies a downstream POST request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional security layer and logging without needing to rely on Unify for normalization.
**Note**: Vault will proxy all data to the downstream URL and method/verb in the headers.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | Yes | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
| `x-apideck-unified-api` | header | `string` | No | Specify which unified API to use for the connection lookup. Required for multi-API connectors (e.g., Workday) to ensure the correct credentials are used. |
| `x-apideck-downstream-url` | header | `string` | Yes | Downstream URL |
| `x-apideck-downstream-authorization` | header | `string` | No | Downstream authorization header. This will skip the Vault token injection. |
| `x-apideck-timeout` | header | `integer` | No | Override the default downstream request timeout in milliseconds. The default is 28000 (28 seconds). |
| `x-apideck-follow-redirects` | header | `boolean` | No | Set to `false` to opt out of the redirect to the presigned download URL. Instead of a `30x` response, you receive a `200` JSON body `{ url, expires_at }` containing the URL and its expiry, which you can fetch explicitly. Use this if your client automatically forwards the `Authorization` header onto redirects, since the downstream storage provider will reject that request. Any value other than `false` (or omitting the header) preserves the default redirect behavior. |

### Responses

#### 200 — Ok. When the request includes `x-apideck-follow-redirects: false` and the downstream response would otherwise redirect to a presigned URL (oversized responses), the body is instead an `application/json` object `{ url, expires_at }` — fetch `url` explicitly (without the Authorization header) to retrieve the payload.

#### 401 — Unauthorized

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### default — Proxy error

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

---

# DELETE

> **Proxy API** · `DELETE /proxy`
> Canonical URL: https://developers.apideck.com/apis/proxy/reference#tag/Execute/operation/deleteProxy

## Authentication

- Send `Authorization: Bearer $API_KEY` using your Apideck secret API key. Keep the key server-side; never put it in a URL or client-side code.

Use the application, consumer and connector headers listed in Parameters below for this operation.

Proxies a downstream DELETE request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional security layer and logging without needing to rely on Unify for normalization.
**Note**: Vault will proxy all data to the downstream URL and method/verb in the headers.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | Yes | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
| `x-apideck-unified-api` | header | `string` | No | Specify which unified API to use for the connection lookup. Required for multi-API connectors (e.g., Workday) to ensure the correct credentials are used. |
| `x-apideck-downstream-url` | header | `string` | Yes | Downstream URL |
| `x-apideck-downstream-authorization` | header | `string` | No | Downstream authorization header. This will skip the Vault token injection. |
| `x-apideck-timeout` | header | `integer` | No | Override the default downstream request timeout in milliseconds. The default is 28000 (28 seconds). |
| `x-apideck-follow-redirects` | header | `boolean` | No | Set to `false` to opt out of the redirect to the presigned download URL. Instead of a `30x` response, you receive a `200` JSON body `{ url, expires_at }` containing the URL and its expiry, which you can fetch explicitly. Use this if your client automatically forwards the `Authorization` header onto redirects, since the downstream storage provider will reject that request. Any value other than `false` (or omitting the header) preserves the default redirect behavior. |

### Responses

#### 200 — Ok. When the request includes `x-apideck-follow-redirects: false` and the downstream response would otherwise redirect to a presigned URL (oversized responses), the body is instead an `application/json` object `{ url, expires_at }` — fetch `url` explicitly (without the Authorization header) to retrieve the payload.

#### 401 — Unauthorized

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### default — Proxy error

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

---

# PATCH

> **Proxy API** · `PATCH /proxy`
> Canonical URL: https://developers.apideck.com/apis/proxy/reference#tag/Execute/operation/patchProxy

## Authentication

- Send `Authorization: Bearer $API_KEY` using your Apideck secret API key. Keep the key server-side; never put it in a URL or client-side code.

Use the application, consumer and connector headers listed in Parameters below for this operation.

Proxies a downstream PATCH request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional security layer and logging without needing to rely on Unify for normalization.
**Note**: Vault will proxy all data to the downstream URL and method/verb in the headers.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | Yes | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
| `x-apideck-unified-api` | header | `string` | No | Specify which unified API to use for the connection lookup. Required for multi-API connectors (e.g., Workday) to ensure the correct credentials are used. |
| `x-apideck-downstream-url` | header | `string` | Yes | Downstream URL |
| `x-apideck-downstream-authorization` | header | `string` | No | Downstream authorization header. This will skip the Vault token injection. |
| `x-apideck-timeout` | header | `integer` | No | Override the default downstream request timeout in milliseconds. The default is 28000 (28 seconds). |
| `x-apideck-follow-redirects` | header | `boolean` | No | Set to `false` to opt out of the redirect to the presigned download URL. Instead of a `30x` response, you receive a `200` JSON body `{ url, expires_at }` containing the URL and its expiry, which you can fetch explicitly. Use this if your client automatically forwards the `Authorization` header onto redirects, since the downstream storage provider will reject that request. Any value other than `false` (or omitting the header) preserves the default redirect behavior. |

### Responses

#### 200 — Ok. When the request includes `x-apideck-follow-redirects: false` and the downstream response would otherwise redirect to a presigned URL (oversized responses), the body is instead an `application/json` object `{ url, expires_at }` — fetch `url` explicitly (without the Authorization header) to retrieve the payload.

#### 401 — Unauthorized

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### default — Proxy error

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

---

# OPTIONS

> **Proxy API** · `OPTIONS /proxy`
> Canonical URL: https://developers.apideck.com/apis/proxy/reference#tag/Execute/operation/optionsProxy

## Authentication

- Send `Authorization: Bearer $API_KEY` using your Apideck secret API key. Keep the key server-side; never put it in a URL or client-side code.

Use the application, consumer and connector headers listed in Parameters below for this operation.

Proxies a downstream OPTION request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional security layer and logging without needing to rely on Unify for normalization.
**Note**: Vault will proxy all data to the downstream URL and method/verb in the headers.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | Yes | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
| `x-apideck-unified-api` | header | `string` | No | Specify which unified API to use for the connection lookup. Required for multi-API connectors (e.g., Workday) to ensure the correct credentials are used. |
| `x-apideck-downstream-url` | header | `string` | Yes | Downstream URL |
| `x-apideck-downstream-authorization` | header | `string` | No | Downstream authorization header. This will skip the Vault token injection. |
| `x-apideck-timeout` | header | `integer` | No | Override the default downstream request timeout in milliseconds. The default is 28000 (28 seconds). |
| `x-apideck-follow-redirects` | header | `boolean` | No | Set to `false` to opt out of the redirect to the presigned download URL. Instead of a `30x` response, you receive a `200` JSON body `{ url, expires_at }` containing the URL and its expiry, which you can fetch explicitly. Use this if your client automatically forwards the `Authorization` header onto redirects, since the downstream storage provider will reject that request. Any value other than `false` (or omitting the header) preserves the default redirect behavior. |

### Responses

#### 200 — Ok. When the request includes `x-apideck-follow-redirects: false` and the downstream response would otherwise redirect to a presigned URL (oversized responses), the body is instead an `application/json` object `{ url, expires_at }` — fetch `url` explicitly (without the Authorization header) to retrieve the payload.

#### 401 — Unauthorized

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### default — Proxy error

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

---