Applications
post__applications_create
Code samples
POST /applications/create HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /applications/create
Create an application instance.
Body parameter
{
"Application": "string",
"Template": "string",
"Description": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationElementCreate | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
delete__applications_delete
Code samples
DELETE /applications/delete HTTP/1.1
Accept: application/json
DELETE /applications/delete
Delete an application instance.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | The name of the application instance to delete. |
| force | query | boolean | false | Do not ask for approval when deleting the application. |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
put__applications_edit
Code samples
PUT /applications/edit HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/edit
Edit an application instance.
Body parameter
{
"Application": "string",
"Description": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | none |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationElementEdit | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__applications_list
Code samples
GET /applications/list HTTP/1.1
Accept: application/json
GET /applications/list
List application instances.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | Limit results by the application instance name. |
| desc | query | boolean | false | Show application description. |
| cg | query | boolean | false | Show consistency groups within the applications. |
| vols | query | boolean | false | Show volumes within the application instances. |
Example responses
200 Response
{
"Data": [
{
"Application": "string",
"Template": "string",
"Description": "string",
"Volumes": [
{
"Application": "string",
"Volume": "string",
"VolumeEntityId": 0,
"Id": 0,
"MetadataVolumeEntityId": 0,
"IsInternalVolume": true,
"CapacityInBytes": 0,
"SnapshotCapacityInBytes": 0,
"Tiers": {
"TierEntityIds": [
0
],
"TierPools": [
"string"
],
"TierN": [
0
],
"TierK": [
0
],
"TierSizesInBytes": [
0
],
"EvacuationThresholdsInPercentage": [
0.1
],
"LowerThresholdsInPercentage": [
0.1
],
"TierDataDegradationHistogram": [
[
0
]
],
"TierMetadataDegradationHistogram": [
[
0
]
]
},
"IsRoot": true,
"State": "Ok",
"Vms": [
"string"
],
"Shares": [
{
"Application": "string",
"Volume": "string",
"Share": "string",
"Path": "string",
"Browsable": true,
"RecycleBin": true,
"ReadonlyAccess": true,
"AllowedSubnets": [
"string"
],
"Smb": true,
"Nfs": true
}
],
"Profile": "string",
"Mapping": [
{
"Host": "string",
"LunId": 0
}
],
"Naa": "string",
"StatsInfo": {
"UserDataAllocatedSizeInBytes": 0.1,
"UserDataConsumedSizeInBytes": 0.1,
"UpperTierAllocatedSizeInBytes": 0.1,
"UpperTierConsumedSizeInBytes": 0.1,
"RetentionAllocatedSizeInBytes": 0.1,
"RetentionConsumedSizeInBytes": 0.1,
"VRAIDAllocatedSizeInBytes": 0.1,
"VRAIDConsumedSizeInBytes": 0.1,
"Iops": 0.1,
"LatencyInMilliseconds": 0.1,
"IoSizeInBytes": 0.1,
"ThroughputInBytes": 0.1
},
"FileSystemInformation": {
"MountState": "Mounted",
"ReplicationMetadata": "None",
"EnableSnapone": true,
"Profile": "string",
"FilesystemState": "string",
"InodeCount": "string",
"FreeInodes": "string",
"BlockSize": "string",
"BlockCount": "string",
"FreeBlocks": "string",
"FilesystemCreated": "string",
"LastMountTime": "string",
"LastWriteTime": "string",
"MountCount": "string",
"LastChecked": "string",
"LifeTimeWrites": "string"
},
"Object": {
"Application": "string",
"Volume": "string",
"IP": "string",
"FloatingIp": "string",
"Port": 0,
"EnableSsl": true,
"AccessKeys": [
"string"
],
"ObjectProvider": "Minio"
},
"ConnectivityType": "None",
"Replication": {
"IpAddress": "string",
"Port": 0,
"Role": "Unknown",
"InternalRole": "Unknown",
"LocalDataStatus": "NotAvailable",
"ReplicationPairs": [
{
"SyncInPercentage": 0.1,
"ReplicationId": 0,
"RemoteSystemName": "string",
"RemoteSystemId": 0,
"RemoteSystemRole": "Unknown",
"IpAddress": "string",
"Port": 0,
"RemoteAppName": "string",
"RemoteVolName": "string",
"ReplicationProtocol": "None",
"ConnectionStatus": "Initializing",
"RemoteDataStatus": "NotAvailable",
"RemoteDiskStatus": "Unknown"
}
]
},
"Pool": "string",
"StripedPools": [
"string"
],
"Log2StrideSectors": 0,
"DataDegradationHistogram": [
0
],
"MetadataDegradationHistogram": [
0
],
"MetadataPool": "string",
"StripedMetadataPools": [
"string"
],
"N": 0,
"K": 0,
"MetadataN": 0,
"MetadataK": 0,
"SectorSize": "string",
"Cgid": 0,
"GroupedVolume": "string",
"DisableSpaceReclamation": true,
"EncryptionKey": "string",
"SaveEncryptedRecoveryKey": true,
"Encrypted": true,
"Uptime": "string",
"ReadOnly": true,
"Force": true
}
],
"ConsistencyGroups": [
{
"Id": 0,
"ParentConsistencyGroupId": 0,
"ParentSnapshotId": 0,
"SnapshotScheduler": [
"string"
],
"IsVssBasedSnapshotScheduler": true,
"VssInitiators": [
"string"
],
"IsDirectVssMapping": true,
"IsAvailable": true,
"WorkerProcess": 0,
"Volumes": [
{
"Application": "string",
"Volume": "string",
"VolumeEntityId": 0,
"Id": 0,
"MetadataVolumeEntityId": 0,
"IsInternalVolume": true,
"CapacityInBytes": 0,
"SnapshotCapacityInBytes": 0,
"Tiers": {
"TierEntityIds": [
0
],
"TierPools": [
"string"
],
"TierN": [
0
],
"TierK": [
0
],
"TierSizesInBytes": [
0
],
"EvacuationThresholdsInPercentage": [
0.1
],
"LowerThresholdsInPercentage": [
0.1
],
"TierDataDegradationHistogram": [
[
0
]
],
"TierMetadataDegradationHistogram": [
[
0
]
]
},
"IsRoot": true,
"State": "Ok",
"Vms": [
"string"
],
"Shares": [
{
"Application": "string",
"Volume": "string",
"Share": "string",
"Path": "string",
"Browsable": true,
"RecycleBin": true,
"ReadonlyAccess": true,
"AllowedSubnets": [
"string"
],
"Smb": true,
"Nfs": true
}
],
"Profile": "string",
"Mapping": [
{
"Host": "string",
"LunId": 0
}
],
"Naa": "string",
"StatsInfo": {
"UserDataAllocatedSizeInBytes": 0.1,
"UserDataConsumedSizeInBytes": 0.1,
"UpperTierAllocatedSizeInBytes": 0.1,
"UpperTierConsumedSizeInBytes": 0.1,
"RetentionAllocatedSizeInBytes": 0.1,
"RetentionConsumedSizeInBytes": 0.1,
"VRAIDAllocatedSizeInBytes": 0.1,
"VRAIDConsumedSizeInBytes": 0.1,
"Iops": 0.1,
"LatencyInMilliseconds": 0.1,
"IoSizeInBytes": 0.1,
"ThroughputInBytes": 0.1
},
"FileSystemInformation": {
"MountState": "Mounted",
"ReplicationMetadata": "None",
"EnableSnapone": true,
"Profile": "string",
"FilesystemState": "string",
"InodeCount": "string",
"FreeInodes": "string",
"BlockSize": "string",
"BlockCount": "string",
"FreeBlocks": "string",
"FilesystemCreated": "string",
"LastMountTime": "string",
"LastWriteTime": "string",
"MountCount": "string",
"LastChecked": "string",
"LifeTimeWrites": "string"
},
"Object": {
"Application": "string",
"Volume": "string",
"IP": "string",
"FloatingIp": "string",
"Port": 0,
"EnableSsl": true,
"AccessKeys": [
"string"
],
"ObjectProvider": "Minio"
},
"ConnectivityType": "None",
"Replication": {
"IpAddress": "string",
"Port": 0,
"Role": "Unknown",
"InternalRole": "Unknown",
"LocalDataStatus": "NotAvailable",
"ReplicationPairs": [
{
"SyncInPercentage": 0.1,
"ReplicationId": 0,
"RemoteSystemName": "string",
"RemoteSystemId": 0,
"RemoteSystemRole": "Unknown",
"IpAddress": "string",
"Port": 0,
"RemoteAppName": "string",
"RemoteVolName": "string",
"ReplicationProtocol": "None",
"ConnectionStatus": "Initializing",
"RemoteDataStatus": "NotAvailable",
"RemoteDiskStatus": "Unknown"
}
]
},
"Pool": "string",
"StripedPools": [
"string"
],
"Log2StrideSectors": 0,
"DataDegradationHistogram": [
0
],
"MetadataDegradationHistogram": [
0
],
"MetadataPool": "string",
"StripedMetadataPools": [
"string"
],
"N": 0,
"K": 0,
"MetadataN": 0,
"MetadataK": 0,
"SectorSize": "string",
"Cgid": 0,
"GroupedVolume": "string",
"DisableSpaceReclamation": true,
"EncryptionKey": "string",
"SaveEncryptedRecoveryKey": true,
"Encrypted": true,
"Uptime": "string",
"ReadOnly": true,
"Force": true
}
],
"Snapshots": [
{
"Id": 0,
"Date": "2019-08-24T14:15:22Z",
"Owner": "None"
}
]
}
],
"Vms": [
{
"Name": "string",
"VolumeName": "string"
}
]
}
]
}
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ApplicationElementApiResult |
| 400 | Bad Request | Bad Request | string |
get__applications_encryption_encryption_key_example
Code samples
GET /applications/encryption/encryption_key_example HTTP/1.1
Accept: application/json
GET /applications/encryption/encryption_key_example
Generate an example encryption key that can be used for encrypting a consistency group.
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
put__applications_encryption_supply_encryption_key
Code samples
PUT /applications/encryption/supply_encryption_key HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/encryption/supply_encryption_key
Supply an encryption key to allow an encrypted consistency group to load.
Body parameter
{
"Cgid": 0,
"Application": "string",
"Volume": "string",
"EncryptionKey": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationsEncryptionSupplyEncryptionKey | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
post__applications_filesystems_add
Code samples
POST /applications/filesystems/add HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /applications/filesystems/add
Create a file system on a volume (required for NAS/Object).
Body parameter
{
"Application": "string",
"Volumes": [
"string"
],
"Profile": "string",
"AddReplicationMetadata": true,
"EnableSnapone": true,
"Force": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationsFilesystemsAdd | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
put__applications_filesystems_edit
Code samples
PUT /applications/filesystems/edit HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/filesystems/edit
Create a file system on a volume (required for NAS/Object).
Body parameter
{
"AddReplicationMetadata": true,
"EnableSnapone": true,
"Force": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | none |
| volume | query | string | false | none |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationsFilesystemsEdit | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__applications_filesystems_list
Code samples
GET /applications/filesystems/list HTTP/1.1
Accept: application/json
GET /applications/filesystems/list
List file system assignments.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | Filter by application. |
| volume | query | string | false | Filter by volume name. |
Example responses
200 Response
{
"Data": [
{
"Application": "string",
"Template": "string",
"Description": "string",
"Volumes": [
{
"Application": "string",
"Volume": "string",
"VolumeEntityId": 0,
"Id": 0,
"MetadataVolumeEntityId": 0,
"IsInternalVolume": true,
"CapacityInBytes": 0,
"SnapshotCapacityInBytes": 0,
"Tiers": {
"TierEntityIds": [
0
],
"TierPools": [
"string"
],
"TierN": [
0
],
"TierK": [
0
],
"TierSizesInBytes": [
0
],
"EvacuationThresholdsInPercentage": [
0.1
],
"LowerThresholdsInPercentage": [
0.1
],
"TierDataDegradationHistogram": [
[
0
]
],
"TierMetadataDegradationHistogram": [
[
0
]
]
},
"IsRoot": true,
"State": "Ok",
"Vms": [
"string"
],
"Shares": [
{
"Application": "string",
"Volume": "string",
"Share": "string",
"Path": "string",
"Browsable": true,
"RecycleBin": true,
"ReadonlyAccess": true,
"AllowedSubnets": [
"string"
],
"Smb": true,
"Nfs": true
}
],
"Profile": "string",
"Mapping": [
{
"Host": "string",
"LunId": 0
}
],
"Naa": "string",
"StatsInfo": {
"UserDataAllocatedSizeInBytes": 0.1,
"UserDataConsumedSizeInBytes": 0.1,
"UpperTierAllocatedSizeInBytes": 0.1,
"UpperTierConsumedSizeInBytes": 0.1,
"RetentionAllocatedSizeInBytes": 0.1,
"RetentionConsumedSizeInBytes": 0.1,
"VRAIDAllocatedSizeInBytes": 0.1,
"VRAIDConsumedSizeInBytes": 0.1,
"Iops": 0.1,
"LatencyInMilliseconds": 0.1,
"IoSizeInBytes": 0.1,
"ThroughputInBytes": 0.1
},
"FileSystemInformation": {
"MountState": "Mounted",
"ReplicationMetadata": "None",
"EnableSnapone": true,
"Profile": "string",
"FilesystemState": "string",
"InodeCount": "string",
"FreeInodes": "string",
"BlockSize": "string",
"BlockCount": "string",
"FreeBlocks": "string",
"FilesystemCreated": "string",
"LastMountTime": "string",
"LastWriteTime": "string",
"MountCount": "string",
"LastChecked": "string",
"LifeTimeWrites": "string"
},
"Object": {
"Application": "string",
"Volume": "string",
"IP": "string",
"FloatingIp": "string",
"Port": 0,
"EnableSsl": true,
"AccessKeys": [
"string"
],
"ObjectProvider": "Minio"
},
"ConnectivityType": "None",
"Replication": {
"IpAddress": "string",
"Port": 0,
"Role": "Unknown",
"InternalRole": "Unknown",
"LocalDataStatus": "NotAvailable",
"ReplicationPairs": [
{
"SyncInPercentage": 0.1,
"ReplicationId": 0,
"RemoteSystemName": "string",
"RemoteSystemId": 0,
"RemoteSystemRole": "Unknown",
"IpAddress": "string",
"Port": 0,
"RemoteAppName": "string",
"RemoteVolName": "string",
"ReplicationProtocol": "None",
"ConnectionStatus": "Initializing",
"RemoteDataStatus": "NotAvailable",
"RemoteDiskStatus": "Unknown"
}
]
},
"Pool": "string",
"StripedPools": [
"string"
],
"Log2StrideSectors": 0,
"DataDegradationHistogram": [
0
],
"MetadataDegradationHistogram": [
0
],
"MetadataPool": "string",
"StripedMetadataPools": [
"string"
],
"N": 0,
"K": 0,
"MetadataN": 0,
"MetadataK": 0,
"SectorSize": "string",
"Cgid": 0,
"GroupedVolume": "string",
"DisableSpaceReclamation": true,
"EncryptionKey": "string",
"SaveEncryptedRecoveryKey": true,
"Encrypted": true,
"Uptime": "string",
"ReadOnly": true,
"Force": true
}
],
"ConsistencyGroups": [
{
"Id": 0,
"ParentConsistencyGroupId": 0,
"ParentSnapshotId": 0,
"SnapshotScheduler": [
"string"
],
"IsVssBasedSnapshotScheduler": true,
"VssInitiators": [
"string"
],
"IsDirectVssMapping": true,
"IsAvailable": true,
"WorkerProcess": 0,
"Volumes": [
{
"Application": "string",
"Volume": "string",
"VolumeEntityId": 0,
"Id": 0,
"MetadataVolumeEntityId": 0,
"IsInternalVolume": true,
"CapacityInBytes": 0,
"SnapshotCapacityInBytes": 0,
"Tiers": {
"TierEntityIds": [
0
],
"TierPools": [
"string"
],
"TierN": [
0
],
"TierK": [
0
],
"TierSizesInBytes": [
0
],
"EvacuationThresholdsInPercentage": [
0.1
],
"LowerThresholdsInPercentage": [
0.1
],
"TierDataDegradationHistogram": [
[
0
]
],
"TierMetadataDegradationHistogram": [
[
0
]
]
},
"IsRoot": true,
"State": "Ok",
"Vms": [
"string"
],
"Shares": [
{
"Application": "string",
"Volume": "string",
"Share": "string",
"Path": "string",
"Browsable": true,
"RecycleBin": true,
"ReadonlyAccess": true,
"AllowedSubnets": [
"string"
],
"Smb": true,
"Nfs": true
}
],
"Profile": "string",
"Mapping": [
{
"Host": "string",
"LunId": 0
}
],
"Naa": "string",
"StatsInfo": {
"UserDataAllocatedSizeInBytes": 0.1,
"UserDataConsumedSizeInBytes": 0.1,
"UpperTierAllocatedSizeInBytes": 0.1,
"UpperTierConsumedSizeInBytes": 0.1,
"RetentionAllocatedSizeInBytes": 0.1,
"RetentionConsumedSizeInBytes": 0.1,
"VRAIDAllocatedSizeInBytes": 0.1,
"VRAIDConsumedSizeInBytes": 0.1,
"Iops": 0.1,
"LatencyInMilliseconds": 0.1,
"IoSizeInBytes": 0.1,
"ThroughputInBytes": 0.1
},
"FileSystemInformation": {
"MountState": "Mounted",
"ReplicationMetadata": "None",
"EnableSnapone": true,
"Profile": "string",
"FilesystemState": "string",
"InodeCount": "string",
"FreeInodes": "string",
"BlockSize": "string",
"BlockCount": "string",
"FreeBlocks": "string",
"FilesystemCreated": "string",
"LastMountTime": "string",
"LastWriteTime": "string",
"MountCount": "string",
"LastChecked": "string",
"LifeTimeWrites": "string"
},
"Object": {
"Application": "string",
"Volume": "string",
"IP": "string",
"FloatingIp": "string",
"Port": 0,
"EnableSsl": true,
"AccessKeys": [
"string"
],
"ObjectProvider": "Minio"
},
"ConnectivityType": "None",
"Replication": {
"IpAddress": "string",
"Port": 0,
"Role": "Unknown",
"InternalRole": "Unknown",
"LocalDataStatus": "NotAvailable",
"ReplicationPairs": [
{
"SyncInPercentage": 0.1,
"ReplicationId": 0,
"RemoteSystemName": "string",
"RemoteSystemId": 0,
"RemoteSystemRole": "Unknown",
"IpAddress": "string",
"Port": 0,
"RemoteAppName": "string",
"RemoteVolName": "string",
"ReplicationProtocol": "None",
"ConnectionStatus": "Initializing",
"RemoteDataStatus": "NotAvailable",
"RemoteDiskStatus": "Unknown"
}
]
},
"Pool": "string",
"StripedPools": [
"string"
],
"Log2StrideSectors": 0,
"DataDegradationHistogram": [
0
],
"MetadataDegradationHistogram": [
0
],
"MetadataPool": "string",
"StripedMetadataPools": [
"string"
],
"N": 0,
"K": 0,
"MetadataN": 0,
"MetadataK": 0,
"SectorSize": "string",
"Cgid": 0,
"GroupedVolume": "string",
"DisableSpaceReclamation": true,
"EncryptionKey": "string",
"SaveEncryptedRecoveryKey": true,
"Encrypted": true,
"Uptime": "string",
"ReadOnly": true,
"Force": true
}
],
"Snapshots": [
{
"Id": 0,
"Date": "2019-08-24T14:15:22Z",
"Owner": "None"
}
]
}
],
"Vms": [
{
"Name": "string",
"VolumeName": "string"
}
]
}
]
}
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ApplicationElementApiResult |
| 400 | Bad Request | Bad Request | string |
put__applications_filesystems_mount
Code samples
PUT /applications/filesystems/mount HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/filesystems/mount
Mount unmounted file-systems.
Body parameter
{
"Application": "string",
"Volume": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationsFilesystemsMount | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
post__applications_mappings_add
Code samples
POST /applications/mappings/add HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /applications/mappings/add
Add mapping between a volume and an iSCSi/FC/NVMeOF host.
Body parameter
{
"Application": "string",
"Hosts": [
"string"
],
"Volumes": [
"string"
],
"LunIds": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationsMappingsAdd | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
delete__applications_mappings_delete
Code samples
DELETE /applications/mappings/delete HTTP/1.1
Accept: application/json
DELETE /applications/mappings/delete
Delete mapping.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | The name of the application. |
| hosts | query | array[string] | false | The name of the hosts who will be unmapped from the volume. |
| volumes | query | array[string] | false | The name of the volumes you will remove the connectivity to. If not specified, all volumes within the application will be unmapped. |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
put__applications_mappings_edit
Code samples
PUT /applications/mappings/edit HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/mappings/edit
Add/Remove mapping between a volume and an iSCSi/FC/NVMeOF host.
Body parameter
{
"Hosts": [
"string"
],
"LunIds": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | none |
| volume | query | string | false | none |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | MappingElementVolumePerspectiveEdit | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__applications_mappings_list
Code samples
GET /applications/mappings/list HTTP/1.1
Accept: application/json
GET /applications/mappings/list
List mappings.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | Application. |
| volume | query | string | false | Volume name. |
Example responses
200 Response
{
"Data": [
{
"Application": "string",
"Volume": "string",
"Hosts": [
"string"
],
"LunIds": [
"string"
]
}
]
}
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | MappingElementVolumePerspectiveApiResult |
| 400 | Bad Request | Bad Request | string |
post__applications_shares_add
Code samples
POST /applications/shares/add HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /applications/shares/add
Create a SMB or NFS shares inside a volume.
Body parameter
{
"Application": "string",
"Volume": "string",
"Share": "string",
"Smb": true,
"Nfs": true,
"Path": "string",
"Browsable": true,
"AllowedSubnets": [
"string"
],
"RecycleBin": true,
"ReadonlyAccess": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ShareElementCreate | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
delete__applications_shares_delete
Code samples
DELETE /applications/shares/delete HTTP/1.1
Accept: application/json
DELETE /applications/shares/delete
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | The name of the application instance the share resides in. |
| volume | query | string | false | The name of volume the share resides in. |
| shares | query | array[string] | false | The names of the shares to delete. |
| force | query | boolean | false | Don't ask for approval when deleting the volumes. |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
put__applications_shares_edit
Code samples
PUT /applications/shares/edit HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/shares/edit
Body parameter
{
"Share": "string",
"Smb": true,
"Nfs": true,
"Path": "string",
"Browsable": true,
"AllowedSubnets": [
"string"
],
"ReadonlyAccess": true,
"RecycleBin": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | none |
| volume | query | string | false | none |
| share | query | string | false | none |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ShareElementEdit | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__applications_shares_list
Code samples
GET /applications/shares/list HTTP/1.1
Accept: application/json
GET /applications/shares/list
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | Filter by application. |
| volume | query | string | false | Filter by volume name. |
Example responses
200 Response
{
"Data": [
{
"Application": "string",
"Volume": "string",
"Share": "string",
"Path": "string",
"Browsable": true,
"RecycleBin": true,
"ReadonlyAccess": true,
"AllowedSubnets": [
"string"
],
"Smb": true,
"Nfs": true
}
]
}
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ShareElementApiResult |
| 400 | Bad Request | Bad Request | string |
delete__applications_snapshots_delete
Code samples
DELETE /applications/snapshots/delete HTTP/1.1
Accept: application/json
DELETE /applications/snapshots/delete
Delete a snapshot.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | The name of the application. |
| volume | query | string | false | The name of the volume that contains the snapshot to delete. |
| cgid | query | integer(int64) | false | The id of the consistency group that contains the snapshot to delete. |
| snapshots | query | array[integer] | false | The ids of the snapshot to delete. |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__applications_snapshots_list
Code samples
GET /applications/snapshots/list HTTP/1.1
Accept: application/json
GET /applications/snapshots/list
List snapshots.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | Limit results by the application instance name. |
| volume | query | string | false | Limit results by the volume name. |
| vols | query | boolean | false | Show volumes within the application instances. |
Example responses
200 Response
{
"Data": [
{
"Id": 0,
"ConsistencyGroupId": 0,
"Volumes": [
{
"Id": 0,
"Application": "string",
"Volume": "string"
}
],
"Date": "2019-08-24T14:15:22Z",
"Owner": "None"
}
]
}
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DetailedSnapshotElementApiResult |
| 400 | Bad Request | Bad Request | string |
put__applications_snapshots_restore
Code samples
PUT /applications/snapshots/restore HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/snapshots/restore
Create a new volume from a snapshot.
Body parameter
{
"Application": "string",
"Volume": "string",
"Suffix": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| cgid | query | integer(int64) | false | none |
| snapshot | query | integer(int64) | false | none |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationsSnapshotsRestore | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
put__applications_snapshots_schedule
Code samples
PUT /applications/snapshots/schedule HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/snapshots/schedule
Schedule snapshots.
Body parameter
{
"Frequency": [
"string"
],
"Retention": [
"string"
],
"Enable_vss": true,
"Force": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| cgid | query | integer(int64) | false | none |
| application | query | string | false | none |
| volume | query | string | false | none |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationsSnapshotsSchedule | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
post__applications_snapshots_take
Code samples
POST /applications/snapshots/take HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /applications/snapshots/take
Take a manual snapshot.
Body parameter
{
"All": true,
"Application": "string",
"Volume": "string",
"Cgid": 0,
"Vss": true,
"Count": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationsSnapshotsTake | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
put__applications_snapshots_vss
Code samples
PUT /applications/snapshots/vss HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/snapshots/vss
Configure VSS settings for volumes.
Body parameter
{
"VssInitiators": [
"string"
],
"DirectMapping": true,
"Force": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| cgid | query | integer(int64) | false | none |
| application | query | string | false | none |
| volume | query | string | false | none |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationsSnapshotsVss | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
post__applications_volumes_create
Code samples
POST /applications/volumes/create HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /applications/volumes/create
Create a volume.
Body parameter
{
"Application": "string",
"Volume": "string",
"CapacityInBytes": 0,
"Pool": "string",
"N": 0,
"K": 0,
"MetadataPool": "string",
"MetadataN": 0,
"MetadataK": 0,
"GroupedVolume": "string",
"Cgid": 0,
"EncryptionKey": "string",
"SaveEncryptedRecoveryKey": true,
"SectorSize": "string",
"StripedPools": [
"string"
],
"StripedMetadataPools": [
"string"
],
"Log2StrideSectors": 0,
"SnapshotCapacityInBytes": 0,
"DisableSpaceReclamation": true,
"Force": true,
"Tiers": {
"TierEntityIds": [
0
],
"TierPools": [
"string"
],
"TierN": [
0
],
"TierK": [
0
],
"TierSizesInBytes": [
0
],
"EvacuationThresholdsInPercentage": [
0.1
],
"LowerThresholdsInPercentage": [
0.1
],
"TierDataDegradationHistogram": [
[
0
]
],
"TierMetadataDegradationHistogram": [
[
0
]
]
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | VolumeElementCreate | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
delete__applications_volumes_delete
Code samples
DELETE /applications/volumes/delete HTTP/1.1
Accept: application/json
DELETE /applications/volumes/delete
Delete volumes.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | The name of the application. |
| volume | query | string | false | The volume to delete. |
| force | query | boolean | false | Don't ask for approval when deleting the volumes. |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
put__applications_volumes_edit
Code samples
PUT /applications/volumes/edit HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/volumes/edit
Change the parameters of a volume within an application instance.
Body parameter
{
"Volume": "string",
"CapacityInBytes": 0,
"SnapshotCapacityInBytes": 0,
"DisableSpaceReclamation": true,
"ReadOnly": true,
"Force": true,
"Tiers": {
"TierEntityIds": [
0
],
"TierPools": [
"string"
],
"TierN": [
0
],
"TierK": [
0
],
"TierSizesInBytes": [
0
],
"EvacuationThresholdsInPercentage": [
0.1
],
"LowerThresholdsInPercentage": [
0.1
],
"TierDataDegradationHistogram": [
[
0
]
],
"TierMetadataDegradationHistogram": [
[
0
]
]
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | none |
| volume | query | string | false | none |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | VolumeElementEdit | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__applications_volumes_list
Code samples
GET /applications/volumes/list HTTP/1.1
Accept: application/json
GET /applications/volumes/list
List volumes.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | Limit results by the application instance name. |
| volume | query | string | false | Limit results by the volume name. |
| details | query | boolean | false | Show additional information about the volumes. |
| consistencyGroups | query | boolean | false | Show consistency groups within the applications. |
| snapshots | query | boolean | false | Show volume snapshots. |
| blockConnectivity | query | boolean | false | Show the block connectivity of volumes. |
| fileConnectivity | query | boolean | false | Show the file connectivity of volumes. |
| capacity | query | boolean | false | Include volume capacity statistics. |
| performance | query | boolean | false | Include volume performance statistics. |
Example responses
200 Response
{
"Data": [
{
"Application": "string",
"Template": "string",
"Description": "string",
"Volumes": [
{
"Application": "string",
"Volume": "string",
"VolumeEntityId": 0,
"Id": 0,
"MetadataVolumeEntityId": 0,
"IsInternalVolume": true,
"CapacityInBytes": 0,
"SnapshotCapacityInBytes": 0,
"Tiers": {
"TierEntityIds": [
0
],
"TierPools": [
"string"
],
"TierN": [
0
],
"TierK": [
0
],
"TierSizesInBytes": [
0
],
"EvacuationThresholdsInPercentage": [
0.1
],
"LowerThresholdsInPercentage": [
0.1
],
"TierDataDegradationHistogram": [
[
0
]
],
"TierMetadataDegradationHistogram": [
[
0
]
]
},
"IsRoot": true,
"State": "Ok",
"Vms": [
"string"
],
"Shares": [
{
"Application": "string",
"Volume": "string",
"Share": "string",
"Path": "string",
"Browsable": true,
"RecycleBin": true,
"ReadonlyAccess": true,
"AllowedSubnets": [
"string"
],
"Smb": true,
"Nfs": true
}
],
"Profile": "string",
"Mapping": [
{
"Host": "string",
"LunId": 0
}
],
"Naa": "string",
"StatsInfo": {
"UserDataAllocatedSizeInBytes": 0.1,
"UserDataConsumedSizeInBytes": 0.1,
"UpperTierAllocatedSizeInBytes": 0.1,
"UpperTierConsumedSizeInBytes": 0.1,
"RetentionAllocatedSizeInBytes": 0.1,
"RetentionConsumedSizeInBytes": 0.1,
"VRAIDAllocatedSizeInBytes": 0.1,
"VRAIDConsumedSizeInBytes": 0.1,
"Iops": 0.1,
"LatencyInMilliseconds": 0.1,
"IoSizeInBytes": 0.1,
"ThroughputInBytes": 0.1
},
"FileSystemInformation": {
"MountState": "Mounted",
"ReplicationMetadata": "None",
"EnableSnapone": true,
"Profile": "string",
"FilesystemState": "string",
"InodeCount": "string",
"FreeInodes": "string",
"BlockSize": "string",
"BlockCount": "string",
"FreeBlocks": "string",
"FilesystemCreated": "string",
"LastMountTime": "string",
"LastWriteTime": "string",
"MountCount": "string",
"LastChecked": "string",
"LifeTimeWrites": "string"
},
"Object": {
"Application": "string",
"Volume": "string",
"IP": "string",
"FloatingIp": "string",
"Port": 0,
"EnableSsl": true,
"AccessKeys": [
"string"
],
"ObjectProvider": "Minio"
},
"ConnectivityType": "None",
"Replication": {
"IpAddress": "string",
"Port": 0,
"Role": "Unknown",
"InternalRole": "Unknown",
"LocalDataStatus": "NotAvailable",
"ReplicationPairs": [
{
"SyncInPercentage": 0.1,
"ReplicationId": 0,
"RemoteSystemName": "string",
"RemoteSystemId": 0,
"RemoteSystemRole": "Unknown",
"IpAddress": "string",
"Port": 0,
"RemoteAppName": "string",
"RemoteVolName": "string",
"ReplicationProtocol": "None",
"ConnectionStatus": "Initializing",
"RemoteDataStatus": "NotAvailable",
"RemoteDiskStatus": "Unknown"
}
]
},
"Pool": "string",
"StripedPools": [
"string"
],
"Log2StrideSectors": 0,
"DataDegradationHistogram": [
0
],
"MetadataDegradationHistogram": [
0
],
"MetadataPool": "string",
"StripedMetadataPools": [
"string"
],
"N": 0,
"K": 0,
"MetadataN": 0,
"MetadataK": 0,
"SectorSize": "string",
"Cgid": 0,
"GroupedVolume": "string",
"DisableSpaceReclamation": true,
"EncryptionKey": "string",
"SaveEncryptedRecoveryKey": true,
"Encrypted": true,
"Uptime": "string",
"ReadOnly": true,
"Force": true
}
],
"ConsistencyGroups": [
{
"Id": 0,
"ParentConsistencyGroupId": 0,
"ParentSnapshotId": 0,
"SnapshotScheduler": [
"string"
],
"IsVssBasedSnapshotScheduler": true,
"VssInitiators": [
"string"
],
"IsDirectVssMapping": true,
"IsAvailable": true,
"WorkerProcess": 0,
"Volumes": [
{
"Application": "string",
"Volume": "string",
"VolumeEntityId": 0,
"Id": 0,
"MetadataVolumeEntityId": 0,
"IsInternalVolume": true,
"CapacityInBytes": 0,
"SnapshotCapacityInBytes": 0,
"Tiers": {
"TierEntityIds": [
0
],
"TierPools": [
"string"
],
"TierN": [
0
],
"TierK": [
0
],
"TierSizesInBytes": [
0
],
"EvacuationThresholdsInPercentage": [
0.1
],
"LowerThresholdsInPercentage": [
0.1
],
"TierDataDegradationHistogram": [
[
0
]
],
"TierMetadataDegradationHistogram": [
[
0
]
]
},
"IsRoot": true,
"State": "Ok",
"Vms": [
"string"
],
"Shares": [
{
"Application": "string",
"Volume": "string",
"Share": "string",
"Path": "string",
"Browsable": true,
"RecycleBin": true,
"ReadonlyAccess": true,
"AllowedSubnets": [
"string"
],
"Smb": true,
"Nfs": true
}
],
"Profile": "string",
"Mapping": [
{
"Host": "string",
"LunId": 0
}
],
"Naa": "string",
"StatsInfo": {
"UserDataAllocatedSizeInBytes": 0.1,
"UserDataConsumedSizeInBytes": 0.1,
"UpperTierAllocatedSizeInBytes": 0.1,
"UpperTierConsumedSizeInBytes": 0.1,
"RetentionAllocatedSizeInBytes": 0.1,
"RetentionConsumedSizeInBytes": 0.1,
"VRAIDAllocatedSizeInBytes": 0.1,
"VRAIDConsumedSizeInBytes": 0.1,
"Iops": 0.1,
"LatencyInMilliseconds": 0.1,
"IoSizeInBytes": 0.1,
"ThroughputInBytes": 0.1
},
"FileSystemInformation": {
"MountState": "Mounted",
"ReplicationMetadata": "None",
"EnableSnapone": true,
"Profile": "string",
"FilesystemState": "string",
"InodeCount": "string",
"FreeInodes": "string",
"BlockSize": "string",
"BlockCount": "string",
"FreeBlocks": "string",
"FilesystemCreated": "string",
"LastMountTime": "string",
"LastWriteTime": "string",
"MountCount": "string",
"LastChecked": "string",
"LifeTimeWrites": "string"
},
"Object": {
"Application": "string",
"Volume": "string",
"IP": "string",
"FloatingIp": "string",
"Port": 0,
"EnableSsl": true,
"AccessKeys": [
"string"
],
"ObjectProvider": "Minio"
},
"ConnectivityType": "None",
"Replication": {
"IpAddress": "string",
"Port": 0,
"Role": "Unknown",
"InternalRole": "Unknown",
"LocalDataStatus": "NotAvailable",
"ReplicationPairs": [
{
"SyncInPercentage": 0.1,
"ReplicationId": 0,
"RemoteSystemName": "string",
"RemoteSystemId": 0,
"RemoteSystemRole": "Unknown",
"IpAddress": "string",
"Port": 0,
"RemoteAppName": "string",
"RemoteVolName": "string",
"ReplicationProtocol": "None",
"ConnectionStatus": "Initializing",
"RemoteDataStatus": "NotAvailable",
"RemoteDiskStatus": "Unknown"
}
]
},
"Pool": "string",
"StripedPools": [
"string"
],
"Log2StrideSectors": 0,
"DataDegradationHistogram": [
0
],
"MetadataDegradationHistogram": [
0
],
"MetadataPool": "string",
"StripedMetadataPools": [
"string"
],
"N": 0,
"K": 0,
"MetadataN": 0,
"MetadataK": 0,
"SectorSize": "string",
"Cgid": 0,
"GroupedVolume": "string",
"DisableSpaceReclamation": true,
"EncryptionKey": "string",
"SaveEncryptedRecoveryKey": true,
"Encrypted": true,
"Uptime": "string",
"ReadOnly": true,
"Force": true
}
],
"Snapshots": [
{
"Id": 0,
"Date": "2019-08-24T14:15:22Z",
"Owner": "None"
}
]
}
],
"Vms": [
{
"Name": "string",
"VolumeName": "string"
}
]
}
]
}
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ApplicationElementApiResult |
| 400 | Bad Request | Bad Request | string |
post__applications_filesystems_fstrim_run
Code samples
POST /applications/filesystems/fstrim/run HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /applications/filesystems/fstrim/run
Run fstrim on a file-system volume.
Body parameter
{
"Application": "string",
"Volume": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationsFilesystemsFstrimRun | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__applications_filesystems_fstrim_status
Code samples
GET /applications/filesystems/fstrim/status HTTP/1.1
Accept: application/json
GET /applications/filesystems/fstrim/status
Check fstrim status on file-system volumes.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | Filter by application. |
| volume | query | string | false | Filter by volume name. |
Example responses
200 Response
{
"Data": [
{
"Application": "string",
"Volume": "string",
"IsFstrimRunning": true
}
]
}
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | VolumeFstrimStatusApiResult |
| 400 | Bad Request | Bad Request | string |
post__applications_objects_access_keys_create
Code samples
POST /applications/objects/access_keys/create HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /applications/objects/access_keys/create
Create an object access key.
Body parameter
{
"AccessKey": "string",
"SecretKey": "string",
"Role": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ObjectAccessKeyElementCreate | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
delete__applications_objects_access_keys_delete
Code samples
DELETE /applications/objects/access_keys/delete HTTP/1.1
Accept: application/json
DELETE /applications/objects/access_keys/delete
Delete object access key.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accessKey | query | string | false | Delete this access key. |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
put__applications_objects_access_keys_edit
Code samples
PUT /applications/objects/access_keys/edit HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/objects/access_keys/edit
Edit object access key.
Body parameter
{
"AccessKey": "string",
"SecretKey": "string",
"Role": "string",
"Force": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accessKey | query | string | false | none |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ObjectAccessKeyElementEdit | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__applications_objects_access_keys_list
Code samples
GET /applications/objects/access_keys/list HTTP/1.1
Accept: application/json
GET /applications/objects/access_keys/list
View all object access keys.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accessKey | query | string | false | Filter results by access key. |
| showSecretKeys | query | boolean | false | Show secret keys. |
Example responses
200 Response
{
"Data": [
{
"AccessKey": "string",
"Role": "string",
"SecretKey": "string",
"EncryptedSecretKey": "string",
"Force": true
}
]
}
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ObjectAccessKeyElementApiResult |
| 400 | Bad Request | Bad Request | string |
post__applications_objects_stores_create
Code samples
POST /applications/objects/stores/create HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /applications/objects/stores/create
Create an object store on a specific volume.
Body parameter
{
"Application": "string",
"Volume": "string",
"FloatingIp": "string",
"Port": 0,
"AccessKeys": [
"string"
],
"EnableSsl": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ObjectStoreElementCreate | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
delete__applications_objects_stores_delete
Code samples
DELETE /applications/objects/stores/delete HTTP/1.1
Accept: application/json
DELETE /applications/objects/stores/delete
Delete an object store.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | The name of the application that contains the object store. |
| volume | query | string | false | The name of the volume that contains the object store. |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
put__applications_objects_stores_edit
Code samples
PUT /applications/objects/stores/edit HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/objects/stores/edit
Edit an object store.
Body parameter
{
"FloatingIp": "string",
"Port": 0,
"AccessKeys": [
"string"
],
"EnableSsl": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | none |
| volume | query | string | false | none |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ObjectStoreElementEdit | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__applications_objects_stores_list
Code samples
GET /applications/objects/stores/list HTTP/1.1
Accept: application/json
GET /applications/objects/stores/list
View all object stores.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | The name of the application that contains the object store. |
| volume | query | string | false | The name of the volume that contains the object store. |
Example responses
200 Response
{
"Data": [
{
"Application": "string",
"Volume": "string",
"IP": "string",
"FloatingIp": "string",
"Port": 0,
"EnableSsl": true,
"AccessKeys": [
"string"
],
"ObjectProvider": "Minio"
}
]
}
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ObjectStoreElementApiResult |
| 400 | Bad Request | Bad Request | string |
put__applications_objects_stores_access_keys_add
Code samples
PUT /applications/objects/stores/access_keys/add HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /applications/objects/stores/access_keys/add
Add access keys to an object store.
Body parameter
{
"Application": "string",
"Volume": "string",
"AccessKeys": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ApplicationsObjectsStoresAccessKeysAdd | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
delete__applications_objects_stores_access_keys_delete
Code samples
DELETE /applications/objects/stores/access_keys/delete HTTP/1.1
Accept: application/json
DELETE /applications/objects/stores/access_keys/delete
Delete objects access keys to an object store.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | The name of the application that contains the object store. |
| volume | query | string | false | The name of the volume that contains the object store. |
| accessKeys | query | array[string] | false | Access keys to access the object store. |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
No Comments