Node Config Controller Resource

The API allows you to list, view, edit and create node configurations.

GET /node-configs

Returns list of node configurations.

Request Parameters
name type description
backup-to-be-restored query
direction query
filter query
nameLike query
orderBy query
page query
size query
Response Body
media type data type description
application/json array of NodeConfigListRecord (JSON) list of node configurations

Example

Request
GET /node-configs
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "nodeCount" : 12345,
  "backupDestinationCount" : 12345,
  "nodes" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "backupDestinations" : [ {
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "type" : {
      "name" : "...",
      "description" : "..."
    },
    "guid" : "...",
    "name" : "..."
  } ],
  "isDefault" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "modificationTime" : 1451649601000
} ]
                
              

POST /node-configs

Create a node configuration.

Request Body
media type data type description
application/json NodeConfigRequest (JSON) specify data for new node configuration
Response Body
media type data type description
application/json NodeConfigDetails (JSON) details of newly created node configuration

Example

Request
POST /node-configs
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "isDefault" : true,
  "backupDestinations" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "generalSettings" : {
    "generalExportPath" : "...",
    "generalMountPath" : "...",
    "generalImportPath" : "...",
    "generalBackupTimeDiff" : 12345,
    "generalKeepLastBackupLocally" : true,
    "minFreeSpaceForExport" : 12345,
    "generalMinFreeSpaceForSnapshotBytes" : 12345,
    "generalMinFreeSpaceForSnapshotPercentage" : 12345,
    "generalDynamicallyAttachedDisksSlotOffset" : 12345
  },
  "threadsSettings" : {
    "taskMaxInventorySyncThreads" : 12345,
    "taskMaxTapeManagerInventorySyncThreads" : 12345,
    "taskMaxExportThreads" : 12345,
    "taskMaxExportThreadsPerSource" : 12345,
    "taskMaxImportThreads" : 12345,
    "taskMaxStoreThreads" : 12345,
    "taskMaxRestoreThreads" : 12345,
    "taskMaxSnapshotThreads" : 12345,
    "taskMaxSnapshotThreadsPerSource" : 12345,
    "taskInventorySyncTimeout" : 12345,
    "taskTapeManagerInventorySyncTimeout" : 12345,
    "taskExportTimeout" : 12345,
    "taskStoreTimeout" : 12345,
    "taskRestoreTimeout" : 12345,
    "taskUnmountTimeout" : 12345,
    "taskMountTimeout" : 12345,
    "taskImportTimeout" : 12345,
    "taskOldBackupsRemovalTimeout" : 12345,
    "taskOldSnapshotsRemovalTimeout" : 12345,
    "taskSnapshotTimeout" : 12345,
    "taskSnapshotReversionTimeout" : 12345,
    "taskQueuePollInterval" : 12345
  },
  "netcatSettings" : {
    "netcatMinPort" : 12345,
    "netcatMaxPort" : 12345,
    "netcatMaxAttempts" : 12345,
    "netcatBzip2" : true
  },
  "cloudAgentSettings" : {
    "cloudAgentWindowsHost" : "...",
    "cloudAgentWindowsUser" : "...",
    "cloudAgentWindowsPassword" : "...",
    "cloudAgentTaskProgressRefreshInterval" : 12345
  }
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "modificationTime" : 12345,
  "isDefault" : true,
  "backupDestinations" : [ {
    "guid" : "...",
    "name" : "...",
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "nodeConfigCount" : 12345,
    "nodeInitErrors" : {
      "property1" : "...",
      "property2" : "..."
    },
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "warnings" : [ "...", "..." ],
    "defaultBackupDestination" : true,
    "spaceThreshold" : 12345,
    "description" : "...",
    "backupDestinationForCloud" : true,
    "state" : "INITIALIZING",
    "configurationWarning" : "...",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "modificationTime" : 1451649601000
  }, {
    "guid" : "...",
    "name" : "...",
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "nodeConfigCount" : 12345,
    "nodeInitErrors" : {
      "property1" : "...",
      "property2" : "..."
    },
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "warnings" : [ "...", "..." ],
    "defaultBackupDestination" : true,
    "spaceThreshold" : 12345,
    "description" : "...",
    "backupDestinationForCloud" : true,
    "state" : "NOT_INITIALIZED",
    "configurationWarning" : "...",
    "type" : {
      "name" : "...",
      "description" : "..."
    },
    "modificationTime" : 12345
  } ],
  "generalSettings" : {
    "generalExportPath" : "...",
    "generalMountPath" : "...",
    "generalImportPath" : "...",
    "generalBackupTimeDiff" : 12345,
    "generalKeepLastBackupLocally" : true,
    "minFreeSpaceForExport" : 12345,
    "generalMinFreeSpaceForSnapshotBytes" : 12345,
    "generalMinFreeSpaceForSnapshotPercentage" : 12345,
    "generalDynamicallyAttachedDisksSlotOffset" : 12345
  },
  "threadsSettings" : {
    "taskMaxInventorySyncThreads" : 12345,
    "taskMaxTapeManagerInventorySyncThreads" : 12345,
    "taskMaxExportThreads" : 12345,
    "taskMaxExportThreadsPerSource" : 12345,
    "taskMaxImportThreads" : 12345,
    "taskMaxStoreThreads" : 12345,
    "taskMaxRestoreThreads" : 12345,
    "taskMaxSnapshotThreads" : 12345,
    "taskMaxSnapshotThreadsPerSource" : 12345,
    "taskInventorySyncTimeout" : 12345,
    "taskTapeManagerInventorySyncTimeout" : 12345,
    "taskExportTimeout" : 12345,
    "taskStoreTimeout" : 12345,
    "taskRestoreTimeout" : 12345,
    "taskUnmountTimeout" : 12345,
    "taskMountTimeout" : 12345,
    "taskImportTimeout" : 12345,
    "taskOldBackupsRemovalTimeout" : 12345,
    "taskOldSnapshotsRemovalTimeout" : 12345,
    "taskSnapshotTimeout" : 12345,
    "taskSnapshotReversionTimeout" : 12345,
    "taskQueuePollInterval" : 12345
  },
  "netcatSettings" : {
    "netcatMinPort" : 12345,
    "netcatMaxPort" : 12345,
    "netcatMaxAttempts" : 12345,
    "netcatBzip2" : true
  },
  "cloudAgentSettings" : {
    "cloudAgentWindowsHost" : "...",
    "cloudAgentWindowsUser" : "...",
    "cloudAgentTaskProgressRefreshInterval" : 12345
  }
}
                
              

GET /node-configs/default-settings

Returns default node configuration.

Response Body
media type data type description
application/json NodeConfigDetails (JSON) default node configuration

Example

Request
GET /node-configs/default-settings
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "modificationTime" : 12345,
  "isDefault" : true,
  "backupDestinations" : [ {
    "guid" : "...",
    "name" : "...",
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "nodeConfigCount" : 12345,
    "nodeInitErrors" : {
      "property1" : "...",
      "property2" : "..."
    },
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "warnings" : [ "...", "..." ],
    "defaultBackupDestination" : true,
    "spaceThreshold" : 12345,
    "description" : "...",
    "backupDestinationForCloud" : true,
    "state" : "NOT_INITIALIZED",
    "configurationWarning" : "...",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "modificationTime" : 1451649601000
  }, {
    "guid" : "...",
    "name" : "...",
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "nodeConfigCount" : 12345,
    "nodeInitErrors" : {
      "property1" : "...",
      "property2" : "..."
    },
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "warnings" : [ "...", "..." ],
    "defaultBackupDestination" : true,
    "spaceThreshold" : 12345,
    "description" : "...",
    "backupDestinationForCloud" : true,
    "state" : "REQUIRED_INITIALIZATION",
    "configurationWarning" : "...",
    "type" : {
      "name" : "...",
      "description" : "..."
    },
    "modificationTime" : 12345
  } ],
  "generalSettings" : {
    "generalExportPath" : "...",
    "generalMountPath" : "...",
    "generalImportPath" : "...",
    "generalBackupTimeDiff" : 12345,
    "generalKeepLastBackupLocally" : true,
    "minFreeSpaceForExport" : 12345,
    "generalMinFreeSpaceForSnapshotBytes" : 12345,
    "generalMinFreeSpaceForSnapshotPercentage" : 12345,
    "generalDynamicallyAttachedDisksSlotOffset" : 12345
  },
  "threadsSettings" : {
    "taskMaxInventorySyncThreads" : 12345,
    "taskMaxTapeManagerInventorySyncThreads" : 12345,
    "taskMaxExportThreads" : 12345,
    "taskMaxExportThreadsPerSource" : 12345,
    "taskMaxImportThreads" : 12345,
    "taskMaxStoreThreads" : 12345,
    "taskMaxRestoreThreads" : 12345,
    "taskMaxSnapshotThreads" : 12345,
    "taskMaxSnapshotThreadsPerSource" : 12345,
    "taskInventorySyncTimeout" : 12345,
    "taskTapeManagerInventorySyncTimeout" : 12345,
    "taskExportTimeout" : 12345,
    "taskStoreTimeout" : 12345,
    "taskRestoreTimeout" : 12345,
    "taskUnmountTimeout" : 12345,
    "taskMountTimeout" : 12345,
    "taskImportTimeout" : 12345,
    "taskOldBackupsRemovalTimeout" : 12345,
    "taskOldSnapshotsRemovalTimeout" : 12345,
    "taskSnapshotTimeout" : 12345,
    "taskSnapshotReversionTimeout" : 12345,
    "taskQueuePollInterval" : 12345
  },
  "netcatSettings" : {
    "netcatMinPort" : 12345,
    "netcatMaxPort" : 12345,
    "netcatMaxAttempts" : 12345,
    "netcatBzip2" : true
  },
  "cloudAgentSettings" : {
    "cloudAgentWindowsHost" : "...",
    "cloudAgentWindowsUser" : "...",
    "cloudAgentTaskProgressRefreshInterval" : 12345
  }
}
                
              

GET /node-configs/reduced

Returns list of the reduced node configurations.

Request Parameters
name type description
backup-to-be-restored query
direction query
filter query
nameLike query
orderBy query
page query
size query
Response Body
media type data type description
application/json array of NodeConfigReducedListRecord (JSON) list of the reduced node configurations

Example

Request
GET /node-configs/reduced
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "...",
  "name" : "...",
  "isDefault" : true,
  "generalExportPath" : "...",
  "threadsSettings" : {
    "taskMaxExportThreads" : 12345,
    "taskMaxExportThreadsPerSource" : 12345,
    "taskMaxImportThreads" : 12345
  }
} ]
                
              

DELETE /node-configs/{guid}

Remove node configuration.

Request Parameters
name type description
guid path specify local unique identifier for node configuration (use by vProtect)

Example

Request
DELETE /node-configs/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /node-configs/{guid}

Get a single node configuration.

Request Parameters
name type description
guid path specify local unique identifier for node configuration (use by vProtect)
Response Body
media type data type description
application/json NodeConfigDetails (JSON) node configuration details

Example

Request
GET /node-configs/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "modificationTime" : 12345,
  "isDefault" : true,
  "backupDestinations" : [ {
    "guid" : "...",
    "name" : "...",
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "nodeConfigCount" : 12345,
    "nodeInitErrors" : {
      "property1" : "...",
      "property2" : "..."
    },
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "warnings" : [ "...", "..." ],
    "defaultBackupDestination" : true,
    "spaceThreshold" : 12345,
    "description" : "...",
    "backupDestinationForCloud" : true,
    "state" : "INITIALIZED",
    "configurationWarning" : "...",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "modificationTime" : 1451649601000
  }, {
    "guid" : "...",
    "name" : "...",
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "nodeConfigCount" : 12345,
    "nodeInitErrors" : {
      "property1" : "...",
      "property2" : "..."
    },
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "warnings" : [ "...", "..." ],
    "defaultBackupDestination" : true,
    "spaceThreshold" : 12345,
    "description" : "...",
    "backupDestinationForCloud" : true,
    "state" : "INITIALIZED",
    "configurationWarning" : "...",
    "type" : {
      "name" : "...",
      "description" : "..."
    },
    "modificationTime" : 12345
  } ],
  "generalSettings" : {
    "generalExportPath" : "...",
    "generalMountPath" : "...",
    "generalImportPath" : "...",
    "generalBackupTimeDiff" : 12345,
    "generalKeepLastBackupLocally" : true,
    "minFreeSpaceForExport" : 12345,
    "generalMinFreeSpaceForSnapshotBytes" : 12345,
    "generalMinFreeSpaceForSnapshotPercentage" : 12345,
    "generalDynamicallyAttachedDisksSlotOffset" : 12345
  },
  "threadsSettings" : {
    "taskMaxInventorySyncThreads" : 12345,
    "taskMaxTapeManagerInventorySyncThreads" : 12345,
    "taskMaxExportThreads" : 12345,
    "taskMaxExportThreadsPerSource" : 12345,
    "taskMaxImportThreads" : 12345,
    "taskMaxStoreThreads" : 12345,
    "taskMaxRestoreThreads" : 12345,
    "taskMaxSnapshotThreads" : 12345,
    "taskMaxSnapshotThreadsPerSource" : 12345,
    "taskInventorySyncTimeout" : 12345,
    "taskTapeManagerInventorySyncTimeout" : 12345,
    "taskExportTimeout" : 12345,
    "taskStoreTimeout" : 12345,
    "taskRestoreTimeout" : 12345,
    "taskUnmountTimeout" : 12345,
    "taskMountTimeout" : 12345,
    "taskImportTimeout" : 12345,
    "taskOldBackupsRemovalTimeout" : 12345,
    "taskOldSnapshotsRemovalTimeout" : 12345,
    "taskSnapshotTimeout" : 12345,
    "taskSnapshotReversionTimeout" : 12345,
    "taskQueuePollInterval" : 12345
  },
  "netcatSettings" : {
    "netcatMinPort" : 12345,
    "netcatMaxPort" : 12345,
    "netcatMaxAttempts" : 12345,
    "netcatBzip2" : true
  },
  "cloudAgentSettings" : {
    "cloudAgentWindowsHost" : "...",
    "cloudAgentWindowsUser" : "...",
    "cloudAgentTaskProgressRefreshInterval" : 12345
  }
}
                
              

PUT /node-configs/{guid}

Change node configuration details.

Request Parameters
name type description
guid path specify local unique identifier for node configuration (use by vProtect)
Request Body
media type data type description
application/json NodeConfigRequest (JSON) specify node configuration details to update
Response Body
media type data type description
application/json NodeConfigDetails (JSON) updated details of node configuration

Example

Request
PUT /node-configs/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "isDefault" : true,
  "backupDestinations" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "generalSettings" : {
    "generalExportPath" : "...",
    "generalMountPath" : "...",
    "generalImportPath" : "...",
    "generalBackupTimeDiff" : 12345,
    "generalKeepLastBackupLocally" : true,
    "minFreeSpaceForExport" : 12345,
    "generalMinFreeSpaceForSnapshotBytes" : 12345,
    "generalMinFreeSpaceForSnapshotPercentage" : 12345,
    "generalDynamicallyAttachedDisksSlotOffset" : 12345
  },
  "threadsSettings" : {
    "taskMaxInventorySyncThreads" : 12345,
    "taskMaxTapeManagerInventorySyncThreads" : 12345,
    "taskMaxExportThreads" : 12345,
    "taskMaxExportThreadsPerSource" : 12345,
    "taskMaxImportThreads" : 12345,
    "taskMaxStoreThreads" : 12345,
    "taskMaxRestoreThreads" : 12345,
    "taskMaxSnapshotThreads" : 12345,
    "taskMaxSnapshotThreadsPerSource" : 12345,
    "taskInventorySyncTimeout" : 12345,
    "taskTapeManagerInventorySyncTimeout" : 12345,
    "taskExportTimeout" : 12345,
    "taskStoreTimeout" : 12345,
    "taskRestoreTimeout" : 12345,
    "taskUnmountTimeout" : 12345,
    "taskMountTimeout" : 12345,
    "taskImportTimeout" : 12345,
    "taskOldBackupsRemovalTimeout" : 12345,
    "taskOldSnapshotsRemovalTimeout" : 12345,
    "taskSnapshotTimeout" : 12345,
    "taskSnapshotReversionTimeout" : 12345,
    "taskQueuePollInterval" : 12345
  },
  "netcatSettings" : {
    "netcatMinPort" : 12345,
    "netcatMaxPort" : 12345,
    "netcatMaxAttempts" : 12345,
    "netcatBzip2" : true
  },
  "cloudAgentSettings" : {
    "cloudAgentWindowsHost" : "...",
    "cloudAgentWindowsUser" : "...",
    "cloudAgentWindowsPassword" : "...",
    "cloudAgentTaskProgressRefreshInterval" : 12345
  }
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "modificationTime" : 12345,
  "isDefault" : true,
  "backupDestinations" : [ {
    "guid" : "...",
    "name" : "...",
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "nodeConfigCount" : 12345,
    "nodeInitErrors" : {
      "property1" : "...",
      "property2" : "..."
    },
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "warnings" : [ "...", "..." ],
    "defaultBackupDestination" : true,
    "spaceThreshold" : 12345,
    "description" : "...",
    "backupDestinationForCloud" : true,
    "state" : "INITIALIZED",
    "configurationWarning" : "...",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "modificationTime" : 1451649601000
  }, {
    "guid" : "...",
    "name" : "...",
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "nodeConfigCount" : 12345,
    "nodeInitErrors" : {
      "property1" : "...",
      "property2" : "..."
    },
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "warnings" : [ "...", "..." ],
    "defaultBackupDestination" : true,
    "spaceThreshold" : 12345,
    "description" : "...",
    "backupDestinationForCloud" : true,
    "state" : "REQUIRED_INITIALIZATION",
    "configurationWarning" : "...",
    "type" : {
      "name" : "...",
      "description" : "..."
    },
    "modificationTime" : 12345
  } ],
  "generalSettings" : {
    "generalExportPath" : "...",
    "generalMountPath" : "...",
    "generalImportPath" : "...",
    "generalBackupTimeDiff" : 12345,
    "generalKeepLastBackupLocally" : true,
    "minFreeSpaceForExport" : 12345,
    "generalMinFreeSpaceForSnapshotBytes" : 12345,
    "generalMinFreeSpaceForSnapshotPercentage" : 12345,
    "generalDynamicallyAttachedDisksSlotOffset" : 12345
  },
  "threadsSettings" : {
    "taskMaxInventorySyncThreads" : 12345,
    "taskMaxTapeManagerInventorySyncThreads" : 12345,
    "taskMaxExportThreads" : 12345,
    "taskMaxExportThreadsPerSource" : 12345,
    "taskMaxImportThreads" : 12345,
    "taskMaxStoreThreads" : 12345,
    "taskMaxRestoreThreads" : 12345,
    "taskMaxSnapshotThreads" : 12345,
    "taskMaxSnapshotThreadsPerSource" : 12345,
    "taskInventorySyncTimeout" : 12345,
    "taskTapeManagerInventorySyncTimeout" : 12345,
    "taskExportTimeout" : 12345,
    "taskStoreTimeout" : 12345,
    "taskRestoreTimeout" : 12345,
    "taskUnmountTimeout" : 12345,
    "taskMountTimeout" : 12345,
    "taskImportTimeout" : 12345,
    "taskOldBackupsRemovalTimeout" : 12345,
    "taskOldSnapshotsRemovalTimeout" : 12345,
    "taskSnapshotTimeout" : 12345,
    "taskSnapshotReversionTimeout" : 12345,
    "taskQueuePollInterval" : 12345
  },
  "netcatSettings" : {
    "netcatMinPort" : 12345,
    "netcatMaxPort" : 12345,
    "netcatMaxAttempts" : 12345,
    "netcatBzip2" : true
  },
  "cloudAgentSettings" : {
    "cloudAgentWindowsHost" : "...",
    "cloudAgentWindowsUser" : "...",
    "cloudAgentTaskProgressRefreshInterval" : 12345
  }
}
                
              

GET /node-configs/for-restore/{guid}

Get a single node configuration.

Request Parameters
name type description
guid path specify local unique identifier for node configuration (use by vProtect)
Response Body
media type data type description
application/json NodeConfigReducedListRecord (JSON) node configuration details

Example

Request
GET /node-configs/for-restore/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "isDefault" : true,
  "generalExportPath" : "...",
  "threadsSettings" : {
    "taskMaxExportThreads" : 12345,
    "taskMaxExportThreadsPerSource" : 12345,
    "taskMaxImportThreads" : 12345
  }
}
                
              

GET /node-configs/reduced/{guid}

Returns list of node configurations for restore.

Request Parameters
name type description
guid path
Response Body
media type data type description
application/json NodeConfigReducedListRecord (JSON) list of node configurations for restore

Example

Request
GET /node-configs/reduced/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "isDefault" : true,
  "generalExportPath" : "...",
  "threadsSettings" : {
    "taskMaxExportThreads" : 12345,
    "taskMaxExportThreadsPerSource" : 12345,
    "taskMaxImportThreads" : 12345
  }
}
                
              

PUT /node-configs/{guid}/assign-nodes

Request Parameters
name type description
guid path
Request Body
media type data type
application/json NodeAssignmentToConfigRequest (JSON)

Example

Request
PUT /node-configs/{guid}/assign-nodes
Content-Type: application/json

                
{
  "nodes" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              
Response
HTTP/1.1 204 No Content

              

PUT /node-configs/{guid}/assign-os-agents

Request Parameters
name type description
guid path
Request Body
media type data type
application/json OSAgentAssignmentToConfigRequest (JSON)

Example

Request
PUT /node-configs/{guid}/assign-os-agents
Content-Type: application/json

                
{
  "osAgents" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              
Response
HTTP/1.1 204 No Content

              

POST /node-configs/{guid}/clone

Request Parameters
name type description
guid path
Request Body
media type data type
application/json CloneDTO (JSON)
Response Body
media type data type description
application/json NodeConfigDetails (JSON)

Example

Request
POST /node-configs/{guid}/clone
Content-Type: application/json
Accept: application/json

                
{
  "name" : "..."
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "modificationTime" : 12345,
  "isDefault" : true,
  "backupDestinations" : [ {
    "guid" : "...",
    "name" : "...",
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "nodeConfigCount" : 12345,
    "nodeInitErrors" : {
      "property1" : "...",
      "property2" : "..."
    },
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "warnings" : [ "...", "..." ],
    "defaultBackupDestination" : true,
    "spaceThreshold" : 12345,
    "description" : "...",
    "backupDestinationForCloud" : true,
    "state" : "REQUIRED_INITIALIZATION",
    "configurationWarning" : "...",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "modificationTime" : 1451649601000
  }, {
    "guid" : "...",
    "name" : "...",
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "nodeConfigCount" : 12345,
    "nodeInitErrors" : {
      "property1" : "...",
      "property2" : "..."
    },
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "warnings" : [ "...", "..." ],
    "defaultBackupDestination" : true,
    "spaceThreshold" : 12345,
    "description" : "...",
    "backupDestinationForCloud" : true,
    "state" : "REQUIRED_INITIALIZATION",
    "configurationWarning" : "...",
    "type" : {
      "name" : "...",
      "description" : "..."
    },
    "modificationTime" : 12345
  } ],
  "generalSettings" : {
    "generalExportPath" : "...",
    "generalMountPath" : "...",
    "generalImportPath" : "...",
    "generalBackupTimeDiff" : 12345,
    "generalKeepLastBackupLocally" : true,
    "minFreeSpaceForExport" : 12345,
    "generalMinFreeSpaceForSnapshotBytes" : 12345,
    "generalMinFreeSpaceForSnapshotPercentage" : 12345,
    "generalDynamicallyAttachedDisksSlotOffset" : 12345
  },
  "threadsSettings" : {
    "taskMaxInventorySyncThreads" : 12345,
    "taskMaxTapeManagerInventorySyncThreads" : 12345,
    "taskMaxExportThreads" : 12345,
    "taskMaxExportThreadsPerSource" : 12345,
    "taskMaxImportThreads" : 12345,
    "taskMaxStoreThreads" : 12345,
    "taskMaxRestoreThreads" : 12345,
    "taskMaxSnapshotThreads" : 12345,
    "taskMaxSnapshotThreadsPerSource" : 12345,
    "taskInventorySyncTimeout" : 12345,
    "taskTapeManagerInventorySyncTimeout" : 12345,
    "taskExportTimeout" : 12345,
    "taskStoreTimeout" : 12345,
    "taskRestoreTimeout" : 12345,
    "taskUnmountTimeout" : 12345,
    "taskMountTimeout" : 12345,
    "taskImportTimeout" : 12345,
    "taskOldBackupsRemovalTimeout" : 12345,
    "taskOldSnapshotsRemovalTimeout" : 12345,
    "taskSnapshotTimeout" : 12345,
    "taskSnapshotReversionTimeout" : 12345,
    "taskQueuePollInterval" : 12345
  },
  "netcatSettings" : {
    "netcatMinPort" : 12345,
    "netcatMaxPort" : 12345,
    "netcatMaxAttempts" : 12345,
    "netcatBzip2" : true
  },
  "cloudAgentSettings" : {
    "cloudAgentWindowsHost" : "...",
    "cloudAgentWindowsUser" : "...",
    "cloudAgentTaskProgressRefreshInterval" : 12345
  }
}
                
              

GET /node-configs/{guid}/windows-password

Returns windows password for M365 settings.

Request Parameters
name type description
guid path specify local unique identifier for node config
Response Body
media type data type description
application/json string (JSON) windows password

Example

Request
GET /node-configs/{guid}/windows-password
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

PUT /node-configs/{guid}/windows-password

Change windows password for M365 settings.

Request Parameters
name type description
guid path specify local unique identifier for node config
Request Body
media type data type description
application/json StringDTO (JSON) specify new windows password

Example

Request
PUT /node-configs/{guid}/windows-password
Content-Type: application/json

                
{
  "value" : "..."
}
                
              
Response
HTTP/1.1 204 No Content