Tyk Sync
Last updated: 3 minutes read.
Tyk Sync is a command line (CLI) tool designed to streamline the implementation of GitOps for API management. It enables users to store API definitions, security policies, and API templates as files in version control system (VCS) or file system and synchronize changes to Tyk, promoting a consistent and automated approach to managing API configurations.
If you are Kubernetes users, Tyk Operator is another tool that offer GitOps for API management through Kubernetes-native custom resources.
Features
Tyk Sync works with the Open Source Tyk Gateway and Tyk Dashboard installation. However with Tyk Gateway, Tyk Sync supports managing Classic API definitions only. With Tyk Dashboard, Tyk Sync supports managing Classic and OAS API definitions, security policies, and API templates.
| Tyk Sync Feature | Tyk Gateway (OSS) | Tyk Dashboard (Licensed) |
|---|---|---|
Backup objects from Tyk to a directoryIf you want to backup your API definitions, policies and templates in Tyk, you can use thedump command. It allows you to save the objects in transportable files. You can use this command to backup important API configurations before upgrading Tyk, or to save API configurations from one Dashboard instance and then use update, publish, or sync commands to update the API configurations to another Dashboard instance. |
❌ | ✅ |
Synchronise objects from Git (or any VCS) to TykTo implement GitOps for API management, store your API definitions, policies and templates in Git or any version control system. Use thesync command to synchronise those objects to Tyk. During this operation, Tyk Sync will delete any objects in the Dashboard or Gateway that cannot be found in the VCS, and update those that can be found and create those that are missing. |
Classic API definitions only | ✅ |
Update objectsTheupdate command will read from VCS or file system and will attempt to identify matching API definitions, policies and templates in the target Dashboard or Gateway, and update them. Unmatched objects will not be created. |
Classic API definitions only | ✅ |
Publish objectsThepublish command will read from VCS or file system and create API definitions, policies, and templates in target Dashboard or Gateway. This will not update any existing objects. If it detects a collision, the command will stop. |
Classic API definitions only | ✅ |
Show and import Tyk examplesTheexamples command allow you to show and import Tyk examples. An easy way to load up your Tyk installation with some interesting examples! |
✅ | ✅ |
Working with OAS APIs
From Sync v1.5+ and Dashboard v5.3.2+, Tyk Sync supports both Tyk OAS APIs and Tyk Classic APIs when working with Tyk Dashboard without special flag and configuration.
If you’re using Sync v1.4.1 to v1.4.3, you must set the allow-unsafe-oas configuration in Dashboard, and the flag --allow-unsafe-oas when invoking Tyk Sync if you want to use Tyk Sync to migrate Tyk OAS APIs. In Tyk Sync v1.4.1 to 1.4.3, API Category is not supported for Tyk OAS APIs.