Druva Job Management API for GovCloud Workloads

{"openapi":"3.0.0","info":{"title":"Job Management for GovCloud Workloads","version":"1.0.0"},"paths":{"/haydn/v1/{workloadName}/v1/jobs/backup":{"post":{"security":[{"Bearer":[]}],"description":"Initiates an on-demand backup for a NAS backupset.","tags":["NAS"],"summary":"On-demand backup","operationId":"CreateBackup","parameters":[{"x-go-name":"WorkloadName","description":"Specify the name of the workload. For example, 'nas'.","name":"workloadName","in":"path","required":true,"schema":{"type":"string"}},{"x-go-name":"AuthEntities","description":"Specify the authorization information in the format: 'pType=org;pID=orgID', where orgID is the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","name":"authEntities","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBackupTriggerArgs"}}},"required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CreateBackupResponse"}}}},"400":{"description":"For invalid or missing arguments.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"401":{"description":"Invalid or lack of valid authentication credentials.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"500":{"description":"Internal or unknown error.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/haydn/v1/{workloadName}/v1/jobs/backup/{jobID}/cancel":{"put":{"security":[{"Bearer":[]}],"description":"Cancels the specified backup job.","tags":["NAS"],"summary":"Cancel backup job","operationId":"CancelBackup","parameters":[{"x-go-name":"WorkloadName","description":"Specify the name of the workload. For example, 'nas'.","name":"workloadName","in":"path","required":true,"schema":{"type":"string"}},{"x-go-name":"AuthEntities","description":"Specify the authorization information in the format: 'pType=org;pID=orgID', where orgID is the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","name":"authEntities","in":"header","required":true,"schema":{"type":"string"}},{"x-go-name":"JobID","description":"Specify the ID of the job that you want to cancel. Get the ID of the job using the 'List all jobs' API.","name":"jobID","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success"},"400":{"description":"For invalid or missing arguments.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"401":{"description":"Invalid or lack of valid authentication credentials.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"500":{"description":"Internal or unknown error.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/haydn/v1/{workloadName}/v1/jobs/restore":{"post":{"security":[{"Bearer":[]}],"description":"Initiates an on-demand restore for a NAS backup set.","tags":["NAS"],"summary":"On-demand restore","operationId":"CreateRestore","parameters":[{"x-go-name":"WorkloadName","description":"Specify the name of the workload. For example, 'nas'.","name":"workloadName","in":"path","required":true,"schema":{"type":"string"}},{"x-go-name":"AuthEntities","description":"Specify the authorization information in the format: 'pType=org;pID=orgID', where orgID is the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","name":"authEntities","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRestoreTriggerArgs"}}},"required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CreateRestoreResponse"}}}},"400":{"description":"For invalid or missing arguments.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"401":{"description":"Invalid or lack of valid authentication credentials.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"500":{"description":"Internal or unknown error.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/haydn/v1/{workloadName}/v1/jobs/restore/{jobID}/cancel":{"put":{"security":[{"Bearer":[]}],"description":"Cancels the specified restore job.","tags":["NAS"],"summary":"Cancel restore job","operationId":"CancelRestore","parameters":[{"x-go-name":"WorkloadName","description":"Specify the name of the workload. For example, 'nas'.","name":"workloadName","in":"path","required":true,"schema":{"type":"string"}},{"x-go-name":"AuthEntities","description":"Specify the authorization information in the format: 'pType=org;pID=orgID', where orgID is the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","name":"authEntities","in":"header","required":true,"schema":{"type":"string"}},{"x-go-name":"JobID","description":"Specify the ID of the job that you want to cancel. Get the ID of the job using the 'List all jobs' API.","name":"jobID","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success"},"400":{"description":"For invalid or missing arguments.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"401":{"description":"Invalid or lack of valid authentication credentials.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"500":{"description":"Internal or unknown error.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}}},"x-explorer-enabled":true,"servers":[{"url":"//govapis.druva.com/unity"}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://apis.druva.com/token","scopes":{"read":"Grants read access"}}}}},"schemas":{"APIError":{"description":"APIError defines an application error result format","type":"object","properties":{"code":{"type":"string","x-go-name":"Code"},"data":{"type":"object","additionalProperties":{"type":"object"},"x-go-name":"Data"},"message":{"type":"string","x-go-name":"Message"},"retryable":{"type":"boolean","x-go-name":"Retry"}},"x-go-package":"phoenix/vendor/druva.com/godevkit/errortype"},"CreateBackupResponse":{"description":"CreateResponse is response schema for Create Request","type":"object","properties":{"job":{"$ref":"#/components/schemas/Job"}},"x-go-name":"CreateResponse","x-go-package":"git.druva.org/foundation/jobmgmt/haydn/spec/enterpriseworkload/backup/base"},"CreateBackupTriggerArgs":{"description":"CreateBackupTriggerArgs bundles all job creation params in single data type.","type":"object","required":["backupsetID"],"properties":{"backupsetID":{"description":"Specify the ID of the backup set. Get the ID using the 'List backup sets' API.","type":"integer","format":"int64","x-go-name":"BackupsetID"}},"x-go-name":"TriggerArgs","x-go-package":"git.druva.org/foundation/jobmgmt/haydn/spec/enterpriseworkload/backup/base"},"CreateRestoreResponse":{"description":"CreateResponse is response schema for Create Request","type":"object","properties":{"job":{"$ref":"#/components/schemas/Job"}},"x-go-name":"CreateResponse","x-go-package":"git.druva.org/foundation/jobmgmt/haydn/spec/enterpriseworkload/restore/base"},"CreateRestoreTriggerArgs":{"description":"CreateRestoreTriggerArgs bundles all job creation params in single data type.","type":"object","required":["backupsetID","snapshotID"],"properties":{"backupsetID":{"description":"Specify the ID of the backup set. Get the ID using the 'List backup sets' API.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"jobParams":{"$ref":"#/components/schemas/JobParams"},"restoreType":{"description":"Enter 'RegularRestore' as the restore type.","type":"string","x-go-name":"RestoreType"},"rwcConfig":{"$ref":"#/components/schemas/RWCConfig"},"snapshotID":{"description":"Specify the ID of the snapshot. Get the ID using the 'List Snapshots' API.","type":"string","x-go-name":"SnapshotID"},"snapshotName":{"description":"Specify the name of the snapshot. Get the name using 'List Snapshots' API.","type":"string","x-go-name":"SnapshotName"},"sourceList":{"description":"Specify the list of selected files or folders to restore. Get the list using 'List RP directory' API.","type":"array","items":{"type":"string"},"x-go-name":"SourceList"}},"x-go-name":"TriggerArgs","x-go-package":"git.druva.org/foundation/jobmgmt/haydn/spec/enterpriseworkload/restore/base"},"JSONMap":{"description":"Returns the data for the current job.","type":"object","additionalProperties":{"type":"object"},"x-go-package":"phoenix/pkg/dlutil"},"Job":{"description":"Job defines the schema for a job","type":"object","properties":{"actualErrorCode":{"description":"Actual error code for failed jobs.","type":"string","x-go-name":"ActualErrorCode"},"attemptNo":{"description":"Job retry attempt number.","type":"integer","format":"int64","x-go-name":"AttemptNo"},"createdTS":{"description":"Timestamp in seconds when job is created.","type":"integer","format":"int64","x-go-name":"CreatedTS"},"endedTS":{"description":"Timestamp in seconds when job is ended.","type":"integer","format":"int64","x-go-name":"EndedTS"},"entityID":{"description":"The ID of the backup set.","type":"integer","format":"int64","x-go-name":"EntityID"},"entityName":{"description":"The name of the backup set.","type":"string","x-go-name":"EntityName"},"entityType":{"description":"The type of the backup set.","type":"string","x-go-name":"EntityType"},"errorCategory":{"description":"Category of error for failed jobs.","type":"string","x-go-name":"ErrorCategory"},"errorCode":{"description":"Error code for failed jobs.","type":"integer","format":"int64","x-go-name":"ErrorCode"},"errorDetails":{"$ref":"#/components/schemas/JSONMap"},"errorMsg":{"description":"Error message for failed jobs.","type":"string","x-go-name":"ErrorMsg"},"extendedParams":{"description":"Additional parameters required for job execution.","type":"object","additionalProperties":{"type":"object"},"x-go-name":"ExtendedParams"},"globalCustomerID":{"description":"Unique global customer ID.","type":"string","x-go-name":"GlobalCustomerID"},"jobConfig":{"$ref":"#/components/schemas/JSONMap"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int64","x-go-name":"JobID"},"jobType":{"description":"Type of the job.","type":"string","x-go-name":"JobType"},"percent":{"description":"Percentage of job completed.","type":"integer","format":"int64","x-go-name":"Percent"},"primaryAuthEntityID":{"description":"Primary authorization entity ID. Value is ID of your organization.","type":"string","x-go-name":"PrimaryAuthEntityID"},"primaryAuthEntityType":{"description":"Type of primary authorization entity ID. The value is 'org'.","type":"string","x-go-name":"PrimaryAuthEntityType"},"productCustomerID":{"description":"Customer ID specific to the product.","type":"integer","format":"int64","x-go-name":"ProductCustomerID"},"productID":{"description":"Phoenix product ID. The value is 12289.","type":"integer","format":"int32","x-go-name":"ProductID"},"requestParams":{"$ref":"#/components/schemas/JSONMap"},"resourceID":{"description":"The share ID of the backup set.","type":"integer","format":"int64","x-go-name":"ResourceID"},"resourceName":{"description":"The share name of the backup set.","type":"string","x-go-name":"ResourceName"},"resourceType":{"description":"Type of the resource. The value is 'NASShare'.","type":"string","x-go-name":"ResourceType"},"retryCount":{"description":"Numbers of retries attempted.","type":"integer","format":"int64","x-go-name":"RetryCount"},"retryEnabled":{"description":"Indicates if retry is enabled or not. The value is 'true' if retry is enabled.","type":"boolean","x-go-name":"RetryEnabled"},"retryWaitinterval":{"description":"Retry interval in minutes before next retry attempt.","type":"integer","format":"int64","x-go-name":"RetryWaitinterval"},"scheduleEventID":{"description":"Schedule event ID for scheduled jobs.","type":"string","x-go-name":"ScheduleEventID"},"scheduleID":{"description":"Schedule ID for scheduled jobs.","type":"string","x-go-name":"ScheduleID"},"secondaryAuthEntityID":{"description":"Secondary authorization entity ID. The value is ID of your group.","type":"string","x-go-name":"SecondaryAuthEntityID"},"secondaryAuthEntityType":{"description":"Type of secondary authorization entity ID. The value is 'group'.","type":"string","x-go-name":"SecondaryAuthEntityType"},"startedTS":{"description":"Job start timestamp in seconds.","type":"integer","format":"int64","x-go-name":"StartedTS"},"state":{"description":"Current state of the job.","type":"string","x-go-name":"State"},"stateID":{"description":"ID of the current state of the job.","type":"integer","format":"int32","x-go-name":"StateID"},"stateLabel":{"description":"Label of current state of the job.","type":"string","x-go-name":"StateLabel"},"targetID":{"description":"Pool ID of the backup set.","type":"integer","format":"int64","x-go-name":"TargetID"},"targetName":{"description":"Pool name of the backup set.","type":"string","x-go-name":"TargetName"},"targetType":{"description":"Type of the target. The value is 'NASPool'.","type":"string","x-go-name":"TargetType"},"updatedTS":{"description":"Last updated timestamp in seconds.","type":"integer","format":"int64","x-go-name":"UpdatedTS"},"windowEndTS":{"description":"Duration in seconds for which the backup job runs.","type":"integer","format":"int64","x-go-name":"WindowEndTS"},"workloadName":{"description":"Name of the workload. The value is 'nas'.","type":"string","x-go-name":"WorkloadName"}},"x-go-package":"git.druva.org/foundation/jobmgmt/job/spec"},"JobParams":{"description":"Specify job parameters needed for restoring snapshot.","type":"object","properties":{"destinationFqdn":{"description":"Specify the destination FQDN where the data will be restored.","type":"string","x-go-name":"DestinationFQDN"},"destinationPath":{"description":"Specify the destination path where the data will be restored.","type":"string","x-go-name":"DestinationPath"},"destinationShare":{"description":"Specify the destination share where the data will be restored.","type":"string","x-go-name":"DestinationShare"},"destinationShareID":{"description":"Specify destination share ID for which the data will be restored.","type":"integer","format":"int64","x-go-name":"DestinationShareID"},"deviceID":{"description":"Specify destination NAS device ID where the data will be restored.","type":"integer","format":"int64","x-go-name":"DeviceID"},"fileHandlingOption":{"description":"Spceify file handling option. Enter '1' to Always overwrite, '2' to Always skip, '3' to Restore and move original to location, and '4' to Overwrite if original file is older.","type":"integer","format":"int64","x-go-name":"FileHandlingOption"},"originalLocationRestore":{"description":"Specify restore location. Set the value to 'true' for origial location restore, else set it to 'false' for alternate location restore.","type":"boolean","x-go-name":"OriginalLocationRestore"},"preserveOriginalDirectoryStructure":{"description":"Specify directory structure. Set the value to 'true' to preserve original directory structure in case of alternate restore, else set it to 'false'.","type":"boolean","x-go-name":"PreserveOriginalDirectoryStructure"},"snapshotState":{"description":"Specify state of the snapshot. For example, 'hot', 'warm' or 'cold'.","type":"string","x-go-name":"SnapshotState"}},"x-go-package":"git.druva.org/foundation/jobmgmt/haydn/spec/enterpriseworkload/restore/base"},"RWCConfig":{"description":"Specify parameters related to restore with confidence.","type":"object","properties":{"continueIrrespectiveOfSnapshotState":{"description":"Specify if the user wants to skip restore with confidence for 'hot' and 'cold' snapshot state. Set the value to 'true' to skip restore with confidence for 'hot' and 'cold' snapshot state. The default value is false.","type":"boolean","x-go-name":"ContinueIrrespectiveOfSnapshotState"},"doRWC":{"description":"Specify whether the user wants to perform restore with confidence. Set the value to 'true' to perform restore with confidence, else set it to 'false'.","type":"boolean","x-go-name":"DoRWC"}},"x-go-package":"git.druva.org/foundation/jobmgmt/haydn/spec/enterpriseworkload/restore/base"}}}}