EVevervault
Core
Relays

Create a Relay

Creates a new Relay.

post/relays

Request

Request body

destinationDomainstring required

The domain in front of which you would like to configure a Relay

encryptEmptyStringsboolean

Whether or not empty strings should be encrypted. Defaults to true.

authentication'api-key' | 'null' nullable

The type of authentication required for the Relay

Example request

{
  "destinationDomain": "example.com",
  "routes": [
    {
      "method": "POST",
      "path": "/**",
      "request": [
        {
          "action": "encrypt",
          "selections": [
            {
              "type": "json",
              "role": "pci",
              "selector": "$.cardNumber"
            }
          ]
        }
      ],
      "response": [
        {
          "action": "encrypt",
          "selections": [
            {
              "type": "json",
              "role": "pci",
              "selector": "$.cardNumber"
            }
          ]
        }
      ]
    }
  ],
  "encryptEmptyStrings": true
}

Response

The Relay has been created

idstring required

The unique identifier for the Relay.

destinationDomainstring required

The domain in front of which the Relay should be configured.

evervaultDomainstring required

The Evervault managed domain to which requests to be relayed to the destination domain should be sent.

authentication'api-key' | 'null' nullable required

The type of authentication required for the Relay

encryptEmptyStringsboolean required

Whether or not empty strings should be encrypted.

appstring required

The unique identifier for the app to which the Relay belongs.

createdAtinteger required

The exact time, in epoch milliseconds, when this Relay was created.

updatedAtinteger required

The exact time, in epoch milliseconds, when this Relay was updated.

Example response

{
  "id": "relay_destination_d4ja57js9lnh",
  "destinationDomain": "example.com",
  "evervaultDomain": "example-com.app-12345.relay.evervault.app",
  "encryptEmptyStrings": true,
  "authentication": null,
  "routes": [
    {
      "method": "POST",
      "path": "/checkout",
      "request": [
        {
          "action": "encrypt",
          "selections": [
            {
              "type": "json",
              "role": "pci",
              "selector": "$.cardNumber"
            }
          ]
        }
      ],
      "response": [
        {
          "action": "decrypt",
          "selections": [
            {
              "type": "json",
              "selector": "$..*"
            }
          ]
        }
      ]
    }
  ],
  "app": "app_cc7fcd533649",
  "createdAt": 1692972623233,
  "updatedAt": 1692972623234
}

Changes

No recorded changes to this operation across all 1 revision of this API.