Environment variables

The following is a consolidated list of environment variables that this API can reference:


The full url of the ftrack server to connect to. For example “https://mycompany.ftrackapp.com


The username of the ftrack user to act on behalf of when performing actions in the system.


When this environment variable is not set, the API will typically also check other standard operating system variables that hold the username of the current logged in user. To do this it uses getpass.getuser().


The API key to use when performing actions in the system. The API key is used to determine the permissions that a script has in the system.


For backwards compatibility. See FTRACK_API_KEY.


Paths to search recursively for plugins to load and use in a session. Multiple paths can be specified by separating with the value of os.pathsep (e.g. ‘:’ or ‘;’).


Path to a directory that will be used for storing and retrieving a cache of the entity schemas fetched from the server.

http_proxy / https_proxy

If you need to use a proxy to connect to ftrack you can use the “standard” http_proxy and https_proxy. Please note that they are lowercase.

For example “export https_proxy=http://proxy.mycompany.com:8080”