Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Proxy API

Send requests directly to an integration provider, on behalf of Connected Users. The Proxy API allows you to access any third-party provider's API methods via Paragon's managed credential handling. Supports any HTTP verb and accepts JSON request bodies. Along with Workflows, the Proxy API is one of two primary ways to build integrations with Paragon.

Proxy API is one of 10 APIs that Paragon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Embedded Integrations, Proxy, and Integrations. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and a JSON-LD context.

This API exposes 7 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://actionkit.useparagon.com.

7 operations 2 paths 0 schemas 1 DELETE2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://actionkit.useparagon.com
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Proxy API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Paragon User Token. A signed JWT token used to authenticate a Connected User.

Paths & Operations 7

Across 2 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Proxy 7

Proxy requests to third-party integration APIs.

GET
/projects/{projectId}/sdk/proxy/{integrationType}/{apiPath}
Paragon Proxy GET request to integration
proxyGetRequest 3 params → 200401404429
POST
/projects/{projectId}/sdk/proxy/{integrationType}/{apiPath}
Paragon Proxy POST request to integration
proxyPostRequest 3 params body → 200401404429
PUT
/projects/{projectId}/sdk/proxy/{integrationType}/{apiPath}
Paragon Proxy PUT request to integration
proxyPutRequest 3 params body → 200401404429
PATCH
/projects/{projectId}/sdk/proxy/{integrationType}/{apiPath}
Paragon Proxy PATCH request to integration
proxyPatchRequest 3 params body → 200401404429
DELETE
/projects/{projectId}/sdk/proxy/{integrationType}/{apiPath}
Paragon Proxy DELETE request to integration
proxyDeleteRequest 3 params → 200401404429
GET
/projects/{projectId}/sdk/proxy/custom/{integrationId}/{apiPath}
Paragon Proxy GET request to custom integration
proxyCustomGetRequest 3 params → 200401404429
POST
/projects/{projectId}/sdk/proxy/custom/{integrationId}/{apiPath}
Paragon Proxy POST request to custom integration
proxyCustomPostRequest 3 params body → 200401404429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paragon-proxy-api-openapi.yml Raw ↑

Other APIs Paragon publishes across the network.

Users API
Task History API
Triggers API
Paragon Credentials API
Paragon Custom Integrations API
Paragon Integrations API
Paragon Permissions API
Paragon Sync API
Paragon Tools API