Recovery

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

Claim recovery pairing

POST /recovery/claims

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

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
code	string	oui	Longueur maximum : 16.
operator	string	non	Name or email of the person who acts through the API key. Required with an API key, ignored with a portal session. Longueur : 1 à 254.

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	"claimed" | "approved" | "expired" | "cancelled"	oui
created_at	string (date-time)	oui
expires_at	string (date-time)	oui	Approval deadline while claimed
media	object	oui
media.ip	string | null	oui
media.version	string	oui
media.hardware	object	oui
claimed_by	string (uuid) | null	oui
claimed_at	string (date-time)	oui
claimed_by_api_key_id	string (uuid) | null	oui
claim_operator	string | null	oui
approve_operator	string | null	oui
approved_by	string (uuid) | null	oui
approved_at	string (date-time) | null	oui
session	object | null	oui

Get recovery pairing

GET /recovery/pairings/{id}

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

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	"claimed" | "approved" | "expired" | "cancelled"	oui
created_at	string (date-time)	oui
expires_at	string (date-time)	oui	Approval deadline while claimed
media	object	oui
media.ip	string | null	oui
media.version	string	oui
media.hardware	object	oui
claimed_by	string (uuid) | null	oui
claimed_at	string (date-time)	oui
claimed_by_api_key_id	string (uuid) | null	oui
claim_operator	string | null	oui
approve_operator	string | null	oui
approved_by	string (uuid) | null	oui
approved_at	string (date-time) | null	oui
session	object | null	oui

Approve recovery pairing

POST /recovery/pairings/{id}/approve

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

Paramètres

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

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
endpoint_id	string (uuid)	oui	Source agent of the MSP, with a bare metal snapshot.
snapshot_id	string	oui	Bare metal snapshot of that agent, not forgotten.
target_disk	string	oui	One of media.hardware.disks[].name: erased by the restore.
mode	"replace" | "clone"	oui
code	string	non	TOTP code of the user. Required with a portal session, ignored with an API key.
operator	string	non	Name or email of the person who acts through the API key. Required with an API key, ignored with a portal session. Longueur : 1 à 254.

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	"claimed" | "approved" | "expired" | "cancelled"	oui
created_at	string (date-time)	oui
expires_at	string (date-time)	oui	Approval deadline while claimed
media	object	oui
media.ip	string | null	oui
media.version	string	oui
media.hardware	object	oui
claimed_by	string (uuid) | null	oui
claimed_at	string (date-time)	oui
claimed_by_api_key_id	string (uuid) | null	oui
claim_operator	string | null	oui
approve_operator	string | null	oui
approved_by	string (uuid) | null	oui
approved_at	string (date-time) | null	oui
session	object | null	oui

Cancel recovery pairing

POST /recovery/pairings/{id}/cancel

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

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	"claimed" | "approved" | "expired" | "cancelled"	oui
created_at	string (date-time)	oui
expires_at	string (date-time)	oui	Approval deadline while claimed
media	object	oui
media.ip	string | null	oui
media.version	string	oui
media.hardware	object	oui
claimed_by	string (uuid) | null	oui
claimed_at	string (date-time)	oui
claimed_by_api_key_id	string (uuid) | null	oui
claim_operator	string | null	oui
approve_operator	string | null	oui
approved_by	string (uuid) | null	oui
approved_at	string (date-time) | null	oui
session	object | null	oui

Get recovery iso

GET /recovery/iso

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

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
version	string	oui
url	string (uri)	oui
sha256	string	oui	Set by the platform operator with the ISO, never computed from a file a user can change.
signed	boolean	oui	True when the Baastide recovery ISO key signed this version, size and SHA-256 (baastide-recovery.iso.sig, checked by the API at start). False: no signature, or a signature that does not match; the portal must not show the ISO as verified.