Endpoints

14 routes de l'API publique. Textes de la source : openapi-csp.json du dépôt platform.

List endpoints

GET /endpoints

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
limit	requête	integer	non	Défaut : 50. Valeur : 1 à 100.
cursor	requête	string	non	Longueur minimum : 1.
client_id	requête	string (uuid)	non
type	requête	"agent" | "m365"	non
agent_status	requête	"online" | "offline"	non	Presence at the time of the request.
version	requête	string	non	Exact agent version (agent.version) Longueur : 1 à 64.
q	requête	string	non	Case-insensitive substring of name or display_name Longueur : 1 à 255.
problems	requête	"true"	non	Problem endpoints only: an offline agent, or last_backup.status or last_baremetal_backup.status failed, interrupted, missed or partial.
boot	requête	"uefi" | "bios" | "unknown"	non	Boot mode (agent.boot): uefi, UEFI firmware and GPT system disk; bios, BIOS firmware or MBR system disk (no image backup); unknown, the rest (an agent that sends no boot mode, a system disk it could not read, an M365 tenant)
too_old	requête	"true"	non	Agent endpoints with agent_version_state too_old only: the version of the last hello is below min_agent_version
tag	requête	string | array of string	non	key:value, repeat for several (AND). Key and value compare without case.
no_tag	requête	string | array of string	non	A tag key, repeat for several (AND): the endpoint does not have the key. Compares without case.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
items	array of object	oui
items[].id	string (uuid)	oui	For an agent, also its agent_id
items[].client_id	string (uuid)	oui
items[].type	"agent" | "m365"	oui
items[].name	string	oui	Hostname of an agent at enrollment, domain of an M365 tenant. Never changes.
items[].display_name	string | null	oui	Name given by an operator (PATCH /endpoints/:id); null: show name. Restores and audit keep name
items[].status	"active" | "deleted"	oui
items[].created_at	string (date-time)	oui
items[].agent	object | null	oui	agent endpoints only.
items[].last_backup	object | null	oui	agent endpoints only: the newest file backup job (by scheduled_at) with an outcome; null before the first one.
items[].last_baremetal_backup	object | null	oui	agent endpoints only: the newest bare metal image job (by scheduled_at) with an outcome, never partial; null before the first one.
items[].tags	array of object	oui	Tags of the endpoint, by key (docs/tags-api.md)
items[].first_backup_alert	object | null	oui	agent endpoints only: days before the "first backup unfinished" alert
items[].first_backup_reset	object | null	oui	agent endpoints only: reset of an abandoned first backup
items[].agent_version	string | null	non	agent endpoints only: version reported by the last hello (as agent.version); null before it, and for other types. Optional for older readers [C13].
items[].min_agent_version	string | null	non	agent endpoints only: oldest supported agent version of the platform (MIN_AGENT_VERSION, setting minAgentVersion); null for other types. Optional for older readers [C13].
items[].agent_version_state	"supported" | "too_old" | "unknown" | null	non	agent endpoints only: too_old when agent_version is below min_agent_version (spec S6): every order except the automatic update is refused with 409 agent_too_old. unknown before the first hello. Null for other types. Optional for older readers [C13].
next_cursor	string | null	oui

Export endpoints

GET /endpoints/export

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
client_id	requête	string (uuid)	non
type	requête	"agent" | "m365"	non
agent_status	requête	"online" | "offline"	non	Presence at the time of the request.
version	requête	string	non	Exact agent version (agent.version) Longueur : 1 à 64.
q	requête	string	non	Case-insensitive substring of name or display_name Longueur : 1 à 255.
problems	requête	"true"	non	Problem endpoints only: an offline agent, or last_backup.status or last_baremetal_backup.status failed, interrupted, missed or partial.
boot	requête	"uefi" | "bios" | "unknown"	non	Boot mode (agent.boot): uefi, UEFI firmware and GPT system disk; bios, BIOS firmware or MBR system disk (no image backup); unknown, the rest (an agent that sends no boot mode, a system disk it could not read, an M365 tenant)
too_old	requête	"true"	non	Agent endpoints with agent_version_state too_old only: the version of the last hello is below min_agent_version
tag	requête	string | array of string	non	key:value, repeat for several (AND). Key and value compare without case.
no_tag	requête	string | array of string	non	A tag key, repeat for several (AND): the endpoint does not have the key. Compares without case.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Get endpoint

GET /endpoints/{id}

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
id	string (uuid)	oui	For an agent, also its agent_id
client_id	string (uuid)	oui
type	"agent" | "m365"	oui
name	string	oui	Hostname of an agent at enrollment, domain of an M365 tenant. Never changes.
display_name	string | null	oui	Name given by an operator (PATCH /endpoints/:id); null: show name. Restores and audit keep name
status	"active" | "deleted"	oui
created_at	string (date-time)	oui
agent	object | null	oui	agent endpoints only.
last_backup	object | null	oui	agent endpoints only: the newest file backup job (by scheduled_at) with an outcome; null before the first one.
last_baremetal_backup	object | null	oui	agent endpoints only: the newest bare metal image job (by scheduled_at) with an outcome, never partial; null before the first one.
tags	array of object	oui	Tags of the endpoint, by key (docs/tags-api.md)
tags[].key_id	string (uuid)	oui
tags[].key	string	oui
tags[].value	string	oui
first_backup_alert	object | null	oui	agent endpoints only: days before the "first backup unfinished" alert
first_backup_reset	object | null	oui	agent endpoints only: reset of an abandoned first backup
agent_version	string | null	non	agent endpoints only: version reported by the last hello (as agent.version); null before it, and for other types. Optional for older readers [C13].
min_agent_version	string | null	non	agent endpoints only: oldest supported agent version of the platform (MIN_AGENT_VERSION, setting minAgentVersion); null for other types. Optional for older readers [C13].
agent_version_state	"supported" | "too_old" | "unknown" | null	non	agent endpoints only: too_old when agent_version is below min_agent_version (spec S6): every order except the automatic update is refused with 409 agent_too_old. unknown before the first hello. Null for other types. Optional for older readers [C13].

Update endpoint

PATCH /endpoints/{id}

Accès : Clé API du MSP, portée operate.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
display_name	string | null	non
first_backup_alert_days	integer | null	non
first_backup_reset_days	integer | null	non

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
id	string (uuid)	oui	For an agent, also its agent_id
client_id	string (uuid)	oui
type	"agent" | "m365"	oui
name	string	oui	Hostname of an agent at enrollment, domain of an M365 tenant. Never changes.
display_name	string | null	oui	Name given by an operator (PATCH /endpoints/:id); null: show name. Restores and audit keep name
status	"active" | "deleted"	oui
created_at	string (date-time)	oui
agent	object | null	oui	agent endpoints only.
last_backup	object | null	oui	agent endpoints only: the newest file backup job (by scheduled_at) with an outcome; null before the first one.
last_baremetal_backup	object | null	oui	agent endpoints only: the newest bare metal image job (by scheduled_at) with an outcome, never partial; null before the first one.
tags	array of object	oui	Tags of the endpoint, by key (docs/tags-api.md)
tags[].key_id	string (uuid)	oui
tags[].key	string	oui
tags[].value	string	oui
first_backup_alert	object | null	oui	agent endpoints only: days before the "first backup unfinished" alert
first_backup_reset	object | null	oui	agent endpoints only: reset of an abandoned first backup
agent_version	string | null	non	agent endpoints only: version reported by the last hello (as agent.version); null before it, and for other types. Optional for older readers [C13].
min_agent_version	string | null	non	agent endpoints only: oldest supported agent version of the platform (MIN_AGENT_VERSION, setting minAgentVersion); null for other types. Optional for older readers [C13].
agent_version_state	"supported" | "too_old" | "unknown" | null	non	agent endpoints only: too_old when agent_version is below min_agent_version (spec S6): every order except the automatic update is refused with 409 agent_too_old. unknown before the first hello. Null for other types. Optional for older readers [C13].

Delete endpoint

DELETE /endpoints/{id}

Accès : Clé API du MSP, portée operate.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Réponses

Code	Description
202	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 202 (application/json)

Nom	Type	Obligatoire	Description
endpoint_id	string (uuid)	oui
pending_action_id	string (uuid)	oui
requested_at	string (date-time)	oui
effective_at	string (date-time)	oui	Request + 72 h.
purge_at	string (date-time)	oui	Planned earliest purge: effective_at + 7 days; actual purge is at least 7 days after deleted_at.

Get endpoint agent

GET /endpoints/{id}/agent

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
id	string (uuid)	oui	The endpoint id.
client_id	string (uuid)	oui
hostname	string	oui
os	string | null	oui
arch	string | null	oui
version	string | null	oui	Version reported by the last hello
status	"online" | "offline"	oui
last_connected_at	string (date-time) | null	oui
last_disconnected_at	string (date-time) | null	oui
access_revoked	boolean	oui	A deletion request revoked the agent (security review H2). After a cancelled deletion, POST /endpoints/:id/reattach-token gives it back.
created_at	string (date-time)	oui
deletion_effective_at	string (date-time) | null	non	Effective date of the pending deletion of the endpoint, null without one. Optional for older readers [C13], always sent.
upload_limit	number | null	non	Exception of the agent to the upload limit of its policies, MiB/s. Null: no exception, the limit of the policy applies (null there: no limit). Optional for older readers [C13], always sent.
upload_limit_max	number | null	non	Server cap of the upload of one agent, MiB/s (HAProxy bwlim, set by the platform). The API refuses a higher upload_limit on the agent or on its policies (422 upload_limit_above_cap). Null: no cap. Optional for older readers [C13].
boot	object | null	non	Boot mode of the machine from its last hello that sent one. Null: unknown (an older agent). A bios firmware or an mbr system disk: no image backup (baremetal_unsupported_boot). Optional for older readers [C13], always sent.
install_profile_id	string (uuid) | null	non	Install profile the agent was installed with, from its layout.json at enrollment; a later change of the profile does not change it. Null: the BaaStide profile, or an agent older than the white label (install_profile_revision null). Optional for older readers [C13], always sent.
install_profile_revision	integer | null	non	Revision of that profile at install; 0: the BaaStide profile; null: not sent by the agent (older than the white label). Optional for older readers [C13], always sent.
mssql_service_account	string | null	non	Windows account of the agent service, NT SERVICE\<service name> from the last hello (NT SERVICE\BaaStide for an older agent). This account needs a SQL Server login with the sysadmin role when an instance has no credentials. Null: not a Windows agent. Optional for older readers [C13], always sent.

Set agent upload limit

PUT /endpoints/{id}/agent/upload-limit

Accès : Clé API du MSP, portée operate.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
upload_limit	number | null	oui	Null: remove the exception.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
id	string (uuid)	oui	The endpoint id.
client_id	string (uuid)	oui
hostname	string	oui
os	string | null	oui
arch	string | null	oui
version	string | null	oui	Version reported by the last hello
status	"online" | "offline"	oui
last_connected_at	string (date-time) | null	oui
last_disconnected_at	string (date-time) | null	oui
access_revoked	boolean	oui	A deletion request revoked the agent (security review H2). After a cancelled deletion, POST /endpoints/:id/reattach-token gives it back.
created_at	string (date-time)	oui
deletion_effective_at	string (date-time) | null	non	Effective date of the pending deletion of the endpoint, null without one. Optional for older readers [C13], always sent.
upload_limit	number | null	non	Exception of the agent to the upload limit of its policies, MiB/s. Null: no exception, the limit of the policy applies (null there: no limit). Optional for older readers [C13], always sent.
upload_limit_max	number | null	non	Server cap of the upload of one agent, MiB/s (HAProxy bwlim, set by the platform). The API refuses a higher upload_limit on the agent or on its policies (422 upload_limit_above_cap). Null: no cap. Optional for older readers [C13].
boot	object | null	non	Boot mode of the machine from its last hello that sent one. Null: unknown (an older agent). A bios firmware or an mbr system disk: no image backup (baremetal_unsupported_boot). Optional for older readers [C13], always sent.
install_profile_id	string (uuid) | null	non	Install profile the agent was installed with, from its layout.json at enrollment; a later change of the profile does not change it. Null: the BaaStide profile, or an agent older than the white label (install_profile_revision null). Optional for older readers [C13], always sent.
install_profile_revision	integer | null	non	Revision of that profile at install; 0: the BaaStide profile; null: not sent by the agent (older than the white label). Optional for older readers [C13], always sent.
mssql_service_account	string | null	non	Windows account of the agent service, NT SERVICE\<service name> from the last hello (NT SERVICE\BaaStide for an older agent). This account needs a SQL Server login with the sysadmin role when an instance has no credentials. Null: not a Windows agent. Optional for older readers [C13], always sent.

Browse agent

POST /endpoints/{id}/browse

Accès : Clé API du MSP, portée browse.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
path	string	oui	Absolute path of the directory, in the form of the agent's OS. Linux: the api normalizes // and a final /; ., .., NUL or over 4096 bytes: 400 invalid_path. Windows: / (the drives) or a normalized windowsPath, as is; another form: 400 invalid_path. Another or unknown OS: 400 invalid_path Longueur minimum : 1.
cursor	string	non	next_cursor of the previous page. Absent: first page. With \\ on a Windows agent: 400 invalid_path Longueur maximum : 255.
limit	integer	non	Max entries, default 500. Valeur : 1 à 1000.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
path	string	oui	The listed path, normalized.
entries	array of object	oui
entries[].name	string	oui	Name of the entry, without the path. UTF-8. Longueur minimum : 1.
entries[].type	"dir" | "file" | "symlink" | "other"	oui	other: socket, fifo, device.
entries[].size	integer	non	Bytes, for file only. Valeur minimum : 0.
entries[].mtime	string (date-time)	non	Last modification, information only.
entries[].mount	boolean	non	True for a mount point: another st_dev than the listed directory.
entries[].drive	object	non	Windows, list_dir of / only: one ready fixed or removable drive (name = C:, type = dir)
entries[].invalid_name	boolean	non	True if the name is not valid UTF-8: name then has U+FFFD for the bad bytes, the entry cannot be opened or selected.
next_cursor	string | null	oui	Null on the last page.
hidden_count	integer	oui	Entries hidden by the forbidden path list of the agent. Valeur minimum : 0.

List agent shares

GET /endpoints/{id}/shares

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
items	array of object	oui
items[].id	string (uuid)	oui
items[].endpoint_id	string (uuid)	oui	The agent.
items[].key	string	oui	Fixed short name of a network share of the agent.
items[].label	string	oui
items[].protocol	"smb" | "nfs"	oui
items[].host	string	oui
items[].share	string	oui
items[].options	object	oui
items[].username	string | null	oui	SMB only, else null.
items[].domain	string | null	oui	SMB only, else null.
items[].has_password	boolean	oui	SMB: a password is stored. NFS: false.
items[].credential_updated_at	string (date-time) | null	oui	Last change of the credentials. NFS: null.
items[].created_at	string (date-time)	oui
items[].updated_at	string (date-time)	oui

Create agent share

POST /endpoints/{id}/shares

Accès : Clé API du MSP, portée operate.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Corps de la requête (application/json)

Type : object.

Réponses

Code	Description
201	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 201 (application/json)

Nom	Type	Obligatoire	Description
id	string (uuid)	oui
endpoint_id	string (uuid)	oui	The agent.
key	string	oui	Fixed short name of a network share of the agent.
label	string	oui
protocol	"smb" | "nfs"	oui
host	string	oui
share	string	oui
options	object	oui
username	string | null	oui	SMB only, else null.
domain	string | null	oui	SMB only, else null.
has_password	boolean	oui	SMB: a password is stored. NFS: false.
credential_updated_at	string (date-time) | null	oui	Last change of the credentials. NFS: null.
created_at	string (date-time)	oui
updated_at	string (date-time)	oui

Update agent share

PATCH /endpoints/{id}/shares/{shareId}

Accès : Clé API du MSP, portée operate.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui
shareId	chemin	string (uuid)	oui

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
label	string	non	Name shown in the portal, at most 100 characters. Longueur : 1 à 100.
host	string | string (ipv6)	non	DNS name, IPv4 or IPv6 address of the server, without port or brackets.
share	string	non
options	object	non	All the options of the protocol of the share.
username	string	non	SMB account, without ,, = or a code 0 to 31. Longueur : 1 à 256.
domain	string	non	SMB domain or workgroup, can be empty; without ,, = or a code 0 to 31. Longueur maximum : 255.
password	string	non	SMB password, 1 to 256 characters, no NUL. A secret: never stored in clear, logged or returned by the api. Longueur : 1 à 256.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
id	string (uuid)	oui
endpoint_id	string (uuid)	oui	The agent.
key	string	oui	Fixed short name of a network share of the agent.
label	string	oui
protocol	"smb" | "nfs"	oui
host	string	oui
share	string	oui
options	object	oui
username	string | null	oui	SMB only, else null.
domain	string | null	oui	SMB only, else null.
has_password	boolean	oui	SMB: a password is stored. NFS: false.
credential_updated_at	string (date-time) | null	oui	Last change of the credentials. NFS: null.
created_at	string (date-time)	oui
updated_at	string (date-time)	oui

Delete agent share

DELETE /endpoints/{id}/shares/{shareId}

Accès : Clé API du MSP, portée operate.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui
shareId	chemin	string (uuid)	oui

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
id	string (uuid)	oui
endpoint_id	string (uuid)	oui	The agent.
key	string	oui	Fixed short name of a network share of the agent.
label	string	oui
protocol	"smb" | "nfs"	oui
host	string	oui
share	string	oui
options	object	oui
username	string | null	oui	SMB only, else null.
domain	string | null	oui	SMB only, else null.
has_password	boolean	oui	SMB: a password is stored. NFS: false.
credential_updated_at	string (date-time) | null	oui	Last change of the credentials. NFS: null.
created_at	string (date-time)	oui
updated_at	string (date-time)	oui

Check agent share

POST /endpoints/{id}/shares/check

Accès : Clé API du MSP, portée operate.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Corps de la requête (application/json)

Type : object.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
status	"ok" | "error"	oui
code	string | null	oui	One of SHARE_ERROR_CODES when status is error; else null.
entries_seen	integer	oui	Entries read at the root of the share. Valeur : 0 à 1000.
root_squash_suspected	boolean	oui	NFS: the root belongs to nobody or root cannot read it.

List endpoint vms

GET /endpoints/{id}/vms

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
endpoint_id	string (uuid)	oui
hyperv	boolean	oui	The agent declared HYPERV_AGENT_CAPABILITY in its current session.
proxmox	boolean	oui	The agent declared PROXMOX_AGENT_CAPABILITY in its current session.
hypervisor	"hyperv" | "proxmox" | null	oui	Hypervisor of the last inventory; null before the first one.
collected_at	string (date-time) | null	oui	Server time of the last inventory; null before the first one.
host	object | null	oui	Hyper-V host data; null for a Proxmox node.
proxmox_host	object | null	oui	Proxmox node data (storages, bridges, versions); null for a Hyper-V host.
unprotectable_reason	"pve_unsupported_version" | null	oui	Not null: no VM or container of the endpoint can be protected, the backend creates no job. The portal shows "Proxmox version out of support".
truncated	boolean	oui
vms	array of object	oui