Managing Backup Jobs

In this article

    Enables, starts, stops or disables a backup job with the specified ID.

    Request

    POST https://<hostname>:4443/v5/Jobs/{jobId}/action

    You can perform the following actions:

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameter must be specified in the URL of the request.

    Parameter

    Type

    Description

    jobId

    string

    An identification number of the backup job.

    Enable Backup Job

    To enable a backup job, the request body must contain the enable action:

    {"enable": null}

    Start Backup Job

    To start a backup job, the request body must contain the start action:

    {"start": null}

    Stop Backup Job

    To stop a backup job, the request body must contain the stop action:

    {"stop": null}

    Disable Backup Job

    To disable a backup job, the request body must contain the disable action:

    {"disable": null}

    Start Restore Session

    To start a restore session, the request body must contain the explore action properties:

    Property

    Type

    Description

    datetime

    UTC

    Specifies the date and time. You can specify the date and the time in one of the following formats:

    • <yyyy-MM-dd HH:mm:ss.SSS>
    • <yyyy.MM.dd hh:mm:ss>

    type

    sessionType

    Specifies the type of the restore session to start:

    • vex
    • vesp
    • veod
    • vet

    showDeleted

    boolean

    Specifies the restore session will show the deleted items.

    showAllVersions

    boolean

    Specifies the restore session will show all versions of backed-up items.

    The request command will start a restore session only for backups that were created at the time you specified. The firstBackuptime and lastBackuptime properties of the /Organization/{organizationId} resource inform you when the organization's data was backed up for the first and last times.

    Mind the following:

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    None.

    Examples

    Example 1

    The example below shows how to enable the backup job with the ID 3396ba22-21b1-4666-a631-0edfc12a59cd.

    Request:

    POST https://abc.tech.local:4443/v5/Jobs/3396ba22-21b1-4666-a631-0edfc12a59cd/action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "enable": null

    }

     

    Response:

    200 OK

    Example 2

    The example below shows how to start the backup job with the ID 3396ba22-21b1-4666-a631-0edfc12a59cd.

    Request:

    POST https://abc.tech.local:4443/v5/Jobs/3396ba22-21b1-4666-a631-0edfc12a59cd/action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "start": null

    }

     

    Response:

    200 OK

    Example 3

    The example below shows how to stop the backup job with the ID 3396ba22-21b1-4666-a631-0edfc12a59cd.

    Request:

    POST https://abc.tech.local:4443/v5/Jobs/3396ba22-21b1-4666-a631-0edfc12a59cd/action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "stop": null

    }

     

    Response:

    200 OK

    Example 4

    The example below shows how to disable the backup job with the ID 3396ba22-21b1-4666-a631-0edfc12a59cd.

    Request:

    POST https://abc.tech.local:4443/v5/Jobs/3396ba22-21b1-4666-a631-0edfc12a59cd/action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "disable": null

    }

     

    Response:

    200 OK

    Example 5

    The example below shows how to start a restore session for the backup of the backup job with the ID 3396ba22-21b1-4666-a631-0edfc12a59cd.

    Request:

    POST https://abc.tech.local:4443/v5/Jobs/3396ba22-21b1-4666-a631-0edfc12a59cd/action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "explore": {"datetime": "2020-04-12T10:54:40.2794046Z", "type": "vex"}

    }

     

    Response:

    200 OK

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.