Devices and tracking

Commands

Sending commands to devices and stored command management

Fetch a list of Saved Commands

GET

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

Without params, it returns a list of Saved Commands the user has access to

Fetch a list of Saved Commands

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

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

const data = await response.text();

import requests

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

200

[
  {
    "id": 0,
    "deviceId": 0,
    "description": "string",
    "type": "string",
    "textChannel": true,
    "attributes": {}
  }
]

Parameters

allbooleanquery

Can only be used by admins or managers to fetch all entities

userIdintegerquery

Standard users can use this only with their own userId

deviceIdintegerquery

Standard users can use this only with _deviceId_s, they have access to

groupIdintegerquery

Standard users can use this only with _groupId_s, they have access to

refreshbooleanquery

limitintegerquery

Limit the number of returned results

offsetintegerquery

Offset for pagination

keywordstringquery

Search keyword filter

Response

200OKArray<Command>

Response fields application/json

Array<Command>

Show child attributes

idinteger<int64>

Unique saved command identifier

deviceIdinteger<int64>

Target device identifier when the command is bound to one device

descriptionstring

User friendly label displayed in the UI

typestring

Command type as defined by the device protocol

textChannelboolean

Whether to send the command using the SMS channel

attributesobject

Additional parameters required by the command type

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Create a Saved Command

POST

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

Create a Saved Command

curl -X POST 'https://demo.traccar.org/api/commands' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}'

const body = `{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}`;

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

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}'''

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

Request Body

{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}

200

{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique saved command identifier

deviceIdinteger<int64>

Target device identifier when the command is bound to one device

descriptionstring

User friendly label displayed in the UI

typestring

Command type as defined by the device protocol

textChannelboolean

Whether to send the command using the SMS channel

attributesobject

Additional parameters required by the command type

Response

200OKCommand

Response fields application/json

idinteger<int64>

Unique saved command identifier

deviceIdinteger<int64>

Target device identifier when the command is bound to one device

descriptionstring

User friendly label displayed in the UI

typestring

Command type as defined by the device protocol

textChannelboolean

Whether to send the command using the SMS channel

attributesobject

Additional parameters required by the command type

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch a Saved Command

GET

https://demo.traccar.org/api/commands/{id}

Fetch a Saved Command

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

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

const data = await response.text();

import requests

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

200

{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}

Parameters

idintegerrequiredpath

Response

200OKCommand

Response fields application/json

idinteger<int64>

Unique saved command identifier

deviceIdinteger<int64>

Target device identifier when the command is bound to one device

descriptionstring

User friendly label displayed in the UI

typestring

Command type as defined by the device protocol

textChannelboolean

Whether to send the command using the SMS channel

attributesobject

Additional parameters required by the command type

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Update a Saved Command

PUT

https://demo.traccar.org/api/commands/{id}

Update a Saved Command

curl -X PUT 'https://demo.traccar.org/api/commands/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}'

const body = `{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}`;

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

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}'''

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

Request Body

{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}

200

{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique saved command identifier

deviceIdinteger<int64>

Target device identifier when the command is bound to one device

descriptionstring

User friendly label displayed in the UI

typestring

Command type as defined by the device protocol

textChannelboolean

Whether to send the command using the SMS channel

attributesobject

Additional parameters required by the command type

Parameters

idintegerrequiredpath

Response

200OKCommand

Response fields application/json

idinteger<int64>

Unique saved command identifier

deviceIdinteger<int64>

Target device identifier when the command is bound to one device

descriptionstring

User friendly label displayed in the UI

typestring

Command type as defined by the device protocol

textChannelboolean

Whether to send the command using the SMS channel

attributesobject

Additional parameters required by the command type

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Delete a Saved Command

DELETE

https://demo.traccar.org/api/commands/{id}

Delete a Saved Command

curl -X DELETE 'https://demo.traccar.org/api/commands/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

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

const data = await response.text();

import requests

response = requests.delete(
    'https://demo.traccar.org/api/commands/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Parameters

idintegerrequiredpath

Response

204No Content

No Content

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch a list of Saved Commands supported by Device at the moment

GET

https://demo.traccar.org/api/commands/send

Return a list of saved commands linked to Device and its groups, filtered by current Device protocol support

Fetch a list of Saved Commands supported by Device at the moment

curl -X GET 'https://demo.traccar.org/api/commands/send?deviceId=0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/commands/send?deviceId=0', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/commands/send?deviceId=0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

[
  {
    "id": 0,
    "deviceId": 0,
    "description": "string",
    "type": "string",
    "textChannel": true,
    "attributes": {}
  }
]

Parameters

deviceIdintegerrequiredquery

Standard users can use this only with _deviceId_s, they have access to

Response

200OKArray<Command>

Response fields application/json

Array<Command>

Show child attributes

idinteger<int64>

Unique saved command identifier

deviceIdinteger<int64>

Target device identifier when the command is bound to one device

descriptionstring

User friendly label displayed in the UI

typestring

Command type as defined by the device protocol

textChannelboolean

Whether to send the command using the SMS channel

attributesobject

Additional parameters required by the command type

400Bad Request

Could happen when the user doesn't have permission for the device

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Dispatch commands to device

POST

https://demo.traccar.org/api/commands/send

Dispatch a new command or Saved Command if body.id set

Dispatch commands to device

curl -X POST 'https://demo.traccar.org/api/commands/send' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}'

const body = `{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}`;

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

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}'''

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

Request Body

{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}

{
  "id": 0,
  "deviceId": 0,
  "description": "string",
  "type": "string",
  "textChannel": true,
  "attributes": {}
}

{
  "id": 0,
  "deviceId": 0,
  "type": "string",
  "textChannel": true,
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique saved command identifier

deviceIdinteger<int64>

Target device identifier when the command is bound to one device

descriptionstring

User friendly label displayed in the UI

typestring

Command type as defined by the device protocol

textChannelboolean

Whether to send the command using the SMS channel

attributesobject

Additional parameters required by the command type

Parameters

groupIdintegerquery

Send the command to all devices in the group

Response

200OKCommand

Command sent

Response fields application/json

idinteger<int64>

Unique saved command identifier

deviceIdinteger<int64>

Target device identifier when the command is bound to one device

descriptionstring

User friendly label displayed in the UI

typestring

Command type as defined by the device protocol

textChannelboolean

Whether to send the command using the SMS channel

attributesobject

Additional parameters required by the command type

202AcceptedQueuedCommand | Array<QueuedCommand>

Command queued

Response fields application/json

Any of

idinteger<int64>

Identifier of the queued command job

deviceIdinteger<int64>

Device identifier the queued command will be delivered to

typestring

Command type that will be executed

textChannelboolean

Indicates whether the queued command uses SMS delivery

attributesobject

Stored parameters for the queued command

Array<QueuedCommand>

Show child attributes

idinteger<int64>

Identifier of the queued command job

deviceIdinteger<int64>

Device identifier the queued command will be delivered to

typestring

Command type that will be executed

textChannelboolean

Indicates whether the queued command uses SMS delivery

attributesobject

Stored parameters for the queued command

400Bad Request

Could happen when the user doesn't have permission or an incorrect command type for the device

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch a list of available Commands for the Device or all possible Commands if Device ommited

GET

https://demo.traccar.org/api/commands/types

Fetch a list of available Commands for the Device or all possible Commands if Device ommited

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

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

const data = await response.text();

import requests

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

200

[
  {
    "type": "string"
  }
]

Parameters

deviceIdintegerquery

Internal device identifier. Only works if device has already reported some locations

textChannelbooleanquery

When true return SMS commands. If not specified or false return data commands

Response

200OKArray<CommandType>

Response fields application/json

Array<CommandType>

Show child attributes

typestring

Command type identifier

400Bad Request

Could happen when trying to fetch from a device the user does not have permission

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Docs by Sourcey