Skip to content

Get a single remote-command by id

GET
/remote-commands/{id}
id
required
string

DocumentId

OK

object
data
object
name
required
string
>= 1 characters <= 120 characters
command_template
required

Shell command template with optional {arg} placeholders, e.g. ‘systemctl status {service}’

string
description
string
allowed

Whitelist flag — only allowed=true commands may be dispatched. Set to false to disable without deleting.

boolean
timeout_seconds

Maximum execution time on the agent in seconds.

integer
organisation
One of:

DocumentId reference to api::organisation.organisation

string
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

Missing or invalid authentication

Not authorized (tenant scope or capability)

Not found