TeslaMateApi is a RESTful API to get data collected by self-hosted data logger TeslaMate in JSON.
You can either use it in a Docker container or go download the code and deploy it yourself on any server.
If you run the simple Docker deployment of TeslaMate, then adding this will do the trick. You'll have TeslaMateApi exposed at port 8080 locally then.
services:
teslamateapi:
image: tobiasehlert/teslamateapi:latest
restart: always
depends_on:
- database
environment:
- ENCRYPTION_KEY=MySuperSecretEncryptionKey
- DATABASE_USER=teslamate
- DATABASE_PASS=secret
- DATABASE_NAME=teslamate
- DATABASE_HOST=database
- MQTT_HOST=mosquitto
- TZ=Europe/Berlin
ports:
- 8080:8080
If you are using TeslaMate Traefik setup in Docker with environment variables file (.env), then you can simply add this section to the services:
section of the docker-compose.yml
file:
services:
teslamateapi:
image: tobiasehlert/teslamateapi:latest
restart: always
depends_on:
- database
environment:
- ENCRYPTION_KEY=${TM_ENCRYPTION_KEY}
- DATABASE_USER=${TM_DB_USER}
- DATABASE_PASS=${TM_DB_PASS}
- DATABASE_NAME=${TM_DB_NAME}
- DATABASE_HOST=database
- MQTT_HOST=mosquitto
- TZ=${TM_TZ}
labels:
- "traefik.enable=true"
- "traefik.port=8080"
- "traefik.http.middlewares.redirect.redirectscheme.scheme=https"
- "traefik.http.middlewares.teslamateapi-auth.basicauth.realm=teslamateapi"
- "traefik.http.middlewares.teslamateapi-auth.basicauth.usersfile=/auth/.htpasswd"
- "traefik.http.routers.teslamateapi-insecure.rule=Host(`${FQDN_TM}`)"
- "traefik.http.routers.teslamateapi-insecure.middlewares=redirect"
- "traefik.http.routers.teslamateapi.rule=Host(`${FQDN_TM}`) && (Path(`/api`) || PathPrefix(`/api/`))"
- "traefik.http.routers.teslamateapi.entrypoints=websecure"
- "traefik.http.routers.teslamateapi.middlewares=teslamateapi-auth"
- "traefik.http.routers.teslamateapi.tls.certresolver=tmhttpchallenge"
In this case, the TeslaMateApi would be accessible at teslamate.example.com/api/
Basically the same environment variables for the database, mqqt and timezone need to be set for TeslaMateApi as you have for TeslaMate.
Required environment variables (even if there are some default values available)
Variable | Type | Default |
---|---|---|
DATABASE_USER | string | teslamate |
DATABASE_PASS | string | secret |
DATABASE_NAME | string | teslamate |
DATABASE_HOST | string | database |
ENCRYPTION_KEY | string | |
MQTT_HOST | string | mosquitto |
TZ | string | Europe/Berlin |
Optional environment variables
Variable | Type | Default |
---|---|---|
TESLAMATE_SSL | boolean | false |
TESLAMATE_HOST | string | teslamate |
TESLAMATE_PORT | string | 4000 |
API_TOKEN | string | |
API_TOKEN_DISABLE | string | false |
DATABASE_PORT | integer | 5432 |
DATABASE_TIMEOUT | integer | 60000 |
DATABASE_SSL | boolean | true |
DEBUG_MODE | boolean | false |
DISABLE_MQTT | boolean | false |
MQTT_TLS | boolean | false |
MQTT_PORT | integer | 1883 (if TLS is true: 8883) |
MQTT_USERNAME | string | |
MQTT_PASSWORD | string | |
MQTT_NAMESPACE | string | |
MQTT_CLIENTID | string | 4 char random string |
Commands environment variables
Variable | Type | Default |
---|---|---|
ENABLE_COMMANDS | boolean | false |
COMMANDS_ALL | boolean | false |
COMMANDS_ALLOWLIST | string | _allowlist.json |
COMMANDS_LOGGING | boolean | false |
COMMANDS_WAKE | boolean | false |
COMMANDS_ALERT | boolean | false |
COMMANDS_REMOTESTART | boolean | false |
COMMANDS_HOMELINK | boolean | false |
COMMANDS_SPEEDLIMIT | boolean | false |
COMMANDS_VALET | boolean | false |
COMMANDS_SENTRYMODE | boolean | false |
COMMANDS_DOORS | boolean | false |
COMMANDS_TRUNK | boolean | false |
COMMANDS_WINDOWS | boolean | false |
COMMANDS_SUNROOF | boolean | false |
COMMANDS_CHARGING | boolean | false |
COMMANDS_CLIMATE | boolean | false |
COMMANDS_MEDIA | boolean | false |
COMMANDS_SHARING | boolean | false |
COMMANDS_SOFTWAREUPDATE | boolean | false |
COMMANDS_UNKNOWN | boolean | false |
More detailed documentation of every endpoint will come..
/api
/api/v1
/api/v1/cars
/api/v1/cars/:CarID
/api/v1/cars/:CarID/charges
/api/v1/cars/:CarID/charges/:ChargeID
/api/v1/cars/:CarID/command
/api/v1/cars/:CarID/command/:Command
/api/v1/cars/:CarID/drives
/api/v1/cars/:CarID/drives/:DriveID
/api/v1/cars/:CarID/logging/:Command
/api/v1/cars/:CarID/logging
/api/v1/cars/:CarID/status
/api/v1/cars/:CarID/updates
/api/v1/cars/:CarID/wake_up
/api/v1/globalsettings
/api/healthz
/api/ping
/api/readyz
If you want to use command or logging endpoints such as /api/v1/cars/:CarID/command/:Command
, /api/v1/cars/:CarID/wake_up
, or /api/v1/cars/:CarID/logging/:Command
you need to add authentication to your request.
You need to specify a token yourself (called API_TOKEN) in the environment variables file, to set it. The token has the requirement to be a minimum of 32 characters long.
There are two options available for authentication to be done.
Adding extra header Authorization: Bearer <token>
to your request. (recommended option)
Adding URI parameter ?token=<token>
to the endpoint you try to reach. (not a good option)
* Note: If you use the second option and your logs get compromised, your token will be leaked.
Commands are not enabled by default.
You need to enable them in your environment variables (with ENABLE_COMMANDS=true
) and you need to specify which commands you want to use as well.
There are 3 ways of using Commands:
Specific groups of commands can be enabled for example COMMANDS_ALERT=true
will enable the alert commands group.
If you need a granular set of commands enabled COMMANDS_ALLOWLIST=/path/to/allow_list.json
can be used to specify a JSON formatted list of commands to enable.
The most coarse option COMMANDS_ALL=true
will enable all commands (specific groups and allow_list will be ignored).
* _Note: if COMMANDS_ALL
or any specific group of commands has been enabled COMMANDS_ALLOWLIST
is ignored._
A list of possible commands can be found under environment variables.
Regarding what fields you need to provide in the commands, we will referr to the timdorr/tesla-api documentation.
There is no possibility to get access to your Tesla account tokens by this API and we'll keep it this way!
The data that is accessible is data like the cars, charges, drives, current status, updates and global settings.
Also, apply some authentication on your webserver in front of the container, so your data is not unprotected and too exposed. In the example above, we use the same .htpasswd file as used by TeslaMate.
If you have applied a level of authentication in front of the container API_TOKEN_DISABLE=true
will allow commands without requiring the header or uri token value. But even then it's always rekommended to use an apikey.