Skip to main content
PATCH
Update a setup script

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

userScript
string
required

The user script UUID

Example:

"8edb21bc-9aee-4bd9-8a02-17043fa82a87"

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

name
string
required

A name unique across the account, 1 to 64 characters, without control characters.

Example:

"HEV telemetry agent"

type
enum<string>
required

Use cloud-config for configuration settings or bash for a shell script.

Available options:
cloud-config,
bash
Example:

"cloud-config"

content
string
required

The complete script, up to 1 MiB.

Example:

"#cloud-config\npackage_update: true\npackages:\n - nginx\n - prometheus-node-exporter\nwrite_files:\n - path: /etc/hev/telemetry.env\n content: |\n SECTOR=C\n LAB=anomalous-materials\nruncmd:\n - systemctl enable --now nginx prometheus-node-exporter\n"

Response

The record, as a JSON object. There is no envelope.

A script that runs while a server is provisioned.

id
string
required

The uuid. A script's autoincrement id never leaves the server.

Example:

"8edb21bc-9aee-4bd9-8a02-17043fa82a87"

name
string
required

The name shown to customers.

Example:

"HEV telemetry agent"

type
enum<string>
required

The type of operation or resource.

Available options:
cloud-config,
bash
Example:

"cloud-config"

content
string
required

The complete script content, which may contain credentials. Stored encrypted and readable by its owner.

Example:

"#cloud-config\npackage_update: true\npackages:\n - nginx\n - prometheus-node-exporter\nwrite_files:\n - path: /etc/hev/telemetry.env\n content: |\n SECTOR=C\n LAB=anomalous-materials\nruncmd:\n - systemctl enable --now nginx prometheus-node-exporter\n"

owner
AccountOwnerData · object | null
required

The value of owner.

Example:
created_at
string | null
required

The date and time for created at, in UTC.

Example:

"2026-03-02T18:58:40+00:00"

updated_at
string | null
required

The date and time for updated at, in UTC.

Example:

"2026-06-19T10:12:05+00:00"