openapi: 3.1.0
info:
title: Veritas NetBackup REST API
description: >-
The Veritas NetBackup REST API provides programmatic access to NetBackup
operations including backup job management, policy configuration, client
administration, and backup image catalog queries. The API uses JSON-based
request and response payloads, JWT-based authentication, and follows RESTful
conventions. All endpoints require authentication via a JSON Web Token
obtained from the /login endpoint on the NetBackup primary server.
version: '10.3'
contact:
name: Veritas NetBackup Support
url: https://www.veritas.com/support/en_US/netbackup
termsOfService: https://www.veritas.com/company/legal/legal-terms-of-use
license:
name: Proprietary
url: https://www.veritas.com/company/legal/legal-terms-of-use
externalDocs:
description: NetBackup REST API Getting Started Guide
url: https://sort.veritas.com/public/documents/nbu/10.3/windowsandunix/productguides/html/getting-started/
servers:
- url: https://{primaryServer}:1556/netbackup
description: NetBackup Primary Server REST API
variables:
primaryServer:
description: Hostname or IP address of the NetBackup primary server
default: netbackup-primary-server
tags:
- name: Clients
description: >-
Manage NetBackup clients including listing registered clients, retrieving
client configuration details, and managing client-server trust
relationships.
- name: Images
description: >-
Query the NetBackup image catalog to retrieve backup image metadata,
search for images by policy or client, and manage image lifecycle
operations such as expiration and duplication.
- name: Jobs
description: >-
Manage and monitor backup, restore, and administrative jobs. Retrieve job
details, list jobs by filter criteria, cancel, restart, suspend, and
resume jobs, and access job file lists and try logs.
- name: Login
description: >-
Authenticate to the NetBackup REST API and obtain a JSON Web Token for
subsequent API requests.
- name: Policies
description: >-
Create, retrieve, update, and delete backup policies. Manage policy
schedules, client lists, and backup selections that define what data gets
backed up, when, and how.
security:
- jwtAuth: []
paths:
/login:
post:
operationId: login
summary: Veritas Netbackup Authenticate and Obtain a Jwt
description: >-
Authenticates a user against the NetBackup primary server and returns a
JSON Web Token (JWT) used to authorize subsequent API calls. The token
must be included in the Authorization header as a Bearer token for all
other API requests.
tags:
- Login
security: []
requestBody:
required: true
content:
application/vnd.netbackup+json;version=1.0:
schema:
$ref: '#/components/schemas/LoginRequest'
examples:
LoginRequestExample:
summary: Default login request
x-microcks-default: true
value:
domainName: example_value
domainType: unixpwd
userName: example_value
password: example_value
responses:
'201':
description: Authentication successful, JWT returned
content:
application/vnd.netbackup+json;version=1.0:
schema:
$ref: '#/components/schemas/LoginResponse'
examples:
Login201Example:
summary: Default login 201 response
x-microcks-default: true
value:
token: example_value
tokenType: BEARER
validity: 10
'400':
description: Invalid request body
content:
application/vnd.netbackup+json;version=1.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Login400Example:
summary: Default login 400 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'401':
description: Authentication failed - invalid credentials
content:
application/vnd.netbackup+json;version=1.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Login401Example:
summary: Default login 401 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/admin/jobs:
get:
operationId: listJobs
summary: Veritas Netbackup List Backup Jobs
description: >-
Returns a list of NetBackup jobs matching the specified filter criteria.
Jobs represent backup, restore, duplication, and other administrative
operations. Results can be filtered by job type, state, policy name,
client name, and time range. Supports pagination via page[limit] and
page[offset] parameters.
tags:
- Jobs
parameters:
- name: page[limit]
in: query
description: Maximum number of jobs to return per page
schema:
type: integer
default: 10
minimum: 1
maximum: 1000
example: 10
- name: page[offset]
in: query
description: Number of jobs to skip for pagination
schema:
type: integer
default: 0
minimum: 0
example: 10
- name: filter
in: query
description: >-
OData-style filter expression to narrow results. Supported fields
include jobType, state, policyName, clientName, status, and
startTime. Example: jobType eq 'BACKUP' and state eq 'DONE'
schema:
type: string
example: example_value
- name: sort
in: query
description: >-
Comma-separated list of fields to sort by. Prefix with a hyphen
for descending order. Example: -startTime,jobId
schema:
type: string
example: example_value
responses:
'200':
description: List of jobs matching filter criteria
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/JobListResponse'
examples:
Listjobs200Example:
summary: Default listJobs 200 response
x-microcks-default: true
value:
data:
- type: example_value
id: abc123
links:
self: {}
meta:
pagination:
page[limit]: 10
page[offset]: 10
count: 10
last: 10
'401':
description: Unauthorized - missing or invalid JWT
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Listjobs401Example:
summary: Default listJobs 401 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'403':
description: Forbidden - insufficient permissions
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Listjobs403Example:
summary: Default listJobs 403 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/admin/jobs/{jobId}:
get:
operationId: getJob
summary: Veritas Netbackup Get Job Details
description: >-
Retrieves detailed information about a specific NetBackup job
identified by its job ID. Returns job metadata including type, state,
policy name, client name, schedule, start and end times, kilobytes
transferred, and number of files.
tags:
- Jobs
parameters:
- name: jobId
in: path
required: true
description: The unique identifier of the job
schema:
type: string
example: '500123'
responses:
'200':
description: Job details returned successfully
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/JobResource'
examples:
Getjob200Example:
summary: Default getJob 200 response
x-microcks-default: true
value:
data:
type: example_value
id: abc123
attributes:
jobId: '500123'
parentJobId: '500123'
jobType: BACKUP
state: QUEUED
status: 10
policyName: example_value
policyType: example_value
scheduleName: example_value
scheduleType: FULL
clientName: example_value
mediaServer: example_value
storageUnit: example_value
startTime: '2026-01-15T10:30:00Z'
endTime: '2026-01-15T10:30:00Z'
elapsedTime: 10
kilobytesTransferred: 10
filesTransferred: 10
percentComplete: 10
currentOperation: example_value
attempt: 10
restartable: true
suspendable: true
resumable: true
cancellable: true
links:
self:
href: https://www.example.com
'401':
description: Unauthorized - missing or invalid JWT
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Getjob401Example:
summary: Default getJob 401 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'404':
description: Job not found
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Getjob404Example:
summary: Default getJob 404 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteJob
summary: Veritas Netbackup Delete a Job
description: >-
Deletes a completed or failed job from the NetBackup activity monitor.
Only jobs that are in a terminal state (DONE or STOPPED) can be deleted.
tags:
- Jobs
parameters:
- name: jobId
in: path
required: true
description: The unique identifier of the job to delete
schema:
type: string
example: '500123'
responses:
'204':
description: Job deleted successfully
'401':
description: Unauthorized - missing or invalid JWT
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Deletejob401Example:
summary: Default deleteJob 401 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'404':
description: Job not found
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Deletejob404Example:
summary: Default deleteJob 404 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'409':
description: Conflict - job is still active and cannot be deleted
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Deletejob409Example:
summary: Default deleteJob 409 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/admin/jobs/{jobId}/cancel:
post:
operationId: cancelJob
summary: Veritas Netbackup Cancel a Running Job
description: >-
Cancels a currently active job. The job must be in a QUEUED or ACTIVE
state. Once cancelled, the job state changes to STOPPED.
tags:
- Jobs
parameters:
- name: jobId
in: path
required: true
description: The unique identifier of the job to cancel
schema:
type: string
example: '500123'
responses:
'204':
description: Job cancellation initiated successfully
'401':
description: Unauthorized - missing or invalid JWT
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Canceljob401Example:
summary: Default cancelJob 401 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'404':
description: Job not found
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Canceljob404Example:
summary: Default cancelJob 404 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'409':
description: Conflict - job is not in a cancellable state
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Canceljob409Example:
summary: Default cancelJob 409 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/admin/jobs/{jobId}/suspend:
post:
operationId: suspendJob
summary: Veritas Netbackup Suspend a Running Job
description: >-
Suspends an active job, pausing its execution. The job can later be
resumed using the resume endpoint.
tags:
- Jobs
parameters:
- name: jobId
in: path
required: true
description: The unique identifier of the job to suspend
schema:
type: string
example: '500123'
responses:
'204':
description: Job suspended successfully
'401':
description: Unauthorized - missing or invalid JWT
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Suspendjob401Example:
summary: Default suspendJob 401 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'404':
description: Job not found
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Suspendjob404Example:
summary: Default suspendJob 404 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'409':
description: Conflict - job is not in a suspendable state
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Suspendjob409Example:
summary: Default suspendJob 409 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/admin/jobs/{jobId}/resume:
post:
operationId: resumeJob
summary: Veritas Netbackup Resume a Suspended Job
description: >-
Resumes a previously suspended job, allowing it to continue execution
from where it was paused.
tags:
- Jobs
parameters:
- name: jobId
in: path
required: true
description: The unique identifier of the job to resume
schema:
type: string
example: '500123'
responses:
'204':
description: Job resumed successfully
'401':
description: Unauthorized - missing or invalid JWT
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Resumejob401Example:
summary: Default resumeJob 401 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'404':
description: Job not found
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Resumejob404Example:
summary: Default resumeJob 404 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'409':
description: Conflict - job is not in a suspended state
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Resumejob409Example:
summary: Default resumeJob 409 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/admin/jobs/{jobId}/restart:
post:
operationId: restartJob
summary: Veritas Netbackup Restart a Failed Job
description: >-
Restarts a job that has completed with a failed or partially successful
status. A new job is created to retry the operation.
tags:
- Jobs
parameters:
- name: jobId
in: path
required: true
description: The unique identifier of the job to restart
schema:
type: string
example: '500123'
responses:
'201':
description: Job restarted successfully, new job created
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/JobResource'
examples:
Restartjob201Example:
summary: Default restartJob 201 response
x-microcks-default: true
value:
data:
type: example_value
id: abc123
attributes:
jobId: '500123'
parentJobId: '500123'
jobType: BACKUP
state: QUEUED
status: 10
policyName: example_value
policyType: example_value
scheduleName: example_value
scheduleType: FULL
clientName: example_value
mediaServer: example_value
storageUnit: example_value
startTime: '2026-01-15T10:30:00Z'
endTime: '2026-01-15T10:30:00Z'
elapsedTime: 10
kilobytesTransferred: 10
filesTransferred: 10
percentComplete: 10
currentOperation: example_value
attempt: 10
restartable: true
suspendable: true
resumable: true
cancellable: true
links:
self:
href: https://www.example.com
'401':
description: Unauthorized - missing or invalid JWT
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Restartjob401Example:
summary: Default restartJob 401 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'404':
description: Job not found
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Restartjob404Example:
summary: Default restartJob 404 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/admin/jobs/{jobId}/file-lists:
get:
operationId: getJobFileList
summary: Veritas Netbackup Get the File List for a Job
description: >-
Returns the list of files that were processed by a specific backup or
restore job. This is useful for verifying which files were included in
a backup operation.
tags:
- Jobs
parameters:
- name: jobId
in: path
required: true
description: The unique identifier of the job
schema:
type: string
example: '500123'
- name: page[limit]
in: query
description: Maximum number of file entries to return
schema:
type: integer
default: 100
minimum: 1
maximum: 10000
example: 10
- name: page[offset]
in: query
description: Number of entries to skip for pagination
schema:
type: integer
default: 0
minimum: 0
example: 10
responses:
'200':
description: File list returned successfully
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/JobFileListResponse'
examples:
Getjobfilelist200Example:
summary: Default getJobFileList 200 response
x-microcks-default: true
value:
data:
- type: example_value
id: abc123
attributes:
fileName: example_value
fileSize: 10
meta:
pagination:
page[limit]: 10
page[offset]: 10
count: 10
last: 10
'401':
description: Unauthorized - missing or invalid JWT
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Getjobfilelist401Example:
summary: Default getJobFileList 401 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'404':
description: Job not found
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Getjobfilelist404Example:
summary: Default getJobFileList 404 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/admin/jobs/{jobId}/try-logs:
get:
operationId: getJobTryLogs
summary: Veritas Netbackup Get Try Logs for a Job
description: >-
Returns the try log entries for a specific job, providing detailed
information about each attempt to execute the job including status
messages, error codes, and timing information.
tags:
- Jobs
parameters:
- name: jobId
in: path
required: true
description: The unique identifier of the job
schema:
type: string
example: '500123'
responses:
'200':
description: Try logs returned successfully
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/JobTryLogResponse'
examples:
Getjobtrylogs200Example:
summary: Default getJobTryLogs 200 response
x-microcks-default: true
value:
data:
- type: example_value
id: abc123
attributes:
tryNumber: 10
pid: '500123'
statusCode: 10
statusMessage: example_value
startTime: '2026-01-15T10:30:00Z'
endTime: '2026-01-15T10:30:00Z'
mediaServer: example_value
storageUnit: example_value
kilobytesTransferred: 10
filesTransferred: 10
'401':
description: Unauthorized - missing or invalid JWT
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Getjobtrylogs401Example:
summary: Default getJobTryLogs 401 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
'404':
description: Job not found
content:
application/vnd.netbackup+json;version=4.0:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Getjobtrylogs404Example:
summary: Default getJobTryLogs 404 response
x-microcks-default: true
value:
errorCode: 10
errorMessage: example_value
details:
- errorCode: 10
errorMessage: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/config/policies:
get:
operationId: listPolicies
summary: Veritas Netbackup List Backup Policies
description: >-
Returns a list of NetBackup backup policies. Policies define which
clients, schedules, and backup selections are used to perform backups.
Results can be filtered by policy name and type.
tags:
- Policies
parameters:
- name: page[limit]
in: query
description: Maximum number of policies to return
schema:
type: integer
default: 10
minimum: 1
maximum: 1000
example: 10
- name: page[offset
# --- truncated at 32 KB (110 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/veritas-netbackup/refs/heads/main/openapi/veritas-netbackup-rest-api-openapi.yml