EVevervault
Core
Relays

Updates a Relay

Changed on

Updates a Relay. Any properties not provided are left unchanged.

patch/relays/{id}

Request

Path parameters

idstring required

The id of the Relay to be updated.

Request body

encryptEmptyStringsboolean

Whether or not empty strings should be encrypted.

authentication'api-key' | 'null' nullable

The type of authentication required for the Relay.

Example request

{
  "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 updated

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

  • 8d0ca833fa04Revision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • 5e1eb58d42d5Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • info

      the request property became nullable

    • info

      added the new api-key enum value to the request property

    • info

      added the new undefined enum value to the request property