Skip to main content

Update the settings for a relationship

Contributors

PUT /api/relationships-v2/{id}

Updates the settings for a relationship.

Parameters

Name Type In Required Description

id

string

path

True

Relationship Id

x-account-id

string

header

True

NetApp tenancy account Id

Request Body

Name Type Required Description

gracePeriod

number

False

Grace period time ( seconds )

deleteOnSource

boolean

False

Enable delete on source

deleteOnTarget

boolean

False

Enable delete on target

objectTagging

boolean

False

Use S3 tagging to store object metadata

retries

integer

False

number of retries

copyAcl

boolean

False

Enable acl copy

copyData

boolean

False

Copy data only

continuousSync

boolean

False

Listen to object notifications

fileTypes

fileTypes

False

The file types that is included in the relationship

compareBy

compareBy

False

The file attributes that should be compared

copyProperties

copyProperties

False

The object properties that should be copied

files

files

False

Settings related to files.

directories

directories

False

Settings related to directories.

schedule

schedule

False

Sync schedule settings.

notifications

notifications

False

Notifications settings.

scheduleAbort

scheduleAbort

False

Schedule abort settings.
Example request 
{
  "files": {
    "excludeExtensions": [
      "string"
    ],
    "excludeByRegex": [
      "string"
    ],
    "minDate": "string",
    "minCreationDate": "string"
  },
  "directories": {
    "excludeNames": [
      "string"
    ]
  },
  "schedule": {
    "nextTime": "string"
  }
}

Response

Status: 200, Default Response
Name Type Required Description

gracePeriod

number

True

Grace period time ( seconds )

deleteOnSource

boolean

True

Enable delete on source

deleteOnTarget

boolean

True

Enable delete on target

objectTagging

boolean

True

Use S3 tagging to store object metadata

retries

integer

True

number of retries

copyAcl

boolean

False

Enable acl copy

copyData

boolean

True

Copy data only

continuousSync

boolean

False

Listen to object notifications

fileTypes

fileTypes

True

The file types that is included in the relationship

compareBy

compareBy

True

The file attributes that should be compared

copyProperties

copyProperties

False

The object properties that should be copied

files

files

True

Settings related to files.

directories

directories

True

Settings related to directories.

schedule

schedule

True

Sync schedule settings.

notifications

notifications

False

Notifications settings.

scheduleAbort

scheduleAbort

True

Schedule abort settings.

Definitions

See Definitions

fileTypes

The file types that is included in the relationship

Name Type Required Description

files

boolean

False

Include files

directories

boolean

False

Include directories

symlinks

boolean

False

Include symbolic links

hardlinks

boolean

False

include hard links

compareBy

The file attributes that should be compared

Name Type Required Description

uid

boolean

False

uid ( relevant when source or target is file system )

gid

boolean

False

gid ( relevant when source or target is file system )

mtime

boolean

False

mtime

mode

boolean

False

mode

copyProperties

The object properties that should be copied

Name Type Required Description

metadata

boolean

False

copy metadata ( cloud to cloud )

tags

boolean

False

copy tags ( cloud to cloud only S3 compatible )

files

Settings related to files.

Name Type Required Description

excludeExtensions

array[string]

False

Excluded extensions array (For example - [".log", ".tar.gz"])

excludeByRegex

array[string]

False

Excluded files by regex (For example - ".txt." will exclude the files file.doc.txt.gz)

minSize

integer

False

Minimum file size (in bytes). Only files of equal or larger size will be transferred by the relationship

maxSize

integer

False

Maximum file size (in bytes). Only files of equal or smaller size will be transferred by the relationship

minDate

string

False

Data broker will sync files that were last modified after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'

maxDate

["null", "string"]

False

Data broker will sync files that were last modified before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date

minCreationDate

string

False

Data broker will sync files that were created after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'

maxCreationDate

["null", "string"]

False

Data broker will sync files that were created before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date

directories

Settings related to directories.

Name Type Required Description

excludeNames

array[string]

False

Excluded directories names array (For example - ["dir1"])

schedule

Sync schedule settings.

Name Type Required Description

syncInDays

integer

False

Days interval for sync scheduler

syncInHours

integer

False

syncInMinutes

integer

False

isEnabled

boolean

False

Activate automatic scheduler

nextTime

string

False

The first time the relationship should run

syncWhenCreated

boolean

False

Start the sync upon creation

cm

Cloud Manager notifications

Name Type Required Description

done

boolean

False

Should send notification about DONE status

failed

boolean

False

Should send notification about FAILED status

aborted

boolean

False

Should send notification about ABORTED status

running_continuously

boolean

False

Should send notification about RUNNING_CONTINUOUSLY status

notifications

Notifications settings.

Name Type Required Description

cm

cm

False

Cloud Manager notifications

scheduleAbort

Schedule abort settings.

Name Type Required Description

abortInDays

integer

False

Days interval for abort scheduler

abortInHours

integer

False

Hours interval for abort scheduler

abortInMinutes

integer

False

Minutes interval for abort scheduler

isEnabled

boolean

False

Activate automatic scheduler abort