This page explains the terms that we use across the Tyk Cloud documentation, so that you can always be sure what we mean.
The highest level container for one or more Organisations.
The main entity for all your data (Environments, APIs, Users, etc). An Organisation is connected to a single region and once connected, cannot be changed.
A sub-grouping within an Organisation.
A person who is a member of a Team with a set of permissions.
A set of data and access permissions that can be applied to a user or team of users. See User Roles for more details.
The place that holds personal information for a user.
A set of allowances assigned to an Organisation (made up of plan+addons+settings).
A portion of allowances (without add-ons) that feed into the main subscription.
The place to manage all deployments for an Organisation or Team.
A grouping of ‘deployments’ that can have multiple Control Planes and Edge Gateways.
The high level name for the set of configurations making up different types of deployments.
A deployment type: A single management layer for data in one region (where all the data lives).
A deployment type: Additional workers with varying functionality that are linked to the main control plane and can be deployed in a different region from the Control Plane.
Used to control traffic and scale in a Tyk Gateway.
The Tyk Analytics Dashboard to manage APIs and services.
Where an Organisation has expired due to either a subscription failure or cancellation and is now within a “retirement” period of 30 days, during which an Billing Admin can reinstate full functionality by updating or creating a new subscription.
Deploy a not yet deployed state (a first time deployment).
Temporarily remove a deployed status but keep all data and configuration.
Redeploy from a deployed state. Used for troubleshooting.
Permenantly remove a deployment and all associated data and configurations.
Date and time of time a deployment was initially created.
Add a new ‘user’ or ‘team’ etc.
Remove things that have been added e.g. users and teams.
Saving a change to a configuration.
Changing configuration or information on any of the deployments or other resources such as users or teams.
A deployment that is currently deployed.
A deployment that was deployed but has been undeployed.
A deployment that has never been deployed.
A deployment that has been permenantly deleted and will not be visible in the operations console.
When there has been an error in the deployment process.
When a deployment is being deployed.
When a deployment is being undeployed.
Roles and Permissions
See User Roles for more details
Can do everything across all organisations
Can do everything within the scope of the one organisation they have access to.
Can do everything within the scope of the one team they have access to.
Can only view and manage the overview, environments and deployments.