Server and monitoring

Server

Server information

Fetch Server information

GET

https://demo.traccar.org/api/server

Fetch Server information

curl -X GET 'https://demo.traccar.org/api/server'

const response = await fetch('https://demo.traccar.org/api/server', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://demo.traccar.org/api/server')
print(response.text)

200

{
  "id": 0,
  "registration": true,
  "readonly": true,
  "deviceReadonly": true,
  "limitCommands": true,
  "map": "string",
  "bingKey": "string",
  "mapUrl": "string",
  "poiLayer": "string",
  "announcement": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "version": "string",
  "forceSettings": true,
  "coordinateFormat": "string",
  "openIdEnabled": true,
  "openIdForce": true,
  "attributes": {}
}

Response

200OKServer

Response fields application/json

idinteger<int64>

Unique server configuration identifier

registrationboolean

Whether new user registrations are allowed

readonlyboolean

When true only administrators can modify server-wide settings

deviceReadonlyboolean

Disallow device attribute changes for non-admins

limitCommandsboolean

Restrict command execution to supported protocol commands

mapstring

Default map layer identifier

bingKeystring

Bing Maps API key used when Bing is selected as a provider

mapUrlstring

Custom tile server URL template if configured

poiLayerstring

External point-of-interest layer configuration

announcementstring

Message displayed to all users in the web application

latitudenumber

Default map center latitude

longitudenumber

Default map center longitude

zoominteger

Default map zoom level

versionstring

Traccar server version string

forceSettingsboolean

Forces users to use the server-wide settings instead of their own

coordinateFormatstring

Default coordinate format for displaying positions

openIdEnabledboolean

Indicates whether OpenID authentication is available

openIdForceboolean

Require OpenID authentication for all users when enabled

attributesobject

Additional server-level configuration values

400Bad Request

Bad request

Update Server information

PUT

https://demo.traccar.org/api/server

Update Server information

curl -X PUT 'https://demo.traccar.org/api/server' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "registration": true,
  "readonly": true,
  "deviceReadonly": true,
  "limitCommands": true,
  "map": "string",
  "bingKey": "string",
  "mapUrl": "string",
  "poiLayer": "string",
  "announcement": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "version": "string",
  "forceSettings": true,
  "coordinateFormat": "string",
  "openIdEnabled": true,
  "openIdForce": true,
  "attributes": {}
}'

const body = `{
  "id": 0,
  "registration": true,
  "readonly": true,
  "deviceReadonly": true,
  "limitCommands": true,
  "map": "string",
  "bingKey": "string",
  "mapUrl": "string",
  "poiLayer": "string",
  "announcement": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "version": "string",
  "forceSettings": true,
  "coordinateFormat": "string",
  "openIdEnabled": true,
  "openIdForce": true,
  "attributes": {}
}`;

const response = await fetch('https://demo.traccar.org/api/server', {
  method: 'PUT',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "registration": true,
  "readonly": true,
  "deviceReadonly": true,
  "limitCommands": true,
  "map": "string",
  "bingKey": "string",
  "mapUrl": "string",
  "poiLayer": "string",
  "announcement": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "version": "string",
  "forceSettings": true,
  "coordinateFormat": "string",
  "openIdEnabled": true,
  "openIdForce": true,
  "attributes": {}
}'''

response = requests.put(
    'https://demo.traccar.org/api/server',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "registration": true,
  "readonly": true,
  "deviceReadonly": true,
  "limitCommands": true,
  "map": "string",
  "bingKey": "string",
  "mapUrl": "string",
  "poiLayer": "string",
  "announcement": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "version": "string",
  "forceSettings": true,
  "coordinateFormat": "string",
  "openIdEnabled": true,
  "openIdForce": true,
  "attributes": {}
}

200

{
  "id": 0,
  "registration": true,
  "readonly": true,
  "deviceReadonly": true,
  "limitCommands": true,
  "map": "string",
  "bingKey": "string",
  "mapUrl": "string",
  "poiLayer": "string",
  "announcement": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "version": "string",
  "forceSettings": true,
  "coordinateFormat": "string",
  "openIdEnabled": true,
  "openIdForce": true,
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique server configuration identifier

registrationboolean

Whether new user registrations are allowed

readonlyboolean

When true only administrators can modify server-wide settings

deviceReadonlyboolean

Disallow device attribute changes for non-admins

limitCommandsboolean

Restrict command execution to supported protocol commands

mapstring

Default map layer identifier

bingKeystring

Bing Maps API key used when Bing is selected as a provider

mapUrlstring

Custom tile server URL template if configured

poiLayerstring

External point-of-interest layer configuration

announcementstring

Message displayed to all users in the web application

latitudenumber

Default map center latitude

longitudenumber

Default map center longitude

zoominteger

Default map zoom level

versionstring

Traccar server version string

forceSettingsboolean

Forces users to use the server-wide settings instead of their own

coordinateFormatstring

Default coordinate format for displaying positions

openIdEnabledboolean

Indicates whether OpenID authentication is available

openIdForceboolean

Require OpenID authentication for all users when enabled

attributesobject

Additional server-level configuration values

Response

200OKServer

Response fields application/json

idinteger<int64>

Unique server configuration identifier

registrationboolean

Whether new user registrations are allowed

readonlyboolean

When true only administrators can modify server-wide settings

deviceReadonlyboolean

Disallow device attribute changes for non-admins

limitCommandsboolean

Restrict command execution to supported protocol commands

mapstring

Default map layer identifier

bingKeystring

Bing Maps API key used when Bing is selected as a provider

mapUrlstring

Custom tile server URL template if configured

poiLayerstring

External point-of-interest layer configuration

announcementstring

Message displayed to all users in the web application

latitudenumber

Default map center latitude

longitudenumber

Default map center longitude

zoominteger

Default map zoom level

versionstring

Traccar server version string

forceSettingsboolean

Forces users to use the server-wide settings instead of their own

coordinateFormatstring

Default coordinate format for displaying positions

openIdEnabledboolean

Indicates whether OpenID authentication is available

openIdForceboolean

Require OpenID authentication for all users when enabled

attributesobject

Additional server-level configuration values

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Reverse geocode coordinates

GET

https://demo.traccar.org/api/server/geocode

Reverse geocode coordinates

curl -X GET 'https://demo.traccar.org/api/server/geocode?latitude=0&longitude=0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/server/geocode?latitude=0&longitude=0', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/server/geocode?latitude=0&longitude=0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

string

Parameters

latitudenumber<double>requiredquery

longitudenumber<double>requiredquery

Response

200OKstring

Response fields text/plain

string

401Unauthorized

Unauthorized

500Internal Server Error

Reverse geocoding is not enabled

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch available timezones

GET

https://demo.traccar.org/api/server/timezones

Fetch available timezones

curl -X GET 'https://demo.traccar.org/api/server/timezones' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/server/timezones', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/server/timezones',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

[
  "string"
]

Response

200OKArray<string>

Response fields application/json

Array<string>

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Upload a server file

POST

https://demo.traccar.org/api/server/file/{path}

Upload a server file

curl -X POST 'https://demo.traccar.org/api/server/file/string' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/server/file/string', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.post(
    'https://demo.traccar.org/api/server/file/string',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Request Body

"<binary>"

Body

application/octet-stream

string<binary>

Parameters

pathstringrequiredpath

Response

200OK

400Bad Request

Bad request

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Trigger garbage collection

GET

https://demo.traccar.org/api/server/gc

Trigger garbage collection

curl -X GET 'https://demo.traccar.org/api/server/gc' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/server/gc', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/server/gc',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Response

200OK

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch cache diagnostics

GET

https://demo.traccar.org/api/server/cache

Fetch cache diagnostics

curl -X GET 'https://demo.traccar.org/api/server/cache' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/server/cache', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/server/cache',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

string

Response

200OKstring

Response fields text/plain

string

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Reboot the server process

POST

https://demo.traccar.org/api/server/reboot

Reboot the server process

curl -X POST 'https://demo.traccar.org/api/server/reboot' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/server/reboot', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.post(
    'https://demo.traccar.org/api/server/reboot',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Response

200OK

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Docs by Sourcey