Skip to main content

Create a new relationship

Contributors

POST /api/relationships-v2

Creates a new relationship.

Parameters

Name Type In Required Description

x-account-id

string

header

True

NetApp tenancy account ID

x-netapp-external-request-id-src

string

header

False

Source request id header

x-netapp-external-request-id-trg

string

header

False

Target request id header

x-source-edge

string

header

False

Edge cluster uuid

x-target-edge

string

header

False

Edge cluster uuid

x-sync-source

string

header

False

Is source Edge

x-sync-target

string

header

False

is target Edge

Request Body

Name Type Required Description

dataBrokerId

string

False

Data Broker Id - this is deprecated - please use groupId instead

groupId

string

False

Data broker group id

source

source

True

sourceCredentials

sourceCredentials

False

target

target

True

targetCredentials

targetCredentials

False

encryption

encryption

False

group

group

False

settings

settings

False

activity

activity

False

createdAt

number

False

Relationship Creation time

customHeaders

customHeaders

False

Custom headers for the relationship

extraInformation

extraInformation

False

tags

array[tags]

False
Example request 
{
  "source": {
    "protocol": "nfs"
  },
  "target": {
    "protocol": "nfs"
  },
  "settings": {
    "files": {
      "excludeExtensions": {
      },
      "excludeByRegex": {
      }
    },
    "directories": {
      "excludeNames": {
      }
    }
  },
  "activity": {
    "status": "RUNNING",
    "topFiveMostCommonRelationshipErrors": {
    },
    "errors": {
    }
  },
  "tags": {
  }
}

Response

Status: 202, Default Response
Name Type Required Description

id

string

True

Relationship ID

isCM

string

False

Was the relationship created via CloudManager

dataBroker

string

False

Data Broker ID

relationshipId

string

False

Relationship ID

source

source

True

target

target

True

encryption

encryption

False

group

string

False

Group ID

settings

settings

False

activity

activity

False

createdAt

number

True

Relationship Creation time

customHeaders

customHeaders

False

Custom headers for the relationship

extraInformation

extraInformation

False

tags

array[tags]

False

Definitions

See Definitions

credentials

CIFS credentials

Name Type Required Description

username

string

True

User name

password

string

True

password

domain

string

False

Domain

cifs

CIFS Details

Name Type Required Description

host

string

True

CIFS host

share

string

True

CIFS share

provider

string

True

CIFS type

path

string

False

CIFS path

version

string

False

Supported CIFS versions

workingEnvironmentId

string

False

Relevant working environment ID

credentials

credentials

False

CIFS credentials

nfs

NFS Details

Name Type Required Description

host

string

True

NFS host

export

string

True

NFS export

provider

string

True

NFS type

path

string

False

NFS path

version

string

False

Supported NFS versions

workingEnvironmentId

string

False

Relevant working environment ID

accessPoint

string

False

EFS access point

encryption

S3 encryption

Name Type Required Description

protocol

string

False

Encryption type

keyId

string

False

Encryption key arn in case it is kms encryption

tags

Name Type Required Description

key

string

False

Tag Key

value

string

False

Tag Value

glacier

Glacier storage class restore information (available only for s3 as source endpoint)

Name Type Required Description

days

number

True

Lifetime of the active copy in days

tier

string

True

Glacier retrieval tier at which the restore will be processed

deepArchive

Deep Archive storage class restore information (available only for s3 as source endpoint)

Name Type Required Description

days

number

True

Lifetime of the active copy in days

tier

string

True

Deep Archive retrieval tier at which the restore will be processed

credentials

S3 provider credentials

Name Type Required Description

accessKey

string

True

Access Key

secretKey

string

True

Secret Key

s3

S3 details

Name Type Required Description

host

string

False

SGWS or IBM or ONTAP host

port

integer

False

SGWS or IBM or ONTAP port

bucket

string

True

Bucket

prefix

string

False

Prefix

region

string

False

Bucket region

encryption

encryption

False

S3 encryption

privateLinkDns

string

False

AWS S3 Private Link DNS

tags

array[tags]

False

storageClass

string

False

S3 Storage Class

provider

string

True

Object Storage Type

workingEnvironmentId

string

False

Relevant working environment ID - for storageGrid working environment

glacier

glacier

False

Glacier storage class restore information (available only for s3 as source endpoint)

deepArchive

deepArchive

False

Deep Archive storage class restore information (available only for s3 as source endpoint)

credentials

credentials

False

S3 provider credentials

local

Local object details

Name Type Required Description

path

string

True

Local Path

credentials

Azure Blob Storage Credentials

Name Type Required Description

storageAccountConnectionString

string

False

Azure Blob Storage account Connection string ( for blob to blob copy should be SaS-Connection-String)

azure

Azure Blob Storage Details

Name Type Required Description

container

string

True

Azure Blob Storage container name

storageAccountName

string

False

Azure Blob Storage account name

prefix

string

False

Container blob prefix

path

string

False

Container path, used in azure data lake storage

tags

array[tags]

False

blobTier

string

False

Blob tier type

provider

string

True

Azure type

credentials

credentials

False

Azure Blob Storage Credentials

gcp

Name Type Required Description

bucket

string

True

GCP Bucket

prefix

string

False

GCP Bucket prefix

tags

array[tags]

False

storageClass

string

False

GCP Storage Class

kmsKeyName

string

False

GCP Kms name

provider

string

True

GCP Type

credentials

Name Type Required Description

username

string

False

UserName

password

string

False

Password

sftp

Name Type Required Description

host

string

True

SFTP host

port

integer

True

SFTP port number

path

string

False

Directory path

rootDirectory

string

True

Root Directory path

provider

string

True

SFTP Type

credentials

credentials

True

credentials

Name Type Required Description

clientSecret

string

True

Client secret

publicKeyId

string

True

Public Key Id

privateKey

string

True

Private Key

passphrase

string

True

Passphrase

box

Name Type Required Description

rootDirectory

string

False

Root Directory

path

string

False

path

folderId

string

True

Folder Id

clientId

string

True

Client Id

appName

string

False

Box Application Name

enterpriseId

string

True

Enterprise Id

provider

string

True

Box Type

credentials

credentials

True

credentials

Name Type Required Description

clientEmail

string

True

Service Account email

privateKey

string

True

Private Key

gdrive

Name Type Required Description

driveId

string

True

Drive Id

driveName

string

False

Drive Name

folderId

string

False

Google Drive folderId - Relevant in case of Download

path

string

False

Folder path - full path ( not including driveId )

provider

string

True

Google Drive Type

subject

string

True

subject - user email

credentials

credentials

True

tags

array[tags]

False

source

Name Type Required Description

protocol

string

False

Endpoint protocol

cifs

cifs

False

CIFS Details

nfs

nfs

False

NFS Details

s3

s3

False

S3 details

local

local

False

Local object details

azure

azure

False

Azure Blob Storage Details

gcp

gcp

False

sftp

sftp

False

box

box

False

gdrive

gdrive

False

sftp

Name Type Required Description

username

string

False

UserName

password

string

False

Password

cifs

CIFS credentials

Name Type Required Description

username

string

True

User name

password

string

True

password

domain

string

False

Domain

s3

S3 provider credentials

Name Type Required Description

accessKey

string

True

Access Key

secretKey

string

True

Secret Key

azure

Azure Blob Storage Credentials

Name Type Required Description

storageAccountConnectionString

string

False

Azure Blob Storage account Connection string ( for blob to blob copy should be SaS-Connection-String)

box

Name Type Required Description

clientSecret

string

True

Client secret

publicKeyId

string

True

Public Key Id

privateKey

string

True

Private Key

passphrase

string

True

Passphrase

gdrive

Name Type Required Description

clientEmail

string

True

Service Account email

privateKey

string

True

Private Key

sourceCredentials

Name Type Required Description

sftp

sftp

False

cifs

cifs

False

CIFS credentials

s3

s3

False

S3 provider credentials

azure

azure

False

Azure Blob Storage Credentials

box

box

False

gdrive

gdrive

False

target

Name Type Required Description

protocol

string

False

Endpoint protocol

cifs

cifs

False

CIFS Details

nfs

nfs

False

NFS Details

s3

s3

False

S3 details

local

local

False

Local object details

azure

azure

False

Azure Blob Storage Details

gcp

gcp

False

sftp

sftp

False

box

box

False

gdrive

gdrive

False

box

Name Type Required Description

clientSecret

string

True

Client secret

publicKeyId

string

True

Public Key ID

privateKey

string

True

Private Key

passphrase

string

True

Passphrase

targetCredentials

Name Type Required Description

sftp

sftp

False

cifs

cifs

False

CIFS credentials

s3

s3

False

S3 provider credentials

azure

azure

False

Azure Blob Storage Credentials

box

box

False

gdrive

gdrive

False

initiator

Initiator details

Name Type Required Description

dataBrokerId

string

False

Data Broker Id

groupId

string

False

Group Id

encryptionType

string

False

Data Broker network location - if initiator is src, listener must be trg

listener

Listener details

Name Type Required Description

dataBrokerId

string

False

Data Broker Id

groupId

string

False

Group Id

encryptionType

string

False

Data Broker network location - if initiator is src, listener must be trg

encryption

Name Type Required Description

initiator

initiator

False

Initiator details

listener

listener

False

Listener details

scanner

Name Type Required Description

processes

number

False

Scanner processes number

processesLimit

number

False

Scanner processes limit number

concurrency

number

False

How many tasks in parallel each scanner process handles

transferrer

Name Type Required Description

processes

number

False

Transferrer processes number

processesLimit

number

False

Scanner processes limit number

concurrency

number

False

How many tasks in parallel each transferrer process handles

placement

Data Broker placement information

Name Type Required Description

instanceId

string

False

Data Broker instance id

hostname

string

False

Data Broker host name

privateIp

string

False

Data Broker private IP address

region

string

False

Data Broker AWS Region

availabilityZone

string

False

Data Broker AWS Subnet Availability Zone

vpcId

string

False

Data Broker AWS VPC ID

vpcCidrBlock

string

False

Data Broker AWS VPC CIDR block

subnetId

string

False

Data Broker AWS Subnet ID

subnetCidrBlock

string

False

Data Broker AWS Subnet CIDR block

version

string

False

Data Broker version

awsAccountId

string

False

AWS accountId in which the dataBroker was created

vault

string

False

Vault version

node

string

False

Node version

canUpdateNodeVersion

boolean

False

Indicates if advanced node version is compatible with this distribution

cpu

string

False

Data Broker number of cpus

processMaxMem

string

False

Data Broker Max Memory for process

osTotalMem

string

False

Data Broker Total memory

release

string

False

Data Broker image release

os

string

False

Data Broker OS

distribution

string

False

Data Broker distribution

resourceGroupName

string

False

Azure Data Broker resource group

zone

string

False

Azure Data Broker zone

serviceAccount

string

False

GCP Data Broker service account

gcpProjectId

string

False

GCP project id

scanner

scanner

False

transferrer

transferrer

False

platform

string

False

Data broker platform

cpus

number

False

Number of Cpus

proxy

string

False

Proxy string

canUpdateProxy

boolean

False

Allow to change proxy configuration

dataBrokers

Name Type Required Description

id

string

True

Data Broker Id

type

string

False

name

string

True

Data Broker Name

status

string

False

'COMPLETE' for online data broker or 'FAILED' otherwise. Only available after the data broker has contacted the service for the first time

message

string

False

The error message in case the data broker is in 'FAILED' status

fileLink

string

False

The link to the Data Broker Cloud Formation template or installer

transferRate

number

False

The Data broker current transfer rate

lastPing

integer

False

The last time the Data Broker services did contact this service (EPOCH TIME)

port

integer

False

In case this is a NetApp 'listener' Data Broker, this is the port that data broker listens on

latestVersion

string

False

Latest Data Broker version available

encryptionType

string

False

Data Broker Encryption type - in case it is part of nfs encrypted relationship

groupId

string

False

Data Broker Group Id

placement

placement

False

Data Broker placement information

group

Name Type Required Description

id

string

True

Group Id

name

string

True

Group Name

dataBrokers

array[dataBrokers]

True

Data Brokers attached to the group

createdAt

string

True

Group creation time

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

settings

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.

topFiveMostCommonRelationshipErrors

Name Type Required Description

step

string

False

Sync step that failed - TRANSFER or SCAN

errorCode

string

False

Error code

counter

number

False

Number of errors

description

string

False

Error description

errors

Name Type Required Description

dataBrokerId

string

False

Data Broker with initialized error

reason

string

False

Error

activity

Name Type Required Description

syncType

string

False

field for UI - to indicate if we copy only acl or copy also data

status

string

False

Relationship status

type

string

False

Relationship phase - Initial copy or sync

bytesMarkedForCopy

number

False

Bytes marked for copy

filesMarkedForCopy

number

False

Files marked for copy

dirsMarkedForCopy

number

False

Directories marked for copy

filesCopied

number

False

Files copied

bytesCopied

number

False

Bytes copied

dirsCopied

number

False

Directories copied

filesFailed

number

False

files failed to copy

bytesFailed

number

False

Bytes failed to copy

dirsFailed

number

False

Directories failed to copy

filesMarkedForRemove

number

False

Files marked for remove

bytesMarkedForRemove

number

False

Byes marked for remove

dirsMarkedForRemove

number

False

Directories marked for remove

filesRemoved

number

False

Files removed

bytesRemoved

number

False

Bytes removed

dirsRemoved

number

False

Directories removed

bytesRemovedFailed

number

False

Bytes failed to remove

filesRemovedFailed

number

False

Filed failed to remove

filesMarkedForIgnore

number

False

Files marked for ignore

dirsScanned

number

False

Directories scanned

filesScanned

number

False

Files scanned

bytesScanned

number

False

Bytes scanned

dirsFailedToScan

number

False

Directories failed to scan

timeEstimation

number

False

Time estimation until the end of the sync

progress

number

False

Relationship progress

endTime

string

False

End time

startTime

string

False

Start time

executionTime

number

False

Execution time

failureMessage

string

False

Failure message

lastMessageTime

string

False

Last message time

topFiveMostCommonRelationshipErrors

array[topFiveMostCommonRelationshipErrors]

False

errors

array[errors]

False

customHeaders

Custom headers for the relationship

Name Type Required Description

x-netapp-external-request-id-src

string

False

Source request id header

x-netapp-external-request-id-trg

string

False

Target request id header

x-source-edge

string

False

Edge cluster uuid

x-target-edge

string

False

Edge cluster uuid

x-sync-source

string

False

Is source Edge

x-sync-target

string

False

is target Edge

extraInformation

Name Type Required Description

dataSenseQueryUid

string

False

Data sense query uid

connectorId

string

False

Connector Id ( for data sense query )

s3

S3 details

Name Type Required Description

host

string

False

SGWS or IBM or ONTAP host

port

integer

False

SGWS or IBM or ONTAP port

bucket

string

True

Bucket

prefix

string

False

Prefix

region

string

False

Bucket region

encryption

encryption

False

S3 encryption

privateLinkDns

string

False

AWS S3 Private Link DNS

tags

array[tags]

False

storageClass

string

False

S3 Storage Class

provider

string

True

Object Storage Type

workingEnvironmentId

string

False

Relevant working environment ID - for storageGrid working environment

glacier

glacier

False

Glacier storage class restore information (available only for s3 as source endpoint)

deepArchive

deepArchive

False

Deep Archive storage class restore information (available only for s3 as source endpoint)

azure

Azure Blob Storage Details

Name Type Required Description

container

string

True

Azure Blob Storage container name

storageAccountName

string

False

Azure Blob Storage account name

prefix

string

False

Container blob prefix

path

string

False

Container path, used in azure data lake storage

tags

array[tags]

False

blobTier

string

False

Blob tier type

provider

string

True

Azure type

gdrive

Name Type Required Description

driveId

string

True

Drive Id

driveName

string

False

Drive Name

folderId

string

False

Google Drive folderId

path

string

False

Folder path

provider

string

True

Google Drive Type

tags

array[tags]

False

subject

string

True

subject - user email

sftp

Name Type Required Description

host

string

True

SFTP host

port

integer

True

SFTP port number

path

string

False

Directory path

rootDirectory

string

True

Root Directory path

provider

string

True

SFTP Type

box

Name Type Required Description

rootDirectory

string

False

Root Directory

path

string

False

path

folderId

string

True

Folder Id

clientId

string

True

Client Id

appName

string

False

Box Application Name

enterpriseId

string

False

Enterprise Id

provider

string

True

Box Type

source

Name Type Required Description

protocol

string

False

Endpoint protocol

cifs

cifs

False

CIFS Details

nfs

nfs

False

NFS Details

s3

s3

False

S3 details

local

local

False

Local object details

azure

azure

False

Azure Blob Storage Details

gcp

gcp

False

gdrive

gdrive

False

sftp

sftp

False

box

box

False

target

Name Type Required Description

protocol

string

False

Endpoint protocol

cifs

cifs

False

CIFS Details

nfs

nfs

False

NFS Details

s3

s3

False

S3 details

local

local

False

Local object details

azure

azure

False

Azure Blob Storage Details

gcp

gcp

False

gdrive

gdrive

False

sftp

sftp

False

box

box

False

settings

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.