ReferenceRMM API

Logs

Syslog collectors on devices and searching the collected logs.

Method	Path	Summary
GET	`/v2/app/rmm-logs`	Log collectors and recent logs
GET	`/v2/app/rmm-logs/search`	Search collected logs
PUT	`/v2/app/rmm-logs/collectors/:deviceId`	Turn a device into a syslog collector
DELETE	`/v2/app/rmm-logs/collectors/:deviceId`	Stop a syslog collector

#Log collectors and recent logs

GET/v2/app/rmm-logs

Address: https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Permission (any of): rmm.logs.view.

Response 200

Field	Type	Description
`collectors`	array of any
`candidates`	array of any
`stats`	array of any
`settings`	any
`can_manage`	boolean
`severities`	array of any
`min_agent`	any

Example response

JSON

{
  "collectors": [],
  "candidates": [],
  "stats": [],
  "settings": null,
  "can_manage": true,
  "severities": [],
  "min_agent": null
}

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs' -Headers $headers

#Search collected logs

GET/v2/app/rmm-logs/search

Address: https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/search
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Permission (any of): rmm.logs.view.

Query parameters

Name	Type	Description
`to`	any
`from`	any
`max_sev`	string
`device_id`	integer
`q`	any
`source`	any
`app`	any

Response 200

Errors

Status	Message
400	Choose a valid time range
400	Search 31 days or less at a time

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/search' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/search', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/search",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/search' -Headers $headers

#Turn a device into a syslog collector

PUT/v2/app/rmm-logs/collectors/:deviceId

Address: https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/collectors/:deviceId
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Permission (any of): rmm.logs.manage.

Path parameters

Name	Type	Description
`deviceId`required	integer

Request body JSON

Name	Type	Description
`udp_port`	any	UDP port to listen on.
`tcp_port`	any	TCP port to listen on.
`enabled`	boolean	Collect logs.

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

Bash

curl -X PUT 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/collectors/1' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"udp_port":"…","tcp_port":"…","enabled":true}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/collectors/1', {
  method: 'PUT',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"udp_port":"…","tcp_port":"…","enabled":true}),
});
const data = await res.json();

Python

import os, requests

r = requests.put(
    "https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/collectors/1",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"udp_port":"…","tcp_port":"…","enabled":True},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"udp_port":"…","tcp_port":"…","enabled":true}'
Invoke-RestMethod -Method PUT -Uri 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/collectors/1' -Headers $headers -ContentType 'application/json' -Body $body

#Stop a syslog collector

DELETE/v2/app/rmm-logs/collectors/:deviceId

Address: https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/collectors/:deviceId
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Permission (any of): rmm.logs.manage.

Path parameters

Name	Type	Description
`deviceId`required	integer

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

Bash

curl -X DELETE 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/collectors/1' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/collectors/1', {
  method: 'DELETE',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.delete(
    "https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/collectors/1",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method DELETE -Uri 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-logs/collectors/1' -Headers $headers

Was this page helpful?