Jobs

The /jobs resource collection represents jobs created in Veeam Backup for Nutanix AHV.

Get Collection of Jobs

The HTTP GET request to the /jobs endpoint retrieves a list of all jobs created in Veeam Backup for Nutanix AHV.

SecurityBearer

Request

query Parameters

offset	integer <int32> >= 0 Default: 0 Excludes from a response the first N items of a resource collection.
limit	integer <int32> >= -1 Default: 100 Specifies the maximum number of items of a resource collection to return in a response.
write-only	Array of objects or null (FilterParameter) Specifies the criteria for items to be returned in a response. For more information, see the Veeam Backup for Nutanix AHV REST API Reference Overview, section Filter Parameters.
write-only	Array of objects or null (SortParameter) Specifies the order of items in the response. For more information, see the Veeam Backup for Nutanix AHV REST API Reference Overview, section Sort Parameters.

Responses

200

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v7/jobs

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"results": [{"id": "string",
"name": "string",
"description": "string",
"mode": "Unknown",
"settings": {"id": "string",
"name": "string",
"description": "string",
"mode": "Unknown",
"repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
"compression": "None",
"backupBlockSize": "None",
"includes": {"objects": [{"id": "string",
"clusterId": "string",
"type": "Unknown"
}
]
},
"excludes": {"objects": [{"id": "string",
"clusterId": "string",
"type": "Unknown"
}
]
},
"diskFilterSettings": {"filters": [{"object": {"id": null,
"clusterId": null,
"type": null
},
"filter": {"mode": null,
"disks": [ ],
"volumeGroups": [ ]
}
}
]
},
"scheduleSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
},
"periodic": {"interval": 1,
"mode": "Unknown"
},
"automaticRetry": true,
"retryCount": 0,
"retryTimeDelay": 0
},
"activeFullSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"deletedVmRetention": {"enabled": true,
"days": 0
},
"gfsSettings": {"enabled": true,
"weekly": {"enabled": true,
"weeklyRetention": 0,
"day": "Unknown"
},
"monthly": {"enabled": true,
"monthlyRetention": 0,
"week": "None"
},
"yearly": {"enabled": true,
"yearlyRetention": 0,
"month": "Unknown"
}
},
"healthCheckSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"syntheticFullSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"retentionSettings": {"type": "Unknown",
"restorePointsToKeep": 0,
"daysToKeep": 0
}
},
"status": "Unknown",
"objects": 0,
"nextRunInfo": "string",
"nextRunUtc": "2019-08-24T14:15:22Z",
"lastRunUtc": "2019-08-24T14:15:22Z",
"lastSessionId": "ef12b7ec-84a8-49ff-be5f-636424aa5ac4",
"enabled": true
}
]
}

Create Job

The HTTP POST request to the /jobs endpoint creates a new job.

SecurityBearer

Request

Request Body schema: application/json
required

Job object.

name required	string Name of the job.
mode required	string (JobMode) Type of the job. Enum: "Unknown" "Backup" "Snapshot" "PdSnapshot"
required	object (RetentionSettings)
required	object (ScheduleSettings)
description	string or null Description of the job.
repositoryId	string or null <uuid> ID of a repository where backups created by the job are stored.
compression	string (JobCompressionType) Default: "Lz4" Backup compression level. Enum: "None" "Rle" "Lz4" "Zstd3" "Zstd9"
backupBlockSize	string (BackupBlockSize) Backup block size. Enum: "None" "Kb256" "Kb512" "Kb1024" "Kb4096"
	object or null (JobIncludes)
	object or null (JobExcludes)
	object or null (DiskFilterSettings)
	object or null (ActiveFullSettings)
	object or null (DeletedVmRetentionSettings)
	object or null (GfsSettings)
	object or null (HealthCheckSettings)
	object or null (SyntheticFullSettings)

Responses

201

Created

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v7/jobs

Request samples

application/json

{"name": "string",
"description": "string",
"mode": "Unknown",
"repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
"compression": "None",
"backupBlockSize": "None",
"includes": {"objects": [{"id": "string",
"clusterId": "string",
"type": "Unknown"
}
]
},
"excludes": {"objects": [{"id": "string",
"clusterId": "string",
"type": "Unknown"
}
]
},
"diskFilterSettings": {"filters": [{"object": {"id": "string",
"clusterId": "string",
"type": "Unknown"
},
"filter": {"mode": "Unknown",
"disks": [{"busType": "Unknown",
"index": 0
}
],
"volumeGroups": [{"id": "string",
"name": "string"
}
]
}
}
]
},
"scheduleSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
},
"periodic": {"interval": 1,
"mode": "Unknown"
},
"automaticRetry": true,
"retryCount": 0,
"retryTimeDelay": 0
},
"activeFullSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"deletedVmRetention": {"enabled": true,
"days": 0
},
"gfsSettings": {"enabled": true,
"weekly": {"enabled": true,
"weeklyRetention": 0,
"day": "Unknown"
},
"monthly": {"enabled": true,
"monthlyRetention": 0,
"week": "None"
},
"yearly": {"enabled": true,
"yearlyRetention": 0,
"month": "Unknown"
}
},
"healthCheckSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"syntheticFullSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"retentionSettings": {"type": "Unknown",
"restorePointsToKeep": 0,
"daysToKeep": 0
}
}

Response samples

application/json

{"id": "string"
}

Get Job Data

The HTTP GET request to the /jobs/{id} endpoint retrieves configuration of a job with the specified ID.

SecurityBearer

Request

path Parameters

required

string

System ID assigned to a job in Veeam Backup for Nutanix AHV.

Responses

200

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

404

Job Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v7/jobs/{id}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"mode": "Unknown",
"settings": {"id": "string",
"name": "string",
"description": "string",
"mode": "Unknown",
"repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
"compression": "None",
"backupBlockSize": "None",
"includes": {"objects": [{"id": "string",
"clusterId": "string",
"type": "Unknown"
}
]
},
"excludes": {"objects": [{"id": "string",
"clusterId": "string",
"type": "Unknown"
}
]
},
"diskFilterSettings": {"filters": [{"object": {"id": "string",
"clusterId": "string",
"type": "Unknown"
},
"filter": {"mode": "Unknown",
"disks": [{"busType": null,
"index": null
}
],
"volumeGroups": [{"id": null,
"name": null
}
]
}
}
]
},
"scheduleSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
},
"periodic": {"interval": 1,
"mode": "Unknown"
},
"automaticRetry": true,
"retryCount": 0,
"retryTimeDelay": 0
},
"activeFullSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"deletedVmRetention": {"enabled": true,
"days": 0
},
"gfsSettings": {"enabled": true,
"weekly": {"enabled": true,
"weeklyRetention": 0,
"day": "Unknown"
},
"monthly": {"enabled": true,
"monthlyRetention": 0,
"week": "None"
},
"yearly": {"enabled": true,
"yearlyRetention": 0,
"month": "Unknown"
}
},
"healthCheckSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"syntheticFullSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"retentionSettings": {"type": "Unknown",
"restorePointsToKeep": 0,
"daysToKeep": 0
}
},
"status": "Unknown",
"objects": 0,
"nextRunInfo": "string",
"nextRunUtc": "2019-08-24T14:15:22Z",
"lastRunUtc": "2019-08-24T14:15:22Z",
"lastSessionId": "ef12b7ec-84a8-49ff-be5f-636424aa5ac4",
"enabled": true
}

Delete Job

The HTTP DELETE request to the /jobs/{id} endpoint deletes a job with the specified ID.

SecurityBearer

Request

path Parameters

required

string

System ID assigned to a job in Veeam Backup for Nutanix AHV.

Responses

204

No Content

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

404

Job Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

delete/api/v7/jobs/{id}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/problem+json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {"property1": { },
"property2": { }
}
}

Get Job Setting

The HTTP POST request to the /jobs/{id}/settings endpoint retrieves settings of a job with the specified ID.

SecurityBearer

Request

path Parameters

required

string

System ID assigned to a job in Veeam Backup for Nutanix AHV.

Responses

200

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

404

Job Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v7/jobs/{id}/settings

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"mode": "Unknown",
"repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
"compression": "None",
"backupBlockSize": "None",
"includes": {"objects": [{"id": "string",
"clusterId": "string",
"type": "Unknown"
}
]
},
"excludes": {"objects": [{"id": "string",
"clusterId": "string",
"type": "Unknown"
}
]
},
"diskFilterSettings": {"filters": [{"object": {"id": "string",
"clusterId": "string",
"type": "Unknown"
},
"filter": {"mode": "Unknown",
"disks": [{"busType": "Unknown",
"index": 0
}
],
"volumeGroups": [{"id": "string",
"name": "string"
}
]
}
}
]
},
"scheduleSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
},
"periodic": {"interval": 1,
"mode": "Unknown"
},
"automaticRetry": true,
"retryCount": 0,
"retryTimeDelay": 0
},
"activeFullSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"deletedVmRetention": {"enabled": true,
"days": 0
},
"gfsSettings": {"enabled": true,
"weekly": {"enabled": true,
"weeklyRetention": 0,
"day": "Unknown"
},
"monthly": {"enabled": true,
"monthlyRetention": 0,
"week": "None"
},
"yearly": {"enabled": true,
"yearlyRetention": 0,
"month": "Unknown"
}
},
"healthCheckSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"syntheticFullSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"retentionSettings": {"type": "Unknown",
"restorePointsToKeep": 0,
"daysToKeep": 0
}
}

Modify Job Settings

The HTTP PUT request to the /jobs/{id}/settings endpoint updates settings of a job with the specified ID.

SecurityBearer

Request

path Parameters

required

string

System ID assigned to a job in Veeam Backup for Nutanix AHV.

Request Body schema: application/json
required

Specifies job settings.

name required	string Name of the job.
mode required	string (JobMode) Type of the job. Enum: "Unknown" "Backup" "Snapshot" "PdSnapshot"
required	object (RetentionSettings)
required	object (ScheduleSettings)
description	string or null Description of the job.
repositoryId	string or null <uuid> ID of a repository where backups created by the job are stored.
compression	string (JobCompressionType) Default: "Lz4" Backup compression level. Enum: "None" "Rle" "Lz4" "Zstd3" "Zstd9"
backupBlockSize	string (BackupBlockSize) Backup block size. Enum: "None" "Kb256" "Kb512" "Kb1024" "Kb4096"
	object or null (JobIncludes)
	object or null (JobExcludes)
	object or null (DiskFilterSettings)
	object or null (ActiveFullSettings)
	object or null (DeletedVmRetentionSettings)
	object or null (GfsSettings)
	object or null (HealthCheckSettings)
	object or null (SyntheticFullSettings)

Responses

204

No Content

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

409

Conflict. The request could not be processed.

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

put/api/v7/jobs/{id}/settings

Request samples

application/json

{"name": "string",
"description": "string",
"mode": "Unknown",
"repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
"compression": "None",
"backupBlockSize": "None",
"includes": {"objects": [{"id": "string",
"clusterId": "string",
"type": "Unknown"
}
]
},
"excludes": {"objects": [{"id": "string",
"clusterId": "string",
"type": "Unknown"
}
]
},
"diskFilterSettings": {"filters": [{"object": {"id": "string",
"clusterId": "string",
"type": "Unknown"
},
"filter": {"mode": "Unknown",
"disks": [{"busType": "Unknown",
"index": 0
}
],
"volumeGroups": [{"id": "string",
"name": "string"
}
]
}
}
]
},
"scheduleSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
},
"periodic": {"interval": 1,
"mode": "Unknown"
},
"automaticRetry": true,
"retryCount": 0,
"retryTimeDelay": 0
},
"activeFullSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"deletedVmRetention": {"enabled": true,
"days": 0
},
"gfsSettings": {"enabled": true,
"weekly": {"enabled": true,
"weeklyRetention": 0,
"day": "Unknown"
},
"monthly": {"enabled": true,
"monthlyRetention": 0,
"week": "None"
},
"yearly": {"enabled": true,
"yearlyRetention": 0,
"month": "Unknown"
}
},
"healthCheckSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"syntheticFullSettings": {"enabled": true,
"type": "Unknown",
"weekly": {"startTime": "10:00",
"configuredDays": "None",
"selectedDays": ["Unknown"
]
},
"monthly": {"startTime": "10:00",
"configuredWeekOrDay": "None",
"dayOfWeek": "Unknown",
"dayOfMonth": 0,
"months": ["Unknown"
]
}
},
"retentionSettings": {"type": "Unknown",
"restorePointsToKeep": 0,
"daysToKeep": 0
}
}

Response samples

application/problem+json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {"property1": { },
"property2": { }
}
}

Start Job

The HTTP POST request to the /jobs/{id}/start endpoint launches a job with the specified ID.

SecurityBearer

Request

path Parameters

required

string

System ID assigned to a job in Veeam Backup for Nutanix AHV.

query Parameters

backupMode

string (BackupMode)

Specifies the backup type (active full or incremental). If the parameter value is not defined or is set to unknown, an incremental backup is created. If an incremental backup cannot be created or an active full backup is scheduled on this day, an active full backup will be created even if you start an incremental run.

Enum: "Unknown" "IncrementalBackup" "ActiveFullBackup"

Responses

202

Accepted

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

404

Job Not Found. One or more resources specified in the request could not be found in the specified resource collection.

409

Conflict. The request could not be processed. Another backup or restore task is in progress.

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v7/jobs/{id}/start

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}

Stop Job

The HTTP POST request to the /jobs/{id}/stop endpoint stops execution of a job with the specified ID.

SecurityBearer

Request

path Parameters

required

string

System ID assigned to a job in Veeam Backup for Nutanix AHV.

Responses

204

No Content

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

404

Job Not Found. One or more resources specified in the request could not be found in the specified resource collection.

409

Conflict. The request could not be processed. Another backup or restore task is in progress.

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v7/jobs/{id}/stop

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/problem+json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {"property1": { },
"property2": { }
}
}

Retry Job

The HTTP POST request to the /jobs/{id}/retry endpoint restarts the operation for the failed resources added to a job with the specified ID.

SecurityBearer

Request

path Parameters

required

string

System ID assigned to a job in Veeam Backup for Nutanix AHV.

Responses

202

Accepted

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

404

Job Not Found. One or more resources specified in the request could not be found in the specified resource collection.

409

Conflict. The request could not be processed.

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v7/jobs/{id}/retry

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}

Enable Job

The HTTP POST request to the /jobs/{id}/enable endpoint enables a disabled job with the specified ID.

SecurityBearer

Request

path Parameters

required

string

System ID assigned to a job in Veeam Backup for Nutanix AHV.

Responses

204

No Content

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

404

Job Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v7/jobs/{id}/enable

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/problem+json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {"property1": { },
"property2": { }
}
}

Disable Job

The HTTP POST request to the /jobs/{id}/disable endpoint disables an enabled job with the specified ID.

SecurityBearer

Request

path Parameters

required

string

System ID assigned to a job in Veeam Backup for Nutanix AHV.

Responses

204

No Content

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

404

Job Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v7/jobs/{id}/disable

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/problem+json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {"property1": { },
"property2": { }
}
}

Clone Job

The HTTP POST request to the /jobs/{id}/clone endpoint creates a copy of a job with the specified ID. If the original job is scheduled to run automatically, the created job will be automatically disabled.

SecurityBearer

Request

path Parameters

required

string

System ID assigned to a job in Veeam Backup for Nutanix AHV.

Responses

201

Created

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request

404

Job Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v7/jobs/{id}/clone

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"id": "string"
}

Jobs

Get Collection of Jobs

query Parameters

Create Job

Request Body schema: application/jsonrequired

Get Job Data

path Parameters

Delete Job

path Parameters

Get Job Setting

path Parameters

Modify Job Settings

path Parameters

Request Body schema: application/jsonrequired

Start Job

path Parameters

query Parameters

Stop Job

path Parameters

Retry Job

path Parameters

Enable Job

path Parameters

Disable Job

path Parameters

Clone Job

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required