Veritas NetBackup Policies API

openapi: 3.1.0
info:
  title: Veritas NetBackup REST Clients Policies 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: 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.
paths:
  /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]
        in: query
        description: Number of policies to skip for pagination
        schema:
          type: integer
          default: 0
          minimum: 0
        example: 10
      - name: filter
        in: query
        description: 'OData-style filter expression. Supported fields include policyName and policyType. Example: policyName eq ''my-policy'''
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: List of policies returned successfully
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/PolicyListResponse'
              examples:
                Listpolicies200Example:
                  summary: Default listPolicies 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - type: example_value
                      id: abc123
                      attributes:
                        policy: {}
                      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:
                Listpolicies401Example:
                  summary: Default listPolicies 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
    post:
      operationId: createPolicy
      summary: Veritas Netbackup Create a Backup Policy
      description: Creates a new NetBackup backup policy with the specified configuration including policy type, attributes, clients, schedules, and backup selections. The policy name must be unique within the NetBackup domain.
      tags:
      - Policies
      requestBody:
        required: true
        content:
          application/vnd.netbackup+json;version=4.0:
            schema:
              $ref: '#/components/schemas/PolicyCreateRequest'
            examples:
              CreatepolicyRequestExample:
                summary: Default createPolicy request
                x-microcks-default: true
                value:
                  data:
                    type: example_value
                    id: abc123
                    attributes:
                      policy:
                        policyName: example_value
                        policyType: example_value
                        clients: {}
                        schedules: {}
                        backupSelections: {}
      responses:
        '201':
          description: Policy created successfully
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/PolicyResource'
              examples:
                Createpolicy201Example:
                  summary: Default createPolicy 201 response
                  x-microcks-default: true
                  value:
                    data:
                      type: example_value
                      id: abc123
                      attributes:
                        policy:
                          policyName: example_value
                          policyType: example_value
                          clients: {}
                          schedules: {}
                          backupSelections: {}
                      links:
                        self:
                          href: https://www.example.com
        '400':
          description: Invalid policy configuration
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Createpolicy400Example:
                  summary: Default createPolicy 400 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '401':
          description: Unauthorized - missing or invalid JWT
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Createpolicy401Example:
                  summary: Default createPolicy 401 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '409':
          description: Conflict - policy with same name already exists
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Createpolicy409Example:
                  summary: Default createPolicy 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
  /config/policies/{policyName}:
    get:
      operationId: getPolicy
      summary: Veritas Netbackup Get a Backup Policy
      description: Retrieves the complete configuration of a specific backup policy including its attributes, client list, schedules, and backup selections.
      tags:
      - Policies
      parameters:
      - name: policyName
        in: path
        required: true
        description: The name of the policy to retrieve
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Policy details returned successfully
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/PolicyResource'
              examples:
                Getpolicy200Example:
                  summary: Default getPolicy 200 response
                  x-microcks-default: true
                  value:
                    data:
                      type: example_value
                      id: abc123
                      attributes:
                        policy:
                          policyName: example_value
                          policyType: example_value
                          clients: {}
                          schedules: {}
                          backupSelections: {}
                      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:
                Getpolicy401Example:
                  summary: Default getPolicy 401 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '404':
          description: Policy not found
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getpolicy404Example:
                  summary: Default getPolicy 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
    put:
      operationId: updatePolicy
      summary: Veritas Netbackup Update a Backup Policy
      description: Updates the configuration of an existing backup policy. The entire policy configuration must be provided in the request body. Use this to modify policy attributes, schedules, clients, or backup selections.
      tags:
      - Policies
      parameters:
      - name: policyName
        in: path
        required: true
        description: The name of the policy to update
        schema:
          type: string
        example: example_value
      - name: If-Match
        in: header
        description: ETag value for optimistic concurrency control. Must match the current ETag of the policy resource.
        schema:
          type: string
        example: example_value
      requestBody:
        required: true
        content:
          application/vnd.netbackup+json;version=4.0:
            schema:
              $ref: '#/components/schemas/PolicyCreateRequest'
            examples:
              UpdatepolicyRequestExample:
                summary: Default updatePolicy request
                x-microcks-default: true
                value:
                  data:
                    type: example_value
                    id: abc123
                    attributes:
                      policy:
                        policyName: example_value
                        policyType: example_value
                        clients: {}
                        schedules: {}
                        backupSelections: {}
      responses:
        '204':
          description: Policy updated successfully
        '400':
          description: Invalid policy configuration
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Updatepolicy400Example:
                  summary: Default updatePolicy 400 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '401':
          description: Unauthorized - missing or invalid JWT
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Updatepolicy401Example:
                  summary: Default updatePolicy 401 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '404':
          description: Policy not found
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Updatepolicy404Example:
                  summary: Default updatePolicy 404 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '412':
          description: Precondition failed - ETag mismatch
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Updatepolicy412Example:
                  summary: Default updatePolicy 412 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: deletePolicy
      summary: Veritas Netbackup Delete a Backup Policy
      description: Deletes an existing backup policy from the NetBackup configuration. Any scheduled backups associated with this policy will no longer run. Existing backup images created by this policy are not affected.
      tags:
      - Policies
      parameters:
      - name: policyName
        in: path
        required: true
        description: The name of the policy to delete
        schema:
          type: string
        example: example_value
      responses:
        '204':
          description: Policy deleted successfully
        '401':
          description: Unauthorized - missing or invalid JWT
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Deletepolicy401Example:
                  summary: Default deletePolicy 401 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '404':
          description: Policy not found
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Deletepolicy404Example:
                  summary: Default deletePolicy 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/{policyName}/clients:
    get:
      operationId: listPolicyClients
      summary: Veritas Netbackup List Clients in a Policy
      description: Returns the list of clients associated with a specific backup policy. Clients are the machines whose data is backed up according to the policy configuration.
      tags:
      - Policies
      parameters:
      - name: policyName
        in: path
        required: true
        description: The name of the policy
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Client list returned successfully
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/PolicyClientListResponse'
              examples:
                Listpolicyclients200Example:
                  summary: Default listPolicyClients 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - type: example_value
                      id: abc123
        '401':
          description: Unauthorized - missing or invalid JWT
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Listpolicyclients401Example:
                  summary: Default listPolicyClients 401 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '404':
          description: Policy not found
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Listpolicyclients404Example:
                  summary: Default listPolicyClients 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
    put:
      operationId: updatePolicyClients
      summary: Veritas Netbackup Update Clients in a Policy
      description: Replaces the client list for a specific backup policy with the provided set of clients.
      tags:
      - Policies
      parameters:
      - name: policyName
        in: path
        required: true
        description: The name of the policy
        schema:
          type: string
        example: example_value
      requestBody:
        required: true
        content:
          application/vnd.netbackup+json;version=4.0:
            schema:
              $ref: '#/components/schemas/PolicyClientListRequest'
            examples:
              UpdatepolicyclientsRequestExample:
                summary: Default updatePolicyClients request
                x-microcks-default: true
                value:
                  data:
                    type: example_value
                    attributes:
                      clients:
                      - {}
      responses:
        '204':
          description: Policy clients updated successfully
        '400':
          description: Invalid client configuration
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Updatepolicyclients400Example:
                  summary: Default updatePolicyClients 400 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '401':
          description: Unauthorized - missing or invalid JWT
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Updatepolicyclients401Example:
                  summary: Default updatePolicyClients 401 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '404':
          description: Policy not found
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Updatepolicyclients404Example:
                  summary: Default updatePolicyClients 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/{policyName}/schedules:
    get:
      operationId: listPolicySchedules
      summary: Veritas Netbackup List Schedules in a Policy
      description: Returns all schedules configured for a specific backup policy. Schedules define when and how frequently backups are performed.
      tags:
      - Policies
      parameters:
      - name: policyName
        in: path
        required: true
        description: The name of the policy
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Schedule list returned successfully
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/PolicyScheduleListResponse'
              examples:
                Listpolicyschedules200Example:
                  summary: Default listPolicySchedules 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - type: example_value
                      id: abc123
        '401':
          description: Unauthorized - missing or invalid JWT
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Listpolicyschedules401Example:
                  summary: Default listPolicySchedules 401 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '404':
          description: Policy not found
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Listpolicyschedules404Example:
                  summary: Default listPolicySchedules 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/{policyName}/schedules/{scheduleName}:
    get:
      operationId: getPolicySchedule
      summary: Veritas Netbackup Get a Specific Policy Schedule
      description: Retrieves the configuration of a specific schedule within a backup policy including its type, frequency, retention level, and storage unit settings.
      tags:
      - Policies
      parameters:
      - name: policyName
        in: path
        required: true
        description: The name of the policy
        schema:
          type: string
        example: example_value
      - name: scheduleName
        in: path
        required: true
        description: The name of the schedule
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Schedule details returned successfully
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/PolicyScheduleResource'
              examples:
                Getpolicyschedule200Example:
                  summary: Default getPolicySchedule 200 response
                  x-microcks-default: true
                  value:
                    data:
                      type: example_value
                      id: abc123
                      attributes:
                        scheduleName: example_value
                        scheduleType: FULL
                        frequency: 10
                        retentionPeriod: {}
                        storageUnit: example_value
                        backupWindow: {}
                        mediaMultiplexing: 10
                        syntheticBackup: true
        '401':
          description: Unauthorized - missing or invalid JWT
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getpolicyschedule401Example:
                  summary: Default getPolicySchedule 401 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '404':
          description: Policy or schedule not found
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getpolicyschedule404Example:
                  summary: Default getPolicySchedule 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
    put:
      operationId: updatePolicySchedule
      summary: Veritas Netbackup Create or Update a Policy Schedule
      description: Creates or updates a schedule within a backup policy. If the schedule already exists it is replaced with the provided configuration.
      tags:
      - Policies
      parameters:
      - name: policyName
        in: path
        required: true
        description: The name of the policy
        schema:
          type: string
        example: example_value
      - name: scheduleName
        in: path
        required: true
        description: The name of the schedule to create or update
        schema:
          type: string
        example: example_value
      requestBody:
        required: true
        content:
          application/vnd.netbackup+json;version=4.0:
            schema:
              $ref: '#/components/schemas/PolicyScheduleRequest'
            examples:
              UpdatepolicyscheduleRequestExample:
                summary: Default updatePolicySchedule request
                x-microcks-default: true
                value:
                  data:
                    type: example_value
                    id: abc123
                    attributes:
                      scheduleName: example_value
                      scheduleType: FULL
                      frequency: 10
                      retentionPeriod: {}
                      storageUnit: example_value
                      backupWindow: {}
                      mediaMultiplexing: 10
                      syntheticBackup: true
      responses:
        '201':
          description: Schedule created successfully
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/PolicyScheduleResource'
              examples:
                Updatepolicyschedule201Example:
                  summary: Default updatePolicySchedule 201 response
                  x-microcks-default: true
                  value:
                    data:
                      type: example_value
                      id: abc123
                      attributes:
                        scheduleName: example_value
                        scheduleType: FULL
                        frequency: 10
                        retentionPeriod: {}
                        storageUnit: example_value
                        backupWindow: {}
                        mediaMultiplexing: 10
                        syntheticBackup: true
        '204':
          description: Schedule updated successfully
        '401':
          description: Unauthorized - missing or invalid JWT
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Updatepolicyschedule401Example:
                  summary: Default updatePolicySchedule 401 response
                  x-microcks-default: true
                  value:
                    errorCode: 10
                    errorMessage: example_value
                    details:
                    - errorCode: 10
                      errorMessage: example_value
        '404':
          description: Policy not found
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Updatepolicyschedule404Example:
                  summary: Default updatePolicySchedule 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: deletePolicySchedule
      summary: Veritas Netbackup Delete a Policy Schedule
      description: Removes a schedule from a backup policy. Existing backups created by this schedule are not affected.
      tags:
      - Policies
      parameters:
      - name: policyName
        in: path
        required: true
        description: The name of the policy
        schema:
          type: string
        example: example_value
      - name: scheduleName
        in: path
        required: true
        description: The name of the schedule to delete
        schema:
          type: string
        example: example_value
      responses:
        '204':
          description: Schedule deleted successfully
        '401':
          description: Unauthorized - missing or invalid JWT
          content:
            application/vnd.netbackup+json;version=4.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Deletepolicyschedule401Example:
                  summary: Default deletePolicySchedule 401 response
                  x-microcks-default: true
    

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