Tyk Sync by Tyk is a command line (CLI) tool designed to streamline GitOps for API management. It allows users to store API definitions, security policies, and API templates as files in a version control system (VCS) or file system, synchronizing changes to Tyk for consistent and automated API configuration management. Tyk Sync works with the Open Source Tyk Gateway and Tyk Dashboard. It supports managing Classic API definitions with Tyk Gateway and both Classic and OAS API definitions, security policies, and API templates with Tyk Dashboard. Users can backup their API definitions, policies, and templates in Tyk using the dump command to save the objects in transportable files. Tyk Sync can synchronize objects from Git (or any VCS) to Tyk, store API definitions, policies, and templates in Git or any version control system, and use the sync command to synchronize those objects to Tyk. During this operation, Tyk Sync will delete objects in the Dashboard or Gateway that cannot be found in the VCS, update those that can be found, and create those that are missing. The update command will read from VCS or file system to identify matching API definitions, policies, and templates in the target Dashboard or Gateway, and update them. Unmatched objects will not be created. The publish command will read from VCS or file system and create API definitions, policies, and templates in the target Dashboard or Gateway. This will not update existing objects. If it detects a collision, the command will stop. Tyk Sync supports both Tyk OAS APIs and Tyk Classic APIs when working with Tyk Dashboard without special flag and configuration. Users must set the allow-unsafe-oas configuration in Dashboard, and the flag --allow-unsafe-oas when invoking Tyk Sync to migrate Tyk OAS APIs. Tyk Sync offers reliable automated configuration portability for any Tyk environment, easy installation and maintenance, and integration with version control systems like Git and CI/CD tools like Jenkins and ArgoCD.
