Getting StartedAPI ReferenceRecipesGitHub
API Reference

Create a Protection Job.

post
https://cluster.ip.address/irisservices/api/v1/public/protectionJobs

Privileges: PROTECTION_MODIFY

Returns the created Protection Job.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to create a Protection Job.

Specifies information about a Protection Job.

boolean | null

If true, the Cohesity Cluster aborts any currently executing Job Runs
of this Protection Job when a QuietTime period specified for this Job
starts, even if the Job Run started before the QuietTime
period began.
If false, a Job Run continues to execute, if the Job Run started before
the QuietTime period starts.

alertingConfig
object | null

Alerting configuration can be used to specify optional details for the
alerts triggered by this job.

alertingPolicy
array of strings | null

Array of Job Events.

During Job Runs, the following Job Events are generated:

  1. Job succeeds 2) Job fails
  2. Job violates the SLA
    These Job Events can cause Alerts to be generated.
    'kSuccess' means the Protection Job succeeded.
    'kFailure' means the Protection Job failed.
    'kSlaViolation' means the Protection Job took longer than the time period
    specified in the SLA.
alertingPolicy
Allowed:
boolean | null

If this fiels is set to true, then we wil allow parallel runs for the job
for the adapters which support parallel runs.

cloudParameters
object | null

Specifies Cloud specific parameters applicable in various scenarios.

boolean | null

Specifies the behaviour of the file based backup on encountering an error.
Can either continue with the backup or fail immediately.

boolean | null

Whether to continue backing up on quiesce failure.

boolean | null

Specifies whether to create a remote view name to use for view overwrite.
This field is deprecated. Remote view names will automatically be used
for all view jobs with replication policy. Use RemoteViewConfigList to
setup remote view names.
deprecated: true

dataMigrationPolicy
object | null

Specifies policy for a data migration job. It contains inline schedule to
run the data migration job. In addition to this, it also contains
retention policy that should be applied to files after they have been
moved to cohesity cluster. It is present only in case data migration job.

dedupDisabledSourceIds
array of int64s | null

List of source ids for which source side dedup is disabled from the backup
job.

dedupDisabledSourceIds
string | null

Specifies a text description about the Protection Job.

int64 | null

Specifies the epoch time (in microseconds) after which the Protection Job
becomes dormant.

string | null
enum

Specifies the environment type (such as kVMware or kSQL)
of the Protection Source this Job is protecting.
Supported environment types such as 'kView', 'kSQL', 'kVMware', etc.
NOTE: 'kPuppeteer' refers to Cohesity's Remote Adapter.
'kVMware' indicates the VMware Protection Source environment.
'kHyperV' indicates the HyperV Protection Source environment.
'kSQL' indicates the SQL Protection Source environment.
'kView' indicates the View Protection Source environment.
'kPuppeteer' indicates the Cohesity's Remote Adapter.
'kPhysical' indicates the physical Protection Source environment.
'kPure' indicates the Pure Storage Protection Source environment.
'kNimble' indicates the Nimble Storage Protection Source environment.
'kHpe3Par' indicates the Hpe 3Par Storage Protection Source environment.
'kAzure' indicates the Microsoft's Azure Protection Source environment.
'kNetapp' indicates the Netapp Protection Source environment.
'kAgent' indicates the Agent Protection Source environment.
'kGenericNas' indicates the Generic Network Attached Storage Protection
Source environment.
'kAcropolis' indicates the Acropolis Protection Source environment.
'kPhysicalFiles' indicates the Physical Files Protection Source environment.
'kIbmFlashSystem' indicates the IBM Flash System Protection Source environment.
'kIsilon' indicates the Dell EMC's Isilon Protection Source environment.
'kGPFS' indicates IBM's GPFS Protection Source environment.
'kKVM' indicates the KVM Protection Source environment.
'kAWS' indicates the AWS Protection Source environment.
'kExchange' indicates the Exchange Protection Source environment.
'kHyperVVSS' indicates the HyperV VSS Protection Source
environment.
'kOracle' indicates the Oracle Protection Source environment.
'kGCP' indicates the Google Cloud Platform Protection Source environment.
'kFlashBlade' indicates the Flash Blade Protection Source environment.
'kAWSNative' indicates the AWS Native Protection Source environment.
'kO365' indicates the Office 365 Protection Source environment.
'kO365Outlook' indicates Office 365 outlook Protection Source environment.
'kHyperFlex' indicates the Hyper Flex Protection Source environment.
'kGCPNative' indicates the GCP Native Protection Source environment.
'kAzureNative' indicates the Azure Native Protection Source environment.
'kKubernetes' indicates a Kubernetes Protection Source environment.
'kElastifile' indicates Elastifile Protection Source environment.
'kAD' indicates Active Directory Protection Source environment.
'kRDSSnapshotManager' indicates AWS RDS Protection Source environment.
'kCassandra' indicates Cassandra Protection Source environment.
'kMongoDB' indicates MongoDB Protection Source environment.
'kCouchbase' indicates Couchbase Protection Source environment.
'kHdfs' indicates Hdfs Protection Source environment.
'kHive' indicates Hive Protection Source environment.
'kHBase' indicates HBase Protection Source environment.
'kUDA' indicates Universal Data Adapter Protection Source environment.
'kSAPHANA' indicates SAP HANA protection source environment.
'kDB2' indicates DB2 Protection Source environment.
'kO365Teams' indicates the Office365 Teams Protection Source environment.
'kO365Group' indicates the Office365 Groups Protection Source environment.
'kO365Exchange' indicates the Office365 Mailbox Protection Source environment.
'kO365OneDrive' indicates the Office365 OneDrive Protection Source environment.
'kO365Sharepoint' indicates the Office365 SharePoint Protection Source environment.
'kO365PublicFolders' indicates the Office365 PublicFolders Protection Source environment.
'kPostgres' indicates the Postgres Protection Source environment.
kHpe3Par, kIbmFlashSystem, kAzure, kNetapp, kAgent, kGenericNas, kAcropolis,
kPhysicalFiles, kIsilon, kGPFS, kKVM, kAWS, kExchange, kHyperVVSS, kOracle,
kGCP, kFlashBlade, kAWSNative, kO365, kO365Outlook, kHyperFlex, kGCPNative,
kAzureNative, kKubernetes, kElastifile, kAD, kRDSSnapshotManager,
kCassandra, kMongoDB, kCouchbase, kHdfs, kHive, kHBase, kUDA, kSAPHANA,
kO365Teams, kO365Group, kO365Exchange, kO365OneDrive, kO365Sharepoint,
kO365PublicFolders, kMongoDBPhysical, kPostgres

environmentParameters
object | null

Specifies additional settings that are applicable to all Sources in
the Protection Job that are of specified environment type. For example,
you can specify to exclude a disk from backup for all 'kVMware'
Protection Sources in the Protection Job. If a setting conflicts with
sourceSpecialParameters, then sourceSpecialParameters will be used.

excludeLabelIds
array of arrays of int64s | null

Array of arrays of label IDs that specify labels to
exclude. Optionally specify a list of labels to exclude from
protecting by listing protection source ids of labels in this two
dimensional array. Using this two dimensional array of label IDs, the
Cluster generates a list of namespaces to exclude from protecting,
which are derived from intersections of the inner arrays
and union of the outer array.

excludeLabelIds
excludeSourceIds
array of int64s | null

Array of Excluded Source Objects.

List of Object ids from a Protection Source that should not be
protected and are excluded from being backed up by the Protection Job.
Leaf and non-leaf Objects may be in this list and an Object in this list
must have an ancestor in the sourceId list.

excludeSourceIds
excludeVmTagIds
array of arrays of int64s | null

Array of Arrays of VM Tag Ids that Specify VMs to Exclude.

Optionally specify a list of VMs to exclude from protecting by listing
Protection Source ids of VM Tags in this two dimensional array.
Using this two dimensional array of Tag ids, the Cluster
generates a list of VMs to exclude from protecting,
which are derived from intersections of the inner arrays
and union of the outer array, as shown by the following example.
For example a Datacenter is selected to be protected but you want to
exclude all the 'Former Employees' VMs in the East and West but
keep all the VMs for 'Former Employees' in the South which are
also stored in this Datacenter, by specifying the
following tag id array:
[ [1000, 2221], [1000, 3031] ],
where 1000 is the 'Former Employee' VM Tag id,
2221 is the 'East' VM Tag id and 3031 is the 'West' VM Tag id.
The first inner array [1000, 2221] produces a list of VMs that are
both tagged with 'Former Employees' and 'East' (an intersection).
The second inner array [1000, 3031] produces a list of VMs that are both
tagged with 'Former Employees' and 'West' (an intersection).
The outer array combines the list of VMs from the two inner
arrays. The list of resulting VMs are excluded from being protected
this Job.

excludeVmTagIds
int64 | null

If specified, this setting is number of minutes that a Job Run
of a Full (no CBT) backup schedule is expected to complete, which is
known as a Service-Level Agreement (SLA).
A SLA violation is reported when the run time of a Job Run exceeds
the SLA time period specified for this backup schedule.

fullProtectionStartTime
object | null

Specifies the time of day to start the Full Protection Schedule.
This is optional and only applicable if the Protection Policy defines
a monthly or a daily Full (no CBT) Protection Schedule.
Default value is 02:00 AM.
deprecated: true

ignorableErrorsInErrorDb
array of int32s | null

Specifies the errors which we can ignore from showing to the user.

ignorableErrorsInErrorDb
int64 | null

If specified, this setting is number of minutes that a Job Run
of a CBT-based backup schedule is expected to complete, which
is known as a Service-Level Agreement (SLA).
A SLA violation is reported when the run time of a Job Run exceeds
the SLA time period specified for this backup schedule.

incrementalProtectionStartTime
object | null

Specifies the time of day to start the CBT-based Protection Schedule.
This is optional and only applicable if the Protection Policy defines
a monthly or a daily CBT-based Protection Schedule.
Default value is 02:00 AM.
deprecated: true

indexingPolicy
object | null

Specifies the settings for indexing files found in an Object
(such as a VM) so these files can be searched and recovered.
In addition, it specifies inclusion and exclusion rules that determine
the directories to index.

boolean | null

Specifies if this is a direct archive backup job.

boolean | null

Specifies if native format should be used for archiving, applicable for
only direct archive jobs.

boolean | null

Specifies if the Protection Job is paused, which means that no new
Job Runs are started but any existing Job Runs continue to execute.

labelIds
array of arrays of int64s | null

Array of array of label IDs that specify labels to protect.
Optionally specify a list of labels to protect by listing
protection source ids of labels in this two dimensional array.
Using this two dimensional array of label IDs, the cluster
generates a list of namespaces to protect, which are derived from
intersections of the inner arrays and union of the outer array.

labelIds
boolean | null

Specifies whether to leverage nutanix API to take snapshots for this
backup job. To leverage nutanix snapshot a prism endpoint on which the
vcenter is registered as a management server has to be registered as a
source. If nutanix snapshot can not be taken, job will fall back to
default mode.

boolean | null

If this field is set to true, then the backup for the objects will be
performed using dedicated storage area network (SAN) instead of LAN or
managment network.

boolean | null

Specifies whether to leverage the storage array based snapshots for this
backup job. To leverage storage snapshots, the storage array has to be
registered as a source. If storage based snapshots can not be taken, job
will fallback to the default backup method.

boolean | null

Specifies whether to leverage Hyperflex as the storage snapshot array

int64 | null

If specified, this setting is number of minutes that a Job Run
of a Log backup schedule is expected to complete, which is
known as a Service-Level Agreement (SLA).
A SLA violation is reported when the run time of a Job Run exceeds
the SLA time period specified for this backup schedule.

int64 | null

Specifies the last time this Job was updated. If this is
passed into a PUT request, then the backend will validate that the
timestamp passed in matches the time that the protection group was
actually last modified. If the two timestamps do not match, then the
request will be rejected with a stale error.

string | null
required

Specifies the name of the Protection Job.

int64 | null

Specifies the id of the registered Protection Source that is the
parent of the Objects that may be protected by this Job.
For example when a vCenter Server is registered on a Cohesity Cluster,
the Cohesity Cluster assigns a unique id to this field that represents
the vCenter Server.

boolean | null

Specifies whether brick based dedupe should be performed or not.

boolean | null

Specifies whether source side dedupe should be performed or not.

string | null
required

Specifies the unique id of the Protection Policy associated with
the Protection Job. The Policy provides retry settings,
Protection Schedules, Priority, SLA, etc.
The Job defines the Storage Domain (View Box), the Objects to Protect
(if applicable), Start Time, Indexing settings, etc.

postBackupScript
object | null

Specifies the script associated with the backup job. This field must be
specified for 'kPhysical' jobs. This script will be executed post backup
run.

preBackupScript
object | null

Specifies the script associated with the backup job. This field must be
specified for 'kPhysical' jobs. This script will be executed pre backup
run. The 'remoteScript' field will be used for remote adapter jobs and
'preBackupScript' field will be used for 'kPhysical' jobs.

string | null
enum

Specifies the priority of execution for a Protection Job.
Cohesity supports concurrent backups but if the number of Jobs exceeds
the ability to process Jobs, the specified priority determines the
execution Job priority.
This field also specifies the replication priority.
'kLow' indicates lowest execution priority for a Protection job.
'kMedium' indicates medium execution priority for a Protection job.
'kHigh' indicates highest execution priority for a Protection job.

Allowed:
string | null
enum

Specifies the QoS policy type to use for this Protection Job.
'kBackupHDD' indicates the Cohesity Cluster writes data directly to
the HDD tier for this Protection Job. This is the recommended setting.
'kBackupSSD' indicates the Cohesity Cluster writes data directly to
the SSD tier for this Protection Job. Only specify this policy if
you need fast ingest speed for a small number of Protection Jobs.
'kTestAndDevHigh' indicated the test and dev workload.
'kBackupAll' indicates the Cohesity Cluster writes data directly to
the HDD tier and the SSD tier for this Protection Job.

Allowed:
boolean | null

Indicates if the App-Consistent option is enabled for this Job.
If the option is enabled, the Cohesity Cluster quiesces
the file system and applications before taking
Application-Consistent Snapshots. VMware Tools must be installed
on the guest Operating System.

remoteScript
object | null

For a Remote Adapter 'kPuppeteer' Job, this field specifies the
settings about the remote script that will be executed by this Job.
Only specify this field for Remote Adapter 'kPuppeteer' Jobs.

remoteViewConfigList
array of objects | null

Sepcifies the remote view names for the views that are being protected in
the view job. Use this field only when job has a replication policy.

remoteViewConfigList
string | null

Specifies the remote view name to use for view overwrite.
This field is deprecated. Remote view names will automatically be used
for all view jobs with replication policy. Use RemoteViewConfigList to
setup remote view names.
deprecated: true

sourceIds
array of int64s | null

Array of Protected Source Objects.

Specifies the list of Object ids from the Protection Source to
protect (or back up) by the Protection Job.
An Object in this list may be descendant of another Object in this list.
For example a Datacenter could be selected but its child Host excluded.
However, a child VM under the Host could be explicitly
selected to be protected. Both the Datacenter and the VM are listed.

sourceIds
sourceSpecialParameters
array of objects | null
required

Array of Special Source Parameters.

Specifies additional settings that can apply to a subset of the
Sources listed in the Protection Job. For example, you can specify a list
of files and folders to protect instead of protecting the entire Physical
Server. If this field's setting conflicts with environmentParameters,
then this setting will be used. Specific volume selections must be passed
in here to take effect.

sourceSpecialParameters*
sources
array of objects | null

Array of Protected Source Objects.

Specifies the list of Object ids along with Object names from the
Protection Source to protect (or back up) by the Protection Job.
Contains the one-to-one mapping of Source ids defined in "SourceIds" to
the corresponding Source names. Only one of Sources or SourceIds will be
returned depending on IncludeSourceNames. Sources will only be returned
when IncludeSourceNames is set to true and the environment is O365.

sources
startTime
object | null

Specifies the time of day to start the Protection Schedule.
This is optional and only applicable if the Protection Policy defines
a monthly or a daily Protection Schedule.
Default value is 02:00 AM.

taskTimeouts
array of objects | null

Specifies task level timeouts for a job.

taskTimeouts
string | null

Specifies the timezone to use when calculating time for this
Protection Job such as the Job start time.
Specify the timezone in the following format: "Area/Location",
for example: "America/New_York".

userSpecifiedTags
array of strings | null

Tags associated with the job. User can specify tags/keywords that can
indexed by Yoda and can be later searched in UI. For example, user can
create a 'kPuppeteer' job to backup Oracle DB for 'payroll' department.
User can specify following tags: 'payroll', 'Oracle_DB'.

userSpecifiedTags
int64 | null
required

Specifies the Storage Domain (View Box) id where this Job writes data.

string | null

For a Remote Adapter 'kPuppeteer' Job or a 'kView' Job, this field
specifies a View name that should be protected. Specify this field when
creating a Protection Job for the first time for a View. If this field
is specified, ParentSourceId, SourceIds, and ExcludeSourceIds should not
be specified.
This field is deprecated for view backups. Use sourceIds to specify list
of view ids instead.

vmTagIds
array of arrays of int64s | null

Array of Arrays of VMs Tags Ids that Specify VMs to Protect.

Optionally specify a list of VMs to protect by listing
Protection Source ids of VM Tags in this two dimensional array.
Using this two dimensional array of Tag ids, the Cluster
generates a list of VMs to protect which are derived from
intersections of the inner arrays and union of the outer array,
as shown by the following example.
To protect only 'Eng' VMs in the East and all the VMs in the West,
specify the following tag id array:
[ [1101, 2221], [3031] ],
where 1101 is the 'Eng' VM Tag id, 2221 is the 'East' VM Tag id and
3031 is the 'West' VM Tag id. The inner array [1101, 2221] produces a
list of VMs that are both tagged with 'Eng' and 'East'
(an intersection). The outer array combines the list from the inner
array with list of VMs tagged with 'West' (a union). The list
of resulting VMs are protected by this Job.

vmTagIds
Responses

Updated about 5 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago

Did this page help you?