Backups

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

List endpoint jobs

GET /endpoints/{id}/jobs

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

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui
limit	requête	integer	non	Défaut : 50. Valeur : 1 à 100.
cursor	requête	string	non	Longueur minimum : 1.
type	requête	"backup" | "baremetal_backup" | "mssql_backup" | "vm_backup" | "init" | "unlock" | "forget" | "prune" | "check" | "migrate" | "update" | "reset_first_backup"	non
status	requête	"scheduled" | "dispatched" | "running" | "succeeded" | "partial" | "failed" | "cancelled" | "interrupted" | "preempted" | "missed" | "superseded"	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
items	array of object	oui
items[].id	string (uuid)	oui
items[].endpoint_id	string (uuid)	oui
items[].type	"backup" | "baremetal_backup" | "mssql_backup" | "vm_backup" | "init" | "unlock" | "forget" | "prune" | "check" | "migrate" | "update" | "reset_first_backup"	oui
items[].status	"scheduled" | "dispatched" | "running" | "succeeded" | "partial" | "failed" | "cancelled" | "interrupted" | "preempted" | "missed" | "superseded"	oui
items[].trigger	"schedule" | "manual" | "system"	oui
items[].policy_id	string (uuid) | null	non	The backup policy of a backup run; null for maintenance or a backup without policy. Optional for older readers [C13], always sent.
items[].cause	string | null	oui	Typed cause, for example no_ack or repo_migrating
items[].scheduled_at	string (date-time)	oui	Request time for a manual job.
items[].window_ends_at	string (date-time) | null	oui
items[].started_at	string (date-time) | null	oui
items[].ended_at	string (date-time) | null	oui
items[].snapshot_id	string | null	oui	succeeded or partial backup only.
items[].summary	object | null	oui	Final restic summary, backup only.
items[].error_count	integer | null	oui	Unreadable files of a partial backup.
items[].file_error_codes	array of object | null	non	Count per typed code of the stored file errors of a partial backup (at most 100; error_count is the real total), most frequent first, without paths or text: for every role and for an OAuth access token (MCP). Null without stored errors. Optional for older readers [C13], always sent.
items[].error	string | null	oui
items[].upload_limit	number | null	non	Upload limit sent to the agent for this backup, MiB/s: the exception of the agent, else the limit of the policy, fixed when the order is sent. Null: no limit, or not a backup. Optional for older readers [C13], always sent.
items[].progress	object | null	oui	Only while running
items[].hooks	object | null	non	Scripts before and after a backup, per phase: version, SHA-256, status, exit code, duration, output. Null: none ran. Optional for older readers [C13], always sent.
items[].volume	object | null	non	Size and count of a succeeded or partial backup of any kind. Null: not a backup, no snapshot, or another status. Optional for older readers [C13], always sent.
next_cursor	string | null	oui

Create endpoint job

POST /endpoints/{id}/jobs

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
type	"backup" | "baremetal_backup"	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
id	string (uuid)	oui
endpoint_id	string (uuid)	oui
type	"backup" | "baremetal_backup" | "mssql_backup" | "vm_backup" | "init" | "unlock" | "forget" | "prune" | "check" | "migrate" | "update" | "reset_first_backup"	oui
status	"scheduled" | "dispatched" | "running" | "succeeded" | "partial" | "failed" | "cancelled" | "interrupted" | "preempted" | "missed" | "superseded"	oui
trigger	"schedule" | "manual" | "system"	oui
policy_id	string (uuid) | null	non	The backup policy of a backup run; null for maintenance or a backup without policy. Optional for older readers [C13], always sent.
cause	string | null	oui	Typed cause, for example no_ack or repo_migrating
scheduled_at	string (date-time)	oui	Request time for a manual job.
window_ends_at	string (date-time) | null	oui
started_at	string (date-time) | null	oui
ended_at	string (date-time) | null	oui
snapshot_id	string | null	oui	succeeded or partial backup only.
summary	object | null	oui	Final restic summary, backup only.
error_count	integer | null	oui	Unreadable files of a partial backup.
file_error_codes	array of object | null	non	Count per typed code of the stored file errors of a partial backup (at most 100; error_count is the real total), most frequent first, without paths or text: for every role and for an OAuth access token (MCP). Null without stored errors. Optional for older readers [C13], always sent.
error	string | null	oui
upload_limit	number | null	non	Upload limit sent to the agent for this backup, MiB/s: the exception of the agent, else the limit of the policy, fixed when the order is sent. Null: no limit, or not a backup. Optional for older readers [C13], always sent.
progress	object | null	oui	Only while running
hooks	object | null	non	Scripts before and after a backup, per phase: version, SHA-256, status, exit code, duration, output. Null: none ran. Optional for older readers [C13], always sent.
volume	object | null	non	Size and count of a succeeded or partial backup of any kind. Null: not a backup, no snapshot, or another status. Optional for older readers [C13], always sent.

List endpoint snapshots

GET /endpoints/{id}/snapshots

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

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui
limit	requête	integer	non	Défaut : 50. Valeur : 1 à 100.
cursor	requête	string	non	Longueur minimum : 1.
backup_kind	requête	"files" | "baremetal" | "mssql" | "hyperv" | "proxmox"	non	Only the snapshots of this kind. Another value: 400.
policy_id	requête	string (uuid)	non	Only the snapshots of this policy.
vm_key	requête	string	non	Only the snapshots of this Hyper-V VM, or Proxmox VM or container

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	oui
items[].job_id	string (uuid)	oui
items[].backup_kind	"files" | "baremetal" | "mssql" | "hyperv" | "proxmox"	oui	Read from the backend database, never from the agent: baremetal for a full machine backup.
items[].policy_id	string (uuid) | null	non	The policy whose retention applies; null: no retention removes it. Optional for older readers [C13], always sent.
items[].vm_key	string | null	non	hyperv and proxmox only: the VM or container of the snapshot (one snapshot per guest and run). Null otherwise. Optional for older readers.
items[].server_time	string (date-time)	oui	job.ended_at, the date used by forget (decision B1)
items[].restic_time	string (date-time) | null	oui	Written by the agent, information only.
items[].paths	array of string	oui
items[].source_bytes	integer | null	oui
items[].added_bytes	integer | null	oui
items[].file_count	integer | null	oui
items[].vm_capture	object | null	non	hyperv and proxmox only: the capture of the VM or container, from its vm_result; null when the backend has none. Absent otherwise.
next_cursor	string | null	oui

List snapshot tree

POST /endpoints/{id}/snapshots/{snapshot_id}/tree

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

Paramètres

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

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
path	string	oui
limit	integer	non	Défaut : 500. Valeur : 1 à 1000.
cursor	string	non	Longueur maximum : 1024.

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
snapshot_id	string	oui
path	string	oui	The listed directory, as received.
entries	array of object	oui	Éléments maximum : 1000.
entries[].name	string	oui	Name without the path. Shown with U+FFFD when invalid_name
entries[].path	string	non	Absolute path, in a search result only.
entries[].type	"dir" | "file" | "symlink" | "other"	oui	other: device, fifo, socket, restic irregular
entries[].size	integer	non	Bytes, file only. restic keeps no directory size. Valeur minimum : 0.
entries[].mtime	string (date-time)	non	Modification time read by the agent at backup, UTC. Information only.
entries[].invalid_name	boolean	non	Name not valid UTF-8: neither expandable nor selectable.
next_cursor	string	non	Present when entries are left. Longueur minimum : 1.

Search snapshot

POST /endpoints/{id}/snapshots/{snapshot_id}/search

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

Paramètres

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

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
path	string	non
name	string	non	Longueur minimum : 1.
type	"file" | "dir"	non
min_size	integer	non	Valeur minimum : 0.
max_size	integer	non	Valeur minimum : 0.
mtime_after	string (date-time)	non
mtime_before	string (date-time)	non
limit	integer	non	Défaut : 200. Valeur : 1 à 1000.
cursor	string	non	Longueur maximum : 8192.

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
snapshot_id	string	oui
path	string	oui	The listed directory, as received.
entries	array of object	oui	Éléments maximum : 1000.
entries[].name	string	oui	Name without the path. Shown with U+FFFD when invalid_name
entries[].path	string	oui	Absolute path, in a search result only.
entries[].type	"dir" | "file" | "symlink" | "other"	oui	other: device, fifo, socket, restic irregular
entries[].size	integer	non	Bytes, file only. restic keeps no directory size. Valeur minimum : 0.
entries[].mtime	string (date-time)	non	Modification time read by the agent at backup, UTC. Information only.
entries[].invalid_name	boolean	non	Name not valid UTF-8: neither expandable nor selectable.
next_cursor	string	non	Present when entries are left. Longueur minimum : 1.
scanned	integer	oui	Entries read for this page. Valeur minimum : 0.
truncated	boolean	oui

Size snapshot selection

POST /endpoints/{id}/snapshots/{snapshot_id}/selection-size

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

Paramètres

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

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
paths	array of string	oui	Éléments : 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
bytes	integer	oui	Valeur minimum : 0.
files	integer	oui	Valeur minimum : 0.
dirs	integer	oui	Valeur minimum : 0.
truncated	boolean	oui	Stopped after 2000000 entries read: bytes is a lower bound.

Get job

GET /jobs/{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
endpoint_id	string (uuid)	oui
type	"backup" | "baremetal_backup" | "mssql_backup" | "vm_backup" | "init" | "unlock" | "forget" | "prune" | "check" | "migrate" | "update" | "reset_first_backup"	oui
status	"scheduled" | "dispatched" | "running" | "succeeded" | "partial" | "failed" | "cancelled" | "interrupted" | "preempted" | "missed" | "superseded"	oui
trigger	"schedule" | "manual" | "system"	oui
policy_id	string (uuid) | null	non	The backup policy of a backup run; null for maintenance or a backup without policy. Optional for older readers [C13], always sent.
cause	string | null	oui	Typed cause, for example no_ack or repo_migrating
scheduled_at	string (date-time)	oui	Request time for a manual job.
window_ends_at	string (date-time) | null	oui
started_at	string (date-time) | null	oui
ended_at	string (date-time) | null	oui
snapshot_id	string | null	oui	succeeded or partial backup only.
summary	object | null	oui	Final restic summary, backup only.
error_count	integer | null	oui	Unreadable files of a partial backup.
file_error_codes	array of object | null	non	Count per typed code of the stored file errors of a partial backup (at most 100; error_count is the real total), most frequent first, without paths or text: for every role and for an OAuth access token (MCP). Null without stored errors. Optional for older readers [C13], always sent.
error	string | null	oui
upload_limit	number | null	non	Upload limit sent to the agent for this backup, MiB/s: the exception of the agent, else the limit of the policy, fixed when the order is sent. Null: no limit, or not a backup. Optional for older readers [C13], always sent.
progress	object | null	oui	Only while running
hooks	object | null	non	Scripts before and after a backup, per phase: version, SHA-256, status, exit code, duration, output. Null: none ran. Optional for older readers [C13], always sent.
volume	object | null	non	Size and count of a succeeded or partial backup of any kind. Null: not a backup, no snapshot, or another status. Optional for older readers [C13], always sent.

Cancel job

POST /jobs/{id}/cancel

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
id	string (uuid)	oui
endpoint_id	string (uuid)	oui
type	"backup" | "baremetal_backup" | "mssql_backup" | "vm_backup" | "init" | "unlock" | "forget" | "prune" | "check" | "migrate" | "update" | "reset_first_backup"	oui
status	"scheduled" | "dispatched" | "running" | "succeeded" | "partial" | "failed" | "cancelled" | "interrupted" | "preempted" | "missed" | "superseded"	oui
trigger	"schedule" | "manual" | "system"	oui
policy_id	string (uuid) | null	non	The backup policy of a backup run; null for maintenance or a backup without policy. Optional for older readers [C13], always sent.
cause	string | null	oui	Typed cause, for example no_ack or repo_migrating
scheduled_at	string (date-time)	oui	Request time for a manual job.
window_ends_at	string (date-time) | null	oui
started_at	string (date-time) | null	oui
ended_at	string (date-time) | null	oui
snapshot_id	string | null	oui	succeeded or partial backup only.
summary	object | null	oui	Final restic summary, backup only.
error_count	integer | null	oui	Unreadable files of a partial backup.
file_error_codes	array of object | null	non	Count per typed code of the stored file errors of a partial backup (at most 100; error_count is the real total), most frequent first, without paths or text: for every role and for an OAuth access token (MCP). Null without stored errors. Optional for older readers [C13], always sent.
error	string | null	oui
upload_limit	number | null	non	Upload limit sent to the agent for this backup, MiB/s: the exception of the agent, else the limit of the policy, fixed when the order is sent. Null: no limit, or not a backup. Optional for older readers [C13], always sent.
progress	object | null	oui	Only while running
hooks	object | null	non	Scripts before and after a backup, per phase: version, SHA-256, status, exit code, duration, output. Null: none ran. Optional for older readers [C13], always sent.
volume	object | null	non	Size and count of a succeeded or partial backup of any kind. Null: not a backup, no snapshot, or another status. Optional for older readers [C13], always sent.

Get job logs

GET /jobs/{id}/logs

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

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui
limit	requête	integer	non	Défaut : 200. Valeur : 1 à 500.
cursor	requête	string	non	Lines after this position. Without it, the oldest line kept comes first.

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[].at	string (date-time)	oui	Server time when the gateway received the line.
items[].level	"debug" | "info" | "warn" | "error"	oui
items[].message	string	oui
items[].fields	object | null	oui	Sensitive field names are redacted.
items[].truncated	boolean	oui	The line was too long: message is cut and fields dropped.
next_cursor	string | null	oui
tail_cursor	string | null	oui
dropped_lines	integer	oui	Lines not kept: the oldest, removed by the cap of 2000 lines or 524288 bytes per job, and the lines refused once the agent spent its daily budget. Valeur minimum : 0.

List mssql instances

GET /endpoints/{id}/mssql/instances

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	Éléments maximum : 50.
items[].instance	string	oui	MSSQLSERVER for the default instance, else the instance name.
items[].version	string | null	oui	From the registry; null if unreadable.
items[].edition	string | null	oui
items[].service_state	"running" | "stopped" | "starting" | "stopping" | "paused" | "unknown"	oui
items[].supported	boolean	oui
items[].unsupported_reason	"x86" | "cluster" | "version_too_old" | null	oui	Null when supported.
items[].protocols	object	oui
items[].connection	object	oui
items[].connection_status	"ok" | "mssql_auth_failed" | "mssql_unreachable" | null	oui	Last connection result; null before any.
items[].sysadmin	boolean | null	oui	False: the portal shows the CREATE LOGIN text (spec § 5.1)
items[].server_version	string | null	oui
items[].inventory_at	string (date-time) | null	oui
items[].default_data_path	string | null	oui	InstanceDefaultDataPath of the last inventory. Null without one, for msp_readonly and for a key without browse
items[].default_log_path	string | null	oui	InstanceDefaultLogPath; null as default_data_path
items[].data_free_bytes	integer | null	oui	Free space of the volume of default_data_path
items[].log_free_bytes	integer | null	oui	Free space of the volume of default_log_path
items[].databases	array of object	oui	Éléments maximum : 1000.

Set mssql connection

PUT /endpoints/{id}/mssql/instances/{instance}/connection

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

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui
instance	chemin	string	oui	MSSQLSERVER for the default instance, else the instance name.

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
auth	"service" | "sql" | "windows"	oui
user	string | null	oui	Login or DOMAIN\user; null for service
password_set_at	string (date-time) | null	oui	Null for service
password_set_by	string (uuid) | null	oui	User who set it; null for service or a deleted user.
password_set_by_name	string | null	oui

List mssql snapshots

GET /endpoints/{id}/mssql/snapshots

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	Éléments maximum : 500.
items[].snapshot_id	string	oui
items[].created_at	string (date-time)	oui
items[].policy_id	string (uuid) | null	oui
items[].policy_name	string | null	oui
items[].job_status	"succeeded" | "partial"	oui
items[].instance	string	oui	MSSQLSERVER for the default instance, else the instance name.
items[].database_count	integer	oui	Valeur minimum : 0.
items[].total_size_bytes	integer	oui	Sum of the size_bytes of the databases. Valeur minimum : 0.
items[].data_added	integer | null	oui	Bytes added to the repo by the snapshot; null if unknown.
items[].pre_restore	boolean	oui	Safety full made before an overwrite.

Get mssql snapshot

GET /endpoints/{id}/mssql/snapshots/{snapshotId}

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

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui
snapshotId	chemin	string	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
snapshot	object	oui
snapshot.snapshot_id	string	oui
snapshot.created_at	string (date-time)	oui
snapshot.policy_id	string (uuid) | null	oui
snapshot.policy_name	string | null	oui
snapshot.job_status	"succeeded" | "partial"	oui
snapshot.instance	string	oui	MSSQLSERVER for the default instance, else the instance name.
snapshot.database_count	integer	oui	Valeur minimum : 0.
snapshot.total_size_bytes	integer	oui	Sum of the size_bytes of the databases. Valeur minimum : 0.
snapshot.data_added	integer | null	oui	Bytes added to the repo by the snapshot; null if unknown.
snapshot.pre_restore	boolean	oui	Safety full made before an overwrite.
databases	array of object	oui	Éléments maximum : 1000.
databases[].database_name	string	oui	Database name as SQL Server gives it, 1 to 128 UTF-16 code units. Longueur : 1 à 128.
databases[].instance	string	oui	MSSQLSERVER for the default instance, else the instance name.
databases[].size_bytes	integer | null	oui	Size of the stored backup; null for a failed or skipped database.
databases[].data_size_bytes	integer | null	oui	Size of the files of the database: the space a restore needs; null for a failed or skipped database.
databases[].recovery_model	"FULL" | "BULK_LOGGED" | "SIMPLE" | null	oui
databases[].server_version	string | null	oui
databases[].backup_finish_date	string (date-time) | null	oui
databases[].status	"success" | "failed" | "skipped"	oui
databases[].code	string | null	oui	Error code of a failed or skipped database.

Mssql inventory

POST /endpoints/{id}/mssql/inventory

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
instance	string	non	MSSQLSERVER for the default instance, else the instance name.
connection	object	non	Typed connection to test; absent: the stored one.

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
stored	boolean	oui	False for a test of a typed connection.
instances	array of object	oui	Éléments maximum : 50.
instances[].instance	string	oui	MSSQLSERVER for the default instance, else the instance name.
instances[].version	string | null	oui	From the registry; null if unreadable.
instances[].edition	string | null	oui
instances[].service_state	"running" | "stopped" | "starting" | "stopping" | "paused" | "unknown"	oui
instances[].supported	boolean	oui
instances[].unsupported_reason	"x86" | "cluster" | "version_too_old" | null	oui	Null when supported.
instances[].protocols	object	oui
instances[].connection	"ok" | "mssql_auth_failed" | "mssql_unreachable"	oui
instances[].sysadmin	boolean | null	oui	IS_SRVROLEMEMBER('sysadmin'); null without a connection.
instances[].server_version	string | null	oui	SERVERPROPERTY('ProductVersion'); null without a connection.
instances[].default_data_path	string | null	oui	InstanceDefaultDataPath: where a restore under a new name writes its data files.
instances[].default_log_path	string | null	oui	InstanceDefaultLogPath
instances[].data_free_bytes	integer | null	oui	Free space of the volume of default_data_path
instances[].log_free_bytes	integer | null	oui	Free space of the volume of default_log_path
instances[].databases	array of object | null	oui	Null without a connection.

List backup policies

GET /endpoints/{id}/policies

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
items[].effective	object	oui
items[].last_backup	object | null	oui	Latest retained snapshot of the policy.
items[].pending_actions	array of object	oui
items[].blocked_reason	"baremetal_unsupported_boot" | null	non	Why no backup of this policy runs: baremetal_unsupported_boot, an image policy of a BIOS or MBR machine. Null: none. Optional for older readers [C13], always sent.
items[].created_at	string (date-time)	oui
items[].updated_at	string (date-time)	oui

Create backup policy

POST /endpoints/{id}/policies

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
name	string	oui	Longueur : 1 à 100.
enabled	boolean	oui	Off: the scheduler creates no run. A manual run still works. Turning it off takes effect 72 h later [B1].
dataset	object	oui	Immutable: a policy never changes its dataset type.
schedules	array of object	oui	The runs of the policy are the union of these schedules. Éléments : 1 à 20.
timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
window_minutes	integer | "max"	non	Window of the runs of a schedule without its own window_minutes
first_backup_window	"unlimited" | "respect"	non	First backup window of the runs of a schedule without its own first_backup_window
retention	object	oui
upload_limit	number | null	non	Upload limit of the backups of the policy, MiB/s. Null or absent: no limit. The exception of the agent (Agent.upload_limit) wins. Applies from the next run. Défaut : null.
hooks	object	non	Scripts before and after the backup. Removing or weakening the pre takes effect 72 h later [B1].
hooks.pre	object | null	non	Défaut : null.
hooks.post	object | null	non	Défaut : null.

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
effective	object	oui
effective.name	string	oui	Longueur : 1 à 100.
effective.enabled	boolean	oui	Off: the scheduler creates no run. A manual run still works. Turning it off takes effect 72 h later [B1].
effective.dataset	object	oui	Immutable: a policy never changes its dataset type.
effective.schedules	array of object	oui	The runs of the policy are the union of these schedules. Éléments : 1 à 20.
effective.timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
effective.window_minutes	integer | "max"	non	Window of the runs of a schedule without its own window_minutes
effective.first_backup_window	"unlimited" | "respect"	non	First backup window of the runs of a schedule without its own first_backup_window
effective.retention	object	oui
effective.upload_limit	number | null	non	Upload limit of the backups of the policy, MiB/s. Null or absent: no limit. The exception of the agent (Agent.upload_limit) wins. Applies from the next run. Défaut : null.
effective.hooks	object	non	Scripts before and after the backup. Removing or weakening the pre takes effect 72 h later [B1].
last_backup	object | null	oui	Latest retained snapshot of the policy.
pending_actions	array of object	oui
blocked_reason	"baremetal_unsupported_boot" | null	non	Why no backup of this policy runs: baremetal_unsupported_boot, an image policy of a BIOS or MBR machine. Null: none. Optional for older readers [C13], always sent.
created_at	string (date-time)	oui
updated_at	string (date-time)	oui

Get backup policy

GET /endpoints/{id}/policies/{policyId}

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

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui
policyId	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
effective	object	oui
effective.name	string	oui	Longueur : 1 à 100.
effective.enabled	boolean	oui	Off: the scheduler creates no run. A manual run still works. Turning it off takes effect 72 h later [B1].
effective.dataset	object	oui	Immutable: a policy never changes its dataset type.
effective.schedules	array of object	oui	The runs of the policy are the union of these schedules. Éléments : 1 à 20.
effective.timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
effective.window_minutes	integer | "max"	non	Window of the runs of a schedule without its own window_minutes
effective.first_backup_window	"unlimited" | "respect"	non	First backup window of the runs of a schedule without its own first_backup_window
effective.retention	object	oui
effective.upload_limit	number | null	non	Upload limit of the backups of the policy, MiB/s. Null or absent: no limit. The exception of the agent (Agent.upload_limit) wins. Applies from the next run. Défaut : null.
effective.hooks	object	non	Scripts before and after the backup. Removing or weakening the pre takes effect 72 h later [B1].
last_backup	object | null	oui	Latest retained snapshot of the policy.
pending_actions	array of object	oui
blocked_reason	"baremetal_unsupported_boot" | null	non	Why no backup of this policy runs: baremetal_unsupported_boot, an image policy of a BIOS or MBR machine. Null: none. Optional for older readers [C13], always sent.
created_at	string (date-time)	oui
updated_at	string (date-time)	oui

Replace backup policy

PUT /endpoints/{id}/policies/{policyId}

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

Paramètres

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

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
name	string	oui	Longueur : 1 à 100.
enabled	boolean	oui	Off: the scheduler creates no run. A manual run still works. Turning it off takes effect 72 h later [B1].
dataset	object	oui	Immutable: a policy never changes its dataset type.
schedules	array of object	oui	The runs of the policy are the union of these schedules. Éléments : 1 à 20.
timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
window_minutes	integer | "max"	non	Window of the runs of a schedule without its own window_minutes
first_backup_window	"unlimited" | "respect"	non	First backup window of the runs of a schedule without its own first_backup_window
retention	object	oui
upload_limit	number | null	non	Upload limit of the backups of the policy, MiB/s. Null or absent: no limit. The exception of the agent (Agent.upload_limit) wins. Applies from the next run. Défaut : null.
hooks	object	non	Scripts before and after the backup. Removing or weakening the pre takes effect 72 h later [B1].
hooks.pre	object | null	non	Défaut : null.
hooks.post	object | null	non	Défaut : null.

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
effective	object	oui
effective.name	string	oui	Longueur : 1 à 100.
effective.enabled	boolean	oui	Off: the scheduler creates no run. A manual run still works. Turning it off takes effect 72 h later [B1].
effective.dataset	object	oui	Immutable: a policy never changes its dataset type.
effective.schedules	array of object	oui	The runs of the policy are the union of these schedules. Éléments : 1 à 20.
effective.timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
effective.window_minutes	integer | "max"	non	Window of the runs of a schedule without its own window_minutes
effective.first_backup_window	"unlimited" | "respect"	non	First backup window of the runs of a schedule without its own first_backup_window
effective.retention	object	oui
effective.upload_limit	number | null	non	Upload limit of the backups of the policy, MiB/s. Null or absent: no limit. The exception of the agent (Agent.upload_limit) wins. Applies from the next run. Défaut : null.
effective.hooks	object	non	Scripts before and after the backup. Removing or weakening the pre takes effect 72 h later [B1].
last_backup	object | null	oui	Latest retained snapshot of the policy.
pending_actions	array of object	oui
blocked_reason	"baremetal_unsupported_boot" | null	non	Why no backup of this policy runs: baremetal_unsupported_boot, an image policy of a BIOS or MBR machine. Null: none. Optional for older readers [C13], always sent.
created_at	string (date-time)	oui
updated_at	string (date-time)	oui

Delete backup policy

DELETE /endpoints/{id}/policies/{policyId}

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

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui
policyId	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
id	string (uuid)	oui
endpoint_id	string (uuid)	oui
effective	object	oui
effective.name	string	oui	Longueur : 1 à 100.
effective.enabled	boolean	oui	Off: the scheduler creates no run. A manual run still works. Turning it off takes effect 72 h later [B1].
effective.dataset	object	oui	Immutable: a policy never changes its dataset type.
effective.schedules	array of object	oui	The runs of the policy are the union of these schedules. Éléments : 1 à 20.
effective.timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
effective.window_minutes	integer | "max"	non	Window of the runs of a schedule without its own window_minutes
effective.first_backup_window	"unlimited" | "respect"	non	First backup window of the runs of a schedule without its own first_backup_window
effective.retention	object	oui
effective.upload_limit	number | null	non	Upload limit of the backups of the policy, MiB/s. Null or absent: no limit. The exception of the agent (Agent.upload_limit) wins. Applies from the next run. Défaut : null.
effective.hooks	object	non	Scripts before and after the backup. Removing or weakening the pre takes effect 72 h later [B1].
last_backup	object | null	oui	Latest retained snapshot of the policy.
pending_actions	array of object	oui
blocked_reason	"baremetal_unsupported_boot" | null	non	Why no backup of this policy runs: baremetal_unsupported_boot, an image policy of a BIOS or MBR machine. Null: none. Optional for older readers [C13], always sent.
created_at	string (date-time)	oui
updated_at	string (date-time)	oui

Run backup policy

POST /endpoints/{id}/policies/{policyId}/run

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

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui
policyId	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
id	string (uuid)	oui
endpoint_id	string (uuid)	oui
type	"backup" | "baremetal_backup" | "mssql_backup" | "vm_backup" | "init" | "unlock" | "forget" | "prune" | "check" | "migrate" | "update" | "reset_first_backup"	oui
status	"scheduled" | "dispatched" | "running" | "succeeded" | "partial" | "failed" | "cancelled" | "interrupted" | "preempted" | "missed" | "superseded"	oui
trigger	"schedule" | "manual" | "system"	oui
policy_id	string (uuid) | null	non	The backup policy of a backup run; null for maintenance or a backup without policy. Optional for older readers [C13], always sent.
cause	string | null	oui	Typed cause, for example no_ack or repo_migrating
scheduled_at	string (date-time)	oui	Request time for a manual job.
window_ends_at	string (date-time) | null	oui
started_at	string (date-time) | null	oui
ended_at	string (date-time) | null	oui
snapshot_id	string | null	oui	succeeded or partial backup only.
summary	object | null	oui	Final restic summary, backup only.
error_count	integer | null	oui	Unreadable files of a partial backup.
file_error_codes	array of object | null	non	Count per typed code of the stored file errors of a partial backup (at most 100; error_count is the real total), most frequent first, without paths or text: for every role and for an OAuth access token (MCP). Null without stored errors. Optional for older readers [C13], always sent.
error	string | null	oui
upload_limit	number | null	non	Upload limit sent to the agent for this backup, MiB/s: the exception of the agent, else the limit of the policy, fixed when the order is sent. Null: no limit, or not a backup. Optional for older readers [C13], always sent.
progress	object | null	oui	Only while running
hooks	object | null	non	Scripts before and after a backup, per phase: version, SHA-256, status, exit code, duration, output. Null: none ran. Optional for older readers [C13], always sent.
volume	object | null	non	Size and count of a succeeded or partial backup of any kind. Null: not a backup, no snapshot, or another status. Optional for older readers [C13], always sent.

Copy backup policy

POST /endpoints/{id}/policies/{policyId}/copy

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

Paramètres

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

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
target_endpoint_ids	array of string (uuid)	oui	Éléments maximum : 200.
dry_run	boolean	non	Défaut : false.

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
source_policy_id	string (uuid)	oui
dry_run	boolean	oui
results	array of object	oui

Get baremetal policy

GET /endpoints/{id}/baremetal-policy

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
effective	object	oui
effective.type	"baremetal"	oui
effective.disks	"system" | array of integer	non	Windows disk numbers; lot 2 supports one system disk. The agent must verify the selected disk contains Windows. Linux: system only. Défaut : "system".
effective.schedule	object	oui
effective.timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
effective.enabled	boolean	oui
effective.window_minutes	integer | "max"	non	Minutes after the planned time, 1 to 1439, or max: until the next run of the policy, at most 23 h 59. A backup not started is missed, a running one is stopped (interrupted)
effective.first_backup_window	"unlimited" | "respect"	non	First backup of the policy (no snapshot of it yet): unlimited runs past the end of the window; respect stops at the end of the window (interrupted) and resumes at the next run. Each resume reads all the data again.
effective.retention	object	oui
last_backup	object | null	oui	Latest retained successful image; logical length and newly added bytes are not billed repository size.
pending_actions	array of object	oui
blocked_reason	"baremetal_unsupported_boot" | null	non	Why no backup of this policy runs: baremetal_unsupported_boot, an image policy of a BIOS or MBR machine. Null: none. Optional for older readers [C13], always sent.

Replace baremetal policy

PUT /endpoints/{id}/baremetal-policy

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
type	"baremetal"	oui
disks	"system" | array of integer	non	Windows disk numbers; lot 2 supports one system disk. The agent must verify the selected disk contains Windows. Linux: system only. Défaut : "system".
schedule	object	oui
timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
enabled	boolean	oui
window_minutes	integer | "max"	non	Minutes after the planned time, 1 to 1439, or max: until the next run of the policy, at most 23 h 59. A backup not started is missed, a running one is stopped (interrupted)
first_backup_window	"unlimited" | "respect"	non	First backup of the policy (no snapshot of it yet): unlimited runs past the end of the window; respect stops at the end of the window (interrupted) and resumes at the next run. Each resume reads all the data again.
retention	object	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
effective	object	oui
effective.type	"baremetal"	oui
effective.disks	"system" | array of integer	non	Windows disk numbers; lot 2 supports one system disk. The agent must verify the selected disk contains Windows. Linux: system only. Défaut : "system".
effective.schedule	object	oui
effective.timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
effective.enabled	boolean	oui
effective.window_minutes	integer | "max"	non	Minutes after the planned time, 1 to 1439, or max: until the next run of the policy, at most 23 h 59. A backup not started is missed, a running one is stopped (interrupted)
effective.first_backup_window	"unlimited" | "respect"	non	First backup of the policy (no snapshot of it yet): unlimited runs past the end of the window; respect stops at the end of the window (interrupted) and resumes at the next run. Each resume reads all the data again.
effective.retention	object	oui
last_backup	object | null	oui	Latest retained successful image; logical length and newly added bytes are not billed repository size.
pending_actions	array of object	oui
blocked_reason	"baremetal_unsupported_boot" | null	non	Why no backup of this policy runs: baremetal_unsupported_boot, an image policy of a BIOS or MBR machine. Null: none. Optional for older readers [C13], always sent.

Create baremetal policy

POST /endpoints/{id}/baremetal-policy

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
type	"baremetal"	oui
disks	"system" | array of integer	non	Windows disk numbers; lot 2 supports one system disk. The agent must verify the selected disk contains Windows. Linux: system only. Défaut : "system".
schedule	object	oui
timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
enabled	boolean	oui
window_minutes	integer | "max"	non	Minutes after the planned time, 1 to 1439, or max: until the next run of the policy, at most 23 h 59. A backup not started is missed, a running one is stopped (interrupted)
first_backup_window	"unlimited" | "respect"	non	First backup of the policy (no snapshot of it yet): unlimited runs past the end of the window; respect stops at the end of the window (interrupted) and resumes at the next run. Each resume reads all the data again.
retention	object	oui

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
endpoint_id	string (uuid)	oui
effective	object	oui
effective.type	"baremetal"	oui
effective.disks	"system" | array of integer	non	Windows disk numbers; lot 2 supports one system disk. The agent must verify the selected disk contains Windows. Linux: system only. Défaut : "system".
effective.schedule	object	oui
effective.timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
effective.enabled	boolean	oui
effective.window_minutes	integer | "max"	non	Minutes after the planned time, 1 to 1439, or max: until the next run of the policy, at most 23 h 59. A backup not started is missed, a running one is stopped (interrupted)
effective.first_backup_window	"unlimited" | "respect"	non	First backup of the policy (no snapshot of it yet): unlimited runs past the end of the window; respect stops at the end of the window (interrupted) and resumes at the next run. Each resume reads all the data again.
effective.retention	object	oui
last_backup	object | null	oui	Latest retained successful image; logical length and newly added bytes are not billed repository size.
pending_actions	array of object	oui
blocked_reason	"baremetal_unsupported_boot" | null	non	Why no backup of this policy runs: baremetal_unsupported_boot, an image policy of a BIOS or MBR machine. Null: none. Optional for older readers [C13], always sent.

Get policy

GET /endpoints/{id}/policy

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
effective	object	oui
effective.paths	array of string	oui	Éléments minimum : 1.
effective.excludes	array of string	oui
effective.exclude_caches	boolean	oui
effective.one_file_system	boolean	oui
effective.schedule	object	oui
effective.timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
effective.enabled	boolean	oui
effective.window_minutes	integer | "max"	non	Minutes after the planned time, 1 to 1439, or max: until the next run of the policy, at most 23 h 59. A backup not started is missed, a running one is stopped (interrupted)
effective.first_backup_window	"unlimited" | "respect"	non	First backup of the policy (no snapshot of it yet): unlimited runs past the end of the window; respect stops at the end of the window (interrupted) and resumes at the next run. Each resume reads all the data again.
effective.retention	object	oui
pending_actions	array of object	oui

Replace policy

PUT /endpoints/{id}/policy

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
paths	array of string	oui	Éléments minimum : 1.
excludes	array of string	oui
exclude_caches	boolean	oui
one_file_system	boolean	oui
schedule	object	oui
timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
enabled	boolean	oui
window_minutes	integer | "max"	non	Minutes after the planned time, 1 to 1439, or max: until the next run of the policy, at most 23 h 59. A backup not started is missed, a running one is stopped (interrupted)
first_backup_window	"unlimited" | "respect"	non	First backup of the policy (no snapshot of it yet): unlimited runs past the end of the window; respect stops at the end of the window (interrupted) and resumes at the next run. Each resume reads all the data again.
retention	object	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
effective	object	oui
effective.paths	array of string	oui	Éléments minimum : 1.
effective.excludes	array of string	oui
effective.exclude_caches	boolean	oui
effective.one_file_system	boolean	oui
effective.schedule	object	oui
effective.timezone	string	oui	IANA timezone, for example Europe/Paris or UTC; service validates the name. Longueur : 1 à 255.
effective.enabled	boolean	oui
effective.window_minutes	integer | "max"	non	Minutes after the planned time, 1 to 1439, or max: until the next run of the policy, at most 23 h 59. A backup not started is missed, a running one is stopped (interrupted)
effective.first_backup_window	"unlimited" | "respect"	non	First backup of the policy (no snapshot of it yet): unlimited runs past the end of the window; respect stops at the end of the window (interrupted) and resumes at the next run. Each resume reads all the data again.
effective.retention	object	oui
pending_actions	array of object	oui

List pending actions

GET /pending-actions

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.
status	requête	"pending" | "cancelled" | "applied"	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
items	array of object	oui
next_cursor	string | null	oui

Cancel pending action

POST /pending-actions/{id}/cancel

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
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
status	"cancelled"	oui