ReferenceRMM API

Agent versions

The current agent version per platform (used by agents and installers to update themselves), and publishing a new release.

Method	Path	Summary
GET	`/v1/app/rmm/version`	Current versions
GET	`/v1/app/rmm/version/agent`	Current agent version
GET	`/v1/app/rmm/version/agent/linux`	Current Linux agent version and checksum
GET	`/v1/app/rmm/version/agent/windows`	Current Windows agent version and checksum
GET	`/v1/app/rmm/version/agent/macos`	Current macOS agent version and checksum
GET	`/v1/app/rmm/version/agent/remote`	Current Remote agent version and checksum
GET	`/v1/app/rmm/version/agent/legacy`	Current version for old agents
GET	`/v1/app/rmm/version/server`	Current server version
POST	`/v1/app/rmm/release/agent/:platform`	Publish an agent release
GET	`/v2/app/rmm/version/agent`	Current agent version
GET	`/v2/app/rmm/version`	Current versions

#Current versions

GET/v1/app/rmm/version

Public. The current agent and server versions.

Address: https://<your-org>.brambleit.cloud/api/v1/app/rmm/version
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Response 200

Field	Type	Description
`app_latest`	any
`server_latest`	any
`agent_latest`	any

Example response

JSON

{
  "app_latest": null,
  "server_latest": null,
  "agent_latest": null
}

Errors

Status	Message
404	Data not found

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/rmm/version', {
  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/v1/app/rmm/version",
    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/v1/app/rmm/version' -Headers $headers

#Current agent version

GET/v1/app/rmm/version/agent

Address: https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent
Requires: None: public, or protected by a token in the address or body.

Response 200

Field	Type	Description
`latest`	any
`legacy`	any
`windows`	array of any
`windows_sha256`	array of any
`linux`	any
`linux_sha256`	any
`macos`	any
`macos_sha256`	any
`remote`	any
`remote_sha256`	any

Example response

JSON

{
  "latest": null,
  "legacy": null,
  "windows": [],
  "windows_sha256": [],
  "linux": null,
  "linux_sha256": null,
  "macos": null,
  "macos_sha256": null,
  "remote": null,
  "remote_sha256": null
}

Errors

Status	Message
404	Data not found

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent', {
  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/v1/app/rmm/version/agent",
    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/v1/app/rmm/version/agent' -Headers $headers

#Current Linux agent version and checksum

GET/v1/app/rmm/version/agent/linux

Public — installers and agents use it to update. Returns the version and the release zip's SHA-256.

Address: https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/linux
Requires: None: public, or protected by a token in the address or body.

Response 200

Field	Type	Description
`latest`	any
`sha256`	any

Example response

JSON

{
  "latest": null,
  "sha256": null
}

Errors

Status	Message
404	Data not found

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/linux', {
  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/v1/app/rmm/version/agent/linux",
    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/v1/app/rmm/version/agent/linux' -Headers $headers

#Current Windows agent version and checksum

GET/v1/app/rmm/version/agent/windows

Address: https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/windows
Requires: None: public, or protected by a token in the address or body.

Response 200

Field	Type	Description
`latest`	array of any
`sha256`	array of any

Example response

JSON

{
  "latest": [],
  "sha256": []
}

Errors

Status	Message
404	Data not found

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/windows', {
  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/v1/app/rmm/version/agent/windows",
    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/v1/app/rmm/version/agent/windows' -Headers $headers

#Current macOS agent version and checksum

GET/v1/app/rmm/version/agent/macos

Address: https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/macos
Requires: None: public, or protected by a token in the address or body.

Response 200

Field	Type	Description
`latest`	any
`sha256`	any

Example response

JSON

{
  "latest": null,
  "sha256": null
}

Errors

Status	Message
404	Data not found

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/macos', {
  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/v1/app/rmm/version/agent/macos",
    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/v1/app/rmm/version/agent/macos' -Headers $headers

#Current Remote agent version and checksum

GET/v1/app/rmm/version/agent/remote

Address: https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/remote
Requires: None: public, or protected by a token in the address or body.

Response 200

Field	Type	Description
`latest`	any
`sha256`	any

Example response

JSON

{
  "latest": null,
  "sha256": null
}

Errors

Status	Message
404	Data not found

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/remote', {
  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/v1/app/rmm/version/agent/remote",
    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/v1/app/rmm/version/agent/remote' -Headers $headers

#Current version for old agents

GET/v1/app/rmm/version/agent/legacy

Address: https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/legacy
Requires: None: public, or protected by a token in the address or body.

Response 200

Field	Type	Description
`latest`	any

Example response

JSON

{
  "latest": null
}

Errors

Status	Message
404	Data not found

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/agent/legacy', {
  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/v1/app/rmm/version/agent/legacy",
    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/v1/app/rmm/version/agent/legacy' -Headers $headers

#Current server version

GET/v1/app/rmm/version/server

Address: https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/server
Requires: None: public, or protected by a token in the address or body.

Response 200

Field	Type	Description
`latest`	any

Example response

JSON

{
  "latest": null
}

Errors

Status	Message
404	Data not found

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/rmm/version/server', {
  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/v1/app/rmm/version/server",
    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/v1/app/rmm/version/server' -Headers $headers

#Publish an agent release

POST/v1/app/rmm/release/agent/:platform

Publishes a new agent release: records the version + sha256 atomically once the artifact is already live at download.cloud.brambleit.com, so the two can never point at different builds. Called by the release pipeline, not by end users — auth is a dedicated bearer token, not a user JWT.

Address: https://<your-org>.brambleit.cloud/api/v1/app/rmm/release/agent/:platform
Requires: None: public, or protected by a token in the address or body.

Path parameters

Name	Type	Description
`platform`required	string: "linux" \| "windows" \| "macos" \| "remote"

Request body JSON

Name	Type	Description
`version`required	string	The new version, e.g. `6.24.1`.
`sha256`required	string	SHA-256 of the release zip.

Response 200

Field	Type	Description
`platform`	any
`version`	any
`sha256`	string

Example response

JSON

{
  "platform": null,
  "version": null,
  "sha256": "string"
}

Errors

Status	Message
400	Unknown platform '…'. Expected one of: …
400	version is required and must look like a semver, e.g. 6.0.0
400	sha256 is required and must be a 64-character hex SHA-256 digest

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/api/v1/app/rmm/release/agent/linux' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"version":"string","sha256":"string"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/rmm/release/agent/linux', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"version":"string","sha256":"string"}),
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/api/v1/app/rmm/release/agent/linux",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"version":"string","sha256":"string"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"version":"string","sha256":"string"}'
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/rmm/release/agent/linux' -Headers $headers -ContentType 'application/json' -Body $body

#Current agent version

GET/v2/app/rmm/version/agent

Address: https://<your-org>.brambleit.cloud/api/v2/app/rmm/version/agent
Requires: None: public, or protected by a token in the address or body.

Response 200

Field	Type	Description
`latest`	any
`legacy`	any
`windows`	array of any
`linux`	any
`macos`	any
`remote`	any

Example response

JSON

{
  "latest": null,
  "legacy": null,
  "windows": [],
  "linux": null,
  "macos": null,
  "remote": null
}

Errors

Status	Message
404	Not found

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v2/app/rmm/version/agent', {
  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/version/agent",
    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/version/agent' -Headers $headers

#Current versions

GET/v2/app/rmm/version

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

Response 200

Field	Type	Description
`app_latest`	any
`server_latest`	any
`agent_latest`	any

Example response

JSON

{
  "app_latest": null,
  "server_latest": null,
  "agent_latest": null
}

Errors

Status	Message
404	Not found

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v2/app/rmm/version', {
  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/version",
    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/version' -Headers $headers

Was this page helpful?