Evervault Relays API
Relay is a network proxy that can be configured to encrypt or decrypt sensitive data as it passes between a client and a destination server. Relay can be used with your own API or with third-party APIs. It is designed to be easy to use and requires minimal changes to your existing code.
Evervault Relays API is one of 12 APIs that Evervault publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Relays. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 9 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.
Requests are made against a single base URL, https://api.evervault.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Evervault Relays API declares
3 security schemes
for authenticating requests.
It accepts HTTP basic authentication (ApiKey).
It accepts HTTP bearer tokens (RunToken) (TokenAuth).
It accepts HTTP bearer tokens (Token) (ClientSideToken).
ApiKey— Authentication using an API key. The username is the App ID and the password is the Api Key.TokenAuth— Authentication using a short lived run token that you can share with clients. The Authorization header must be formatted as follow: "RunToken "ClientSideToken— Authentication using a short lived token that you can share with clients. The Authorization header must be formatted as follow: "Token "
Paths & Operations 9
Across 4 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Relay is a network proxy that can be configured to encrypt or decrypt sensitive data as it passes between a client and a destination server. Relay can be used with your own API or…
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Relay (9 properties), CustomDomain (7 properties), RelayRoute (4 properties), RelaySelection (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Evervault 11
Other APIs Evervault publishes across the network.