@xen-orchestra/rest-api 0.15.0 → 0.17.0

package/dist/open-api/oa-examples/backup-job.oa-example.mjs

@@ -0,0 +1,128 @@
+export const vmBackupJobIds = [
+    '/rest/v0/backup-jobs/d33f3dc1-92b4-469c-ad58-4c2a106a4721',
+    '/rest/v0/backup-jobs/01d8c371-d8aa-4690-b3f2-e006e07c7681',
+];
+export const metadataBackupJobIds = [
+    '/rest/v0/backup-jobs/b50f95fd-f6b7-4027-87b6-6a02c7dcd5f5',
+    '/rest/v0/backup-jobs/b49f25fb-f5c1-3377-87b6-6a02c7dbd2c6',
+];
+export const mirrorBackupJobIds = [
+    '/rest/v0/backup-jobs/34979df2-2fb3-4a11-8b12-19d9b15f014c',
+    '/rest/v0/backup-jobs/e680c14c-ab52-45c8-bb0e-bd4ca12ea8f9',
+];
+export const partialVmBackupJobs = [
+    {
+        name: 'toto',
+        mode: 'full',
+        type: 'backup',
+        id: 'd33f3dc1-92b4-469c-ad58-4c2a106a4721',
+        href: '/rest/v0/backup-jobs/d33f3dc1-92b4-469c-ad58-4c2a106a4721',
+    },
+    {
+        name: 'zae',
+        mode: 'full',
+        type: 'mirrorBackup',
+        id: '01d8c371-d8aa-4690-b3f2-e006e07c7681',
+        href: '/rest/v0/backup-jobs/01d8c371-d8aa-4690-b3f2-e006e07c7681',
+    },
+];
+export const partialMetadataBackupJobs = [
+    {
+        name: 'another-test',
+        xoMetadata: true,
+        id: 'b49f25fb-f5c1-3377-87b6-6a02c7dcd5f5',
+        href: '/rest/v0/backup-jobs/b49f25fb-f5c1-3377-87b6-6a02c7dcd5f5',
+    },
+    {
+        name: 'test',
+        xoMetadata: true,
+        id: 'b50f95fd-f6b7-4027-87b6-6a02c7dcd5f5',
+        href: '/rest/v0/backup-jobs/b50f95fd-f6b7-4027-87b6-6a02c7dcd5f5',
+    },
+];
+export const partialMirrorBackupJobs = [
+    {
+        name: 'tata-bis',
+        mode: 'delta',
+        id: '34979df2-2fb3-4a11-8b12-19d9b15f014c',
+        href: '/rest/v0/backup-jobs/34979df2-2fb3-4a11-8b12-19d9b15f014c',
+    },
+    {
+        name: 'tata',
+        mode: 'delta',
+        id: 'e680c14c-ab52-45c8-bb0e-bd4ca12ea8f9',
+        href: '/rest/v0/backup-jobs/e680c14c-ab52-45c8-bb0e-bd4ca12ea8f9',
+    },
+];
+export const vmBackupJob = {
+    name: 'toto',
+    mode: 'full',
+    settings: {
+        '': {
+            timezone: 'Europe/Paris',
+        },
+        '7f9f4e0a-30d0-419f-9726-f43d8d55c6fe': {
+            snapshotRetention: 1,
+        },
+    },
+    vms: {
+        type: 'VM',
+        power_state: 'Running',
+    },
+    type: 'backup',
+    remotes: {
+        id: {
+            __or: [],
+        },
+    },
+    srs: {
+        id: {
+            __or: [],
+        },
+    },
+    id: 'd33f3dc1-92b4-469c-ad58-4c2a106a4721',
+};
+export const metadataBackupJob = {
+    name: 'test',
+    remotes: {
+        id: '1af95910-01b4-4e87-9c2f-d895cafe0776',
+    },
+    settings: {
+        '7653af2d-c9c6-4b31-9cbc-fdb5f296c4e5': {
+            retentionXoMetadata: 1,
+        },
+    },
+    xoMetadata: true,
+    userId: 'e531b8c9-3876-4ed9-8fd2-0476d5f825c9',
+    type: 'metadataBackup',
+    id: 'b50f95fd-f6b7-4027-87b6-6a02c7dcd5f5',
+};
+export const mirrorBackupJob = {
+    name: 'tata',
+    mode: 'delta',
+    sourceRemote: '1af95910-01b4-4e87-9c2f-d895cafe0776',
+    remotes: {
+        id: {
+            __or: ['1af95910-01b4-4e87-9c2f-d895cafe0776', '4d4c8be8-5815-42af-82ad-b413d45b2d38'],
+        },
+    },
+    settings: {
+        '8f34ee22-9b3b-4c70-a776-920c533e4844': {
+            exportRetention: 1,
+            healthCheckVmsWithTags: ['aze'],
+            healthCheckSr: 'c787b75c-3e0d-70fa-d0c3-cbfd382d7e33',
+        },
+        '': {
+            concurrency: 1,
+            nRetriesVmBackupFailures: 1,
+            timeout: 3600000,
+            maxExportRate: 1048576,
+            backupReportTpl: 'compactMjml',
+            hideSuccessfulItems: true,
+            reportWhen: 'failure',
+        },
+    },
+    type: 'mirrorBackup',
+    proxy: '83050a39-44e2-4e59-b612-860250ce9338',
+    id: 'e680c14c-ab52-45c8-bb0e-bd4ca12ea8f9',
+};

package/dist/open-api/oa-examples/backup-log.oa-example.mjs

@@ -0,0 +1,93 @@
+export const backupLogIds = ['/rest/v0/backup-logs/1753776067468', '/rest/v0/backup-logs/1753776157641'];
+export const partialBackupLogs = [
+    {
+        jobName: 'test-full',
+        status: 'success',
+        data: {
+            mode: 'full',
+            reportWhen: 'failure',
+        },
+        href: '/rest/v0/backup-logs/1753776067468',
+    },
+    {
+        jobName: 'test-full',
+        status: 'success',
+        data: {
+            mode: 'full',
+            reportWhen: 'failure',
+        },
+        href: '/rest/v0/backup-logs/1753776157641',
+    },
+];
+export const backupLog = {
+    data: {
+        mode: 'full',
+        reportWhen: 'failure',
+    },
+    id: '1753776067468',
+    jobId: '59af07fc-e82c-43b5-8137-026832f30166',
+    jobName: 'test-modal',
+    message: 'backup',
+    scheduleId: '1c7cfc78-a006-4942-aab6-b4c825ce9a4e',
+    start: 1753776067468,
+    status: 'success',
+    infos: [
+        {
+            data: {
+                vms: ['db822c15-6f7d-8920-10bd-68d40fb12ac6'],
+            },
+            message: 'vms',
+        },
+    ],
+    tasks: [
+        {
+            data: {
+                type: 'VM',
+                id: 'db822c15-6f7d-8920-10bd-68d40fb12ac6',
+                name_label: 'MRA alpine',
+            },
+            id: '1753776071015',
+            message: 'backup VM',
+            start: 1753776071015,
+            status: 'success',
+            tasks: [
+                {
+                    data: {
+                        id: '1af95910-01b4-4e87-9c2f-d895cafe0776',
+                        type: 'remote',
+                        isFull: true,
+                    },
+                    id: '1753776072502',
+                    message: 'export',
+                    start: 1753776072502,
+                    status: 'success',
+                    tasks: [
+                        {
+                            id: '1753776072532',
+                            message: 'transfer',
+                            start: 1753776072532,
+                            status: 'success',
+                            end: 1753776110123,
+                            result: {
+                                size: 298260992,
+                            },
+                        },
+                    ],
+                    end: 1753776110134,
+                },
+                {
+                    id: '1753776110440',
+                    message: 'clean-vm',
+                    start: 1753776110440,
+                    status: 'success',
+                    end: 1753776110453,
+                    result: {
+                        merge: false,
+                    },
+                },
+            ],
+            end: 1753776110457,
+        },
+    ],
+    end: 1753776110463,
+};

package/dist/open-api/oa-examples/proxy.oa-example.mjs

@@ -0,0 +1,25 @@
+export const proxyIds = [
+    '/rest/v0/proxies/e625ea0c-a876-405a-b838-109d762efe88',
+    '/rest/v0/proxies/17210f70-24f7-4309-bbf7-e6381fdc0b13',
+];
+export const partialProxies = [
+    {
+        vmUuid: '7330139d-288f-2248-5986-d508ea71f12c',
+        id: 'e625ea0c-a876-405a-b838-109d762efe88',
+        name: 'Proxy 2025-08-29T08:23:33.394Z',
+        href: '/rest/v0/proxies/e625ea0c-a876-405a-b838-109d762efe88',
+    },
+    {
+        vmUuid: '17210f70-24f7-4309-bbf7-e6381fdc0b13',
+        id: '88e3ab4d-d74a-495c-8ea2-27307f0c18ad',
+        name: 'Proxy 2022-02-13T10:45:32.644Z',
+        href: '/rest/v0/proxies/17210f70-24f7-4309-bbf7-e6381fdc0b13',
+    },
+];
+export const proxy = {
+    name: 'Proxy 2025-08-29T08:23:33.394Z',
+    vmUuid: '7330139d-288f-2248-5986-d508ea71f12c',
+    id: 'e625ea0c-a876-405a-b838-109d762efe88',
+    url: 'https://uxxa-NIAY9W29VlGMrRcKuxx2dsYMTldJo-7l2YnMNQ@10.1.7.238/',
+    version: '0.29.29',
+};

package/dist/open-api/oa-examples/restore-log.oa-example.mjs

@@ -0,0 +1,53 @@
+export const restoreLogIds = ['/rest/v0/restore/logs/1758180544428', '/rest/v0/restore/logs/1758180544430'];
+export const partialRestoreLogs = [
+    {
+        status: 'success',
+        data: {
+            backupId: '1af95910-01b4-4e87-9c2f-d895cafe0776//xo-vm-backups/5ee55483-6659-89b5-9542-afa1d0a0e0cb/20250916T120238Z.json',
+            jobId: '33156c65-45e1-431a-bdbb-8c97ae80bd47',
+            srId: 'a152347d-e2ca-bec9-2f05-58efe3c1ca61',
+            time: 1758024158524,
+        },
+        href: '/rest/v0/restore-logs/1758180544428',
+    },
+    {
+        status: 'success',
+        data: {
+            backupId: '1af95910-01b4-4e87-9c2f-d895cafe0776//xo-vm-backups/5ee55483-6659-89b5-9542-afa1d0a0e0cb/20250916T120238Z.json',
+            jobId: '33156c65-45e1-431a-bdbb-8c97ae80bd47',
+            srId: 'a152347d-e2ca-bec9-2f05-58efe3c1ca61',
+            time: 175999999,
+        },
+        href: '/rest/v0/restore-logs/1758180544430',
+    },
+];
+export const restoreLog = {
+    data: {
+        backupId: '1af95910-01b4-4e87-9c2f-d895cafe0776//xo-vm-backups/5ee55483-6659-89b5-9542-afa1d0a0e0cb/20250916T120238Z.json',
+        jobId: '33156c65-45e1-431a-bdbb-8c97ae80bd47',
+        srId: 'a152347d-e2ca-bec9-2f05-58efe3c1ca61',
+        time: 1758024158524,
+    },
+    id: '1758180544428',
+    message: 'restore',
+    start: 1758180544428,
+    status: 'success',
+    tasks: [
+        {
+            id: '1758180544486',
+            message: 'transfer',
+            start: 1758180544486,
+            status: 'success',
+            end: 1758180852221,
+            result: {
+                size: 0,
+                id: '360bf71a-56a5-eaef-6bcd-ca54c0066a10',
+            },
+        },
+    ],
+    end: 1758180852221,
+    result: {
+        size: 0,
+        id: '360bf71a-56a5-eaef-6bcd-ca54c0066a10',
+    },
+};

package/dist/open-api/oa-examples/user.oa-example.mjs

@@ -25,3 +25,35 @@ export const user = {
     id: '722d17b9-699b-49d2-8193-be1ac573d3de',
 };
 export const userId = { id: '722d17b9-699b-49d2-8193-be1ac573d3de' };
+export const authenticationTokens = [
+    {
+        client: {
+            id: 'w574r066b5',
+        },
+        created_at: 1754383334192,
+        description: 'xo-cli@0.32.2 - fedora-2.home - Linux x86_64',
+        user_id: '722d17b9-699b-49d2-8193-be1ac573d3de',
+        expiration: 1756975334192,
+        last_uses: {
+            '::1': {
+                timestamp: 1754383346794,
+            },
+        },
+        id: 'LB_DqCNhcmAoyiioNnajySHIYHrWfsIhYSYn3n8FfJA',
+    },
+    {
+        client: {
+            id: 'nemyw6m3dx',
+        },
+        created_at: 1754471974241,
+        description: 'Mozilla/5.0 (X11; Linux x86_64; rv:141.0) Gecko/20100101 Firefox/141.0',
+        user_id: '722d17b9-699b-49d2-8193-be1ac573d3de',
+        expiration: 1754507974241,
+        last_uses: {
+            '::ffff:127.0.0.1': {
+                timestamp: 1754475904704,
+            },
+        },
+        id: 'ktdlq-BX_GdS5N8MR0v7QIuoSymBw4Ys4EOxsOdqpnE',
+    },
+];

package/dist/open-api/oa-examples/vdi.oa-example.mjs

@@ -2,6 +2,9 @@ export const vdiIds = [
     '/rest/v0/vdis/5e13f673-760e-41be-826e-620d16b7f43b',
     '/rest/v0/vdis/771d5baf-4364-42f9-8c92-8e5fe08b332a',
 ];
+export const vdiId = {
+    id: '5e13f673-760e-41be-826e-620d16b7f43b',
+};
 export const partialVdis = [
     {
         type: 'VDI',