Veritas NetBackup Jobs API

openapi: 3.1.0
info:
  title: Veritas NetBackup REST Clients Jobs 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
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
security:
- jwtAuth: []
tags:
- 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.
paths:
  /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
components:
  schemas:
    JobTryLogResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                const: jobTryLogEntry
              id:
                type: string
              attributes:
                type: object
                properties:
                  tryNumber:
                    type: integer
                    description: Attempt number
                  pid:
                    type: integer
                    description: Process ID
                  statusCode:
                    type: integer
                    description: Status code for this attempt
                  statusMessage:
                    type: string
                    description: Human-readable status message
                  startTime:
                    type: string
                    format: date-time
                    description: When this attempt started
                  endTime:
                    type: string
                    format: date-time
                    description: When this attempt ended
                  mediaServer:
                    type: string
                    description: Media server used for this attempt
                  storageUnit:
                    type: string
                    description: Storage unit used for this attempt
                  kilobytesTransferred:
                    type: integer
                    description: Data transferred in this attempt
                  filesTransferred:
                    type: integer
                    description: Files processed in this attempt
          example: []
    JobListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                const: job
              id:
                type: string
              attributes:
                $ref: '#/components/schemas/JobAttributes'
              links:
                type: object
                properties:
                  self:
                    type: object
                    properties:
                      href:
                        type: string
                        format: uri
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    ErrorResponse:
      type: object
      properties:
        errorCode:
          type: integer
          description: Numeric error code
          example: 10
        errorMessage:
          type: string
          description: Human-readable error description
          example: example_value
        details:
          type: array
          description: Additional error details
          items:
            type: object
            properties:
              errorCode:
                type: integer
                description: Detailed error code
              errorMessage:
                type: string
                description: Detailed error message
          example: []
    PaginationMeta:
      type: object
      properties:
        pagination:
          type: object
          properties:
            page[limit]:
              type: integer
              description: The maximum number of items per page
            page[offset]:
              type: integer
              description: The current offset
            count:
              type: integer
              description: Total number of items matching the query
            last:
              type: integer
              description: Offset of the last page
          example: example_value
    JobResource:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              const: job
            id:
              type: string
              description: The job ID
            attributes:
              $ref: '#/components/schemas/JobAttributes'
            links:
              type: object
              properties:
                self:
                  type: object
                  properties:
                    href:
                      type: string
                      format: uri
                      description: Link to this job resource
          example: example_value
    JobFileListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                const: jobFileEntry
              id

# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/veritas-netbackup/refs/heads/main/openapi/veritas-netbackup-jobs-api-openapi.yml