YAML Config file

YAML feature currently allows to view, export and import the routes configuration in YAML format.

Viewing and Exporting Route Configurations

Export a single route

To view a route configuration in YAML format and export it:

• Open the route details

• Click Export YAML and check the YAML config preview

• Click Export

Once saved, you can check the route configuration locally and use it to promote your route from Sandbox to Live.

Export all routes

To export all routes from the current vault follow the next steps:

• Open All routes page

• Click Manage

• Select Export > All as YAML

All routes configs will be downloaded in one YAML file named as vault_id.yaml.

Creating and Promoting Routes

The term "promoting" assumes that the Admin user is supposed to "clone" the existing routes from Sandbox to Live. This can be done with the help of YAML feature (i.e. export, import routes).

Note. Promoting routes via YAML feature allows you to overwrite existing routes configurations which leads to problems if you don't pay attention to a route id. Be careful when re-using route configurations in Live vaults.

Before going to Live check the next:

• Upstream host is updated to the Live host, no test server (VGS echo server) or wildcard (.*) is used

• Outbound routes have IP Whitelisting enabled for better security protection.

More useful tips about going Live are mentioned in our guide.

Import a single route

To create or update an existing route:

• Go to the Routes page

• Click Manage

• Select Import > YAML

• Select a YAML file. If there is no route with such a route ID, a new one will be created, and a corresponding notification about successful creation will show up. If such route already exists, you will see a warning message asking whether you are sure you would like to update the existing route

• Check the route details of the created/updated route

Import multiple routes

To import multiple routes:

• Go to the Routes page

• Click Manage

• Select Import > YAML

• Select a YAML file with multiple configs. If there are some routes to update, confirm/skip the updates for each route or update all at once

• After importing the routes list will be opened

Routes Versioning

It’s possible to view the route edits and revert the changes via Audit Logs. All route changes will be displayed as YAML configs.

Routes tagging

To help you manage your routes more effectively, assign your own metadata to each route in the form of tags. A tag is a label that you assign to a route. Tags enable you to categorize your routes in different ways, for example, by purpose, owner, or environment. This is useful when you have many routes of the same type — you can quickly identify a specific route based on the tags you’ve assigned to it. For example, you can define a set of tags for your live routes that send traffic to Stripe. How to set up a tag

Via Dashboard

• Go to specific route and view YAML

• Export YAML

• Find tags field and add new tag. Ex. tags: {"name": "This is cool name"}

• Import route from YAML file

Via CLI

• dump-all route command

• edit tags for one or few routes in the file

• sync-all route command with the file

• dump-all routes again to see that tags were saved

Tag restrictions

• maximum amount of tags - 5

• maximum length of key and value can’t be more then 150 characters