CorceLinkDocumentation Espace client

Sauvegardes

Les sauvegardes de vos VPS : création, protection, restauration et planification.

Lister les sauvegardes

GET/v1/compute/vps/{vps_id}/backups

Permission : vps:read

Paramètres de chemin

ChampTypeDescription
vps_idobligatoiretexteFormat : ^vps-[0-9a-f]{8}$. Exemple : "vps-7c2e4a91".

Réponse 200

ChampTypeDescription
dataliste de objet
data[].idtexteExemple : "bkp-27f1a0".
data[].created_attexteDate de création.
data[].size_bytesentierExemple : 1503238553.
data[].typetexteValeurs : full, incremental.
data[].protectedbooléen
data[].statustexteValeurs : creating, available, failed.
quotaobjet
quota.usedentierExemple : 3.
quota.maxentierExemple : 7.

Erreurs

curl "https://api.corcelink.fr/v1/compute/vps/vps-7c2e4a91/backups" \
  -H "Authorization: Bearer $CORCELINK_API_KEY"

Réponse 200

{
  "data": [
    {
      "id": "bkp-1",
      "created_at": "2026-10-27T03:12:00Z",
      "size_bytes": 1503238553,
      "type": "incremental",
      "protected": true,
      "status": "available"
    },
    {
      "id": "bkp-2",
      "created_at": "2026-10-26T03:11:00Z",
      "size_bytes": 1488000000,
      "type": "full",
      "protected": false,
      "status": "available"
    }
  ],
  "quota": {
    "used": 2,
    "max": 7
  }
}
Essayer avec votre clé

Votre clé reste dans ce navigateur et n’est envoyée qu’à api.corcelink.fr.

Créer une sauvegarde

POST/v1/compute/vps/{vps_id}/backups

Permission : vps:write

Le VPS reste en service pendant la sauvegarde.

Paramètres de chemin

ChampTypeDescription
vps_idobligatoiretexteFormat : ^vps-[0-9a-f]{8}$. Exemple : "vps-7c2e4a91".

En-têtes

ChampTypeDescription
Idempotency-KeytexteClé unique (UUID conseillé) : une requête répétée avec la même clé renvoie la même réponse, sans refaire l’opération. 255 caractères au plus.

Réponse 202

ChampTypeDescription
idtexteIdentifiant de l’opération. Exemple : "op-01JB7X5R1M".
typetexteNature de l’opération (vps.reboot…). Exemple : "vps.reinstall".
statustexteÉtat. Valeurs : pending, running, succeeded, failed.
resourceobjetRessource concernée.
resource.typetexteValeurs : vps, private_network, dedicated_server, web_hosting, email, domain, other, backup.
resource.idtexteExemple : "vps-7c2e4a91".
created_attexteDate de création.
started_attexte ou nullDate de création.
completed_attexte ou nullDate de création.
errorobjet ou nullErreur au format RFC 9457.
error.typetexteAdresse de la page de documentation de l’erreur. Exemple : "https://docs.corcelink.fr/api/erreurs/#vps_not_found".
error.titletexteRésumé de l’erreur, dans la langue demandée. Exemple : "VPS introuvable".
error.statusentierCode HTTP. Exemple : 404.
error.codetexteCode stable, à utiliser dans vos programmes. Exemple : "vps_not_found".
error.detailtexteExplication et correction possible. Exemple : "Aucun VPS vps-7c2e4a91 sur ce compte.".
error.request_idtexteIdentifiant de la requête, à citer au support. Exemple : "req-01JB7X4M2Q9KZ3".
error.errorsliste de objetErreurs de validation, champ par champ.
error.errors[].fieldtexteExemple : "rules[0].ports".
error.errors[].codetexteExemple : "invalid_port".
error.errors[].messagetexteExemple : "Port invalide : utilisez 443, 80,443 ou 8000:8100.".
resultobjetRésultat propre à certaines opérations ; absent sinon.
result.password_urltexteLien à usage unique vers le nouveau mot de passe root (réinstallation).
result.password_expires_attexteDate de création.

Erreurs

curl -X POST "https://api.corcelink.fr/v1/compute/vps/vps-7c2e4a91/backups" \
  -H "Authorization: Bearer $CORCELINK_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Réponse 202

{
  "id": "op-01M5Z52GZRTVSNG8",
  "type": "backup.create",
  "status": "running",
  "resource": {
    "type": "vps",
    "id": "vps-7c2e4a91"
  },
  "created_at": "2026-10-27T17:03:37Z",
  "started_at": "2026-10-27T17:03:37Z",
  "completed_at": null,
  "error": null
}

Protéger une sauvegarde

PATCH/v1/compute/vps/{vps_id}/backups/{backup_id}

Permission : vps:write

Une sauvegarde protégée n’est jamais supprimée par la rotation automatique.

Paramètres de chemin

ChampTypeDescription
vps_idobligatoiretexteFormat : ^vps-[0-9a-f]{8}$. Exemple : "vps-7c2e4a91".
backup_idobligatoiretexteExemple : "bkp-27f1a0".

En-têtes

ChampTypeDescription
Idempotency-KeytexteClé unique (UUID conseillé) : une requête répétée avec la même clé renvoie la même réponse, sans refaire l’opération. 255 caractères au plus.

Corps de la requête

ChampTypeDescription
protectedobligatoirebooléen

Réponse 200

ChampTypeDescription
idtexteExemple : "bkp-27f1a0".
created_attexteDate de création.
size_bytesentierExemple : 1503238553.
typetexteValeurs : full, incremental.
protectedbooléen
statustexteValeurs : creating, available, failed.

Erreurs

curl -X PATCH "https://api.corcelink.fr/v1/compute/vps/vps-7c2e4a91/backups/bkp-31" \
  -H "Authorization: Bearer $CORCELINK_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"protected": true}'

Réponse 200

{
  "id": "bkp-2",
  "created_at": "2026-10-26T03:11:00Z",
  "size_bytes": 1488000000,
  "type": "full",
  "protected": true,
  "status": "available"
}

Supprimer une sauvegarde

DELETE/v1/compute/vps/{vps_id}/backups/{backup_id}

Permission : vps:write

Paramètres de chemin

ChampTypeDescription
vps_idobligatoiretexteFormat : ^vps-[0-9a-f]{8}$. Exemple : "vps-7c2e4a91".
backup_idobligatoiretexteExemple : "bkp-27f1a0".

En-têtes

ChampTypeDescription
Idempotency-KeytexteClé unique (UUID conseillé) : une requête répétée avec la même clé renvoie la même réponse, sans refaire l’opération. 255 caractères au plus.

Réponse 204

Aucun contenu : l’opération est faite.

Erreurs

curl -X DELETE "https://api.corcelink.fr/v1/compute/vps/vps-7c2e4a91/backups/bkp-31" \
  -H "Authorization: Bearer $CORCELINK_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Restaurer une sauvegarde

POST/v1/compute/vps/{vps_id}/backups/{backup_id}/restore

Permission : vps:write

Remplace tout le contenu du disque par celui de la sauvegarde.

Paramètres de chemin

ChampTypeDescription
vps_idobligatoiretexteFormat : ^vps-[0-9a-f]{8}$. Exemple : "vps-7c2e4a91".
backup_idobligatoiretexteExemple : "bkp-27f1a0".

En-têtes

ChampTypeDescription
Idempotency-KeytexteClé unique (UUID conseillé) : une requête répétée avec la même clé renvoie la même réponse, sans refaire l’opération. 255 caractères au plus.

Corps de la requête

ChampTypeDescription
confirmobligatoirebooléenDoit valoir true.

Réponse 202

ChampTypeDescription
idtexteIdentifiant de l’opération. Exemple : "op-01JB7X5R1M".
typetexteNature de l’opération (vps.reboot…). Exemple : "vps.reinstall".
statustexteÉtat. Valeurs : pending, running, succeeded, failed.
resourceobjetRessource concernée.
resource.typetexteValeurs : vps, private_network, dedicated_server, web_hosting, email, domain, other, backup.
resource.idtexteExemple : "vps-7c2e4a91".
created_attexteDate de création.
started_attexte ou nullDate de création.
completed_attexte ou nullDate de création.
errorobjet ou nullErreur au format RFC 9457.
error.typetexteAdresse de la page de documentation de l’erreur. Exemple : "https://docs.corcelink.fr/api/erreurs/#vps_not_found".
error.titletexteRésumé de l’erreur, dans la langue demandée. Exemple : "VPS introuvable".
error.statusentierCode HTTP. Exemple : 404.
error.codetexteCode stable, à utiliser dans vos programmes. Exemple : "vps_not_found".
error.detailtexteExplication et correction possible. Exemple : "Aucun VPS vps-7c2e4a91 sur ce compte.".
error.request_idtexteIdentifiant de la requête, à citer au support. Exemple : "req-01JB7X4M2Q9KZ3".
error.errorsliste de objetErreurs de validation, champ par champ.
error.errors[].fieldtexteExemple : "rules[0].ports".
error.errors[].codetexteExemple : "invalid_port".
error.errors[].messagetexteExemple : "Port invalide : utilisez 443, 80,443 ou 8000:8100.".
resultobjetRésultat propre à certaines opérations ; absent sinon.
result.password_urltexteLien à usage unique vers le nouveau mot de passe root (réinstallation).
result.password_expires_attexteDate de création.

Erreurs

curl -X POST "https://api.corcelink.fr/v1/compute/vps/vps-7c2e4a91/backups/bkp-31/restore" \
  -H "Authorization: Bearer $CORCELINK_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"confirm": true}'

Réponse 202

{
  "id": "op-01M5Z52H0MBMF3C5",
  "type": "backup.restore",
  "status": "running",
  "resource": {
    "type": "vps",
    "id": "vps-7c2e4a91"
  },
  "created_at": "2026-10-27T17:03:37Z",
  "started_at": "2026-10-27T17:03:37Z",
  "completed_at": null,
  "error": null
}

Lire la planification

GET/v1/compute/vps/{vps_id}/backup-schedules

Permission : vps:read

Paramètres de chemin

ChampTypeDescription
vps_idobligatoiretexteFormat : ^vps-[0-9a-f]{8}$. Exemple : "vps-7c2e4a91".

Réponse 200

ChampTypeDescription
dataliste de objet
data[].idtexteExemple : "bks-04".
data[].daysliste de texte
data[].timetexteExemple : "03:00".
data[].modetexteValeurs : live, suspend, stop.
data[].compressiontexteExemple : "zstd".
data[].last_run_attexte ou nullDate de création.

Erreurs

curl "https://api.corcelink.fr/v1/compute/vps/vps-7c2e4a91/backup-schedules" \
  -H "Authorization: Bearer $CORCELINK_API_KEY"

Réponse 200

{
  "data": [
    {
      "id": "bks-1",
      "days": [
        "mon",
        "wed",
        "fri"
      ],
      "time": "03:00",
      "mode": "live",
      "compression": "zstd",
      "last_run_at": "2026-10-27T03:12:00Z"
    }
  ]
}
Essayer avec votre clé

Votre clé reste dans ce navigateur et n’est envoyée qu’à api.corcelink.fr.