Namirasoft NWS Volume API V1

Namira Software Corporation NWS Volume API Version 1 (1.4.4)

Install


To use this cli, we need to first Install Nodejs, then run the following command.

npm i -g namirasoft-nws-volume-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-nws-volume healthz get

Copied!

Metrics

Get

Returns the application metrics

ns-nws-volume metrics get

Copied!

Value

List

Returns the value list of a given table and column

ns-nws-volume value list {table} {column} {search} {field_id} {limit}

Copied!

VolumeCategory

List

Returns the volume category list

ns-nws-volume volumecategory list {filters} {page} {size} {sorts}

Copied!

Get

Returns a volume category by id.

ns-nws-volume volumecategory get {id}

Copied!

Create

Creates a new volume category for an entity

ns-nws-volume volumecategory create {entity_id}

Copied!

--category_id (String)

Delete

Deletes a volume category by an id.

ns-nws-volume volumecategory delete {entity_id} {id}

Copied!

VolumeField

List

Returns the volume field list

ns-nws-volume volumefield list {filters} {page} {size} {sorts}

Copied!

Get

Returns a volume field by id.

ns-nws-volume volumefield get {id}

Copied!

Create

Creates a new volume field for an entity

ns-nws-volume volumefield create {entity_id}

Copied!

--field_id (String)

--value (Any)

Update

Updates a volume field by an id for an entity

ns-nws-volume volumefield update {entity_id} {id}

Copied!

--field_id (String)

--value (Any)

Delete

Deletes a volume field by an id.

ns-nws-volume volumefield delete {entity_id} {id}

Copied!

VolumeTag

List

Returns the volume tag list

ns-nws-volume volumetag list {filters} {page} {size} {sorts}

Copied!

Get

Returns a volume tag by id.

ns-nws-volume volumetag get {id}

Copied!

Create

Creates a new volume tag for an entity

ns-nws-volume volumetag create {entity_id}

Copied!

--name (String)

--value (String)

Update

Updates a volume tag by an id for an entity

ns-nws-volume volumetag update {entity_id} {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a volume tag by an id.

ns-nws-volume volumetag delete {entity_id} {id}

Copied!

Volume

List

Returns the volume list

ns-nws-volume volume list {filters} {page} {size} {sorts}

Copied!

Get

Returns a volume by an id

ns-nws-volume volume get {id}

Copied!

Delete

Deletes a volume by an id

ns-nws-volume volume delete {id}

Copied!

AWSEFS

Create

Creates a new awsefs volume

ns-nws-volume awsefs create

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--aws_credential_id (String)

--aws_name (String)

Update

Updates an awsefs volume by an id

ns-nws-volume awsefs update {id}

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--aws_credential_id (String)

--aws_name (String)

AWSS3

Create

Creates a new awss3 volume

ns-nws-volume awss3 create

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--aws_credential_id (String)

--aws_name (String)

Update

Updates an awss3 volume by an id

ns-nws-volume awss3 update {id}

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--aws_credential_id (String)

--aws_name (String)

AzureBlobStorage

Create

Creates a new azure blob storage volume

ns-nws-volume azureblobstorage create

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--azure_credential_id (String)

--azure_name (String)

Update

Updates an azure blob storage volume by an id

ns-nws-volume azureblobstorage update {id}

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--azure_credential_id (String)

--azure_name (String)

AzureFiles

Create

Creates a new azure files volume

ns-nws-volume azurefiles create

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--azure_credential_id (String)

--azure_name (String)

Update

Updates an azure files volume by an id

ns-nws-volume azurefiles update {id}

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--azure_credential_id (String)

--azure_name (String)

GCPCloudStorage

Create

Creates a new gcp cloud storage volume

ns-nws-volume gcpcloudstorage create

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--gcp_credential_id (String)

--gcp_name (String)

Update

Updates a gcp cloud storage volume by an id

ns-nws-volume gcpcloudstorage update {id}

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--gcp_credential_id (String)

--gcp_name (String)

GCPFilestore

Create

Creates a new gcp filestore volume

ns-nws-volume gcpfilestore create

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--gcp_credential_id (String)

--gcp_name (String)

Update

Updates a gcp filestore volume by an id

ns-nws-volume gcpfilestore update {id}

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--gcp_credential_id (String)

--gcp_name (String)

NamirasoftBucketStorage

Create

Creates a new namirasoft bucket storage volume

ns-nws-volume namirasoftbucketstorage create

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--size (Integer)

Update

Updates a namirasoft bucket storage volume by an id

ns-nws-volume namirasoftbucketstorage update {id}

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--size (Integer)

NamirasoftDiskFixedPrice

Create

Creates a new namirasoft disk fixed price volume

ns-nws-volume namirasoftdiskfixedprice create

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--size (Integer)

Update

Updates a namirasoft disk fixed price volume by an id

ns-nws-volume namirasoftdiskfixedprice update {id}

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--size (Integer)

NamirasoftDiskUsageBasedPrice

Create

Creates a new namirasoft disk usage based price volume

ns-nws-volume namirasoftdiskusagebasedprice create

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--size (Integer)

Update

Updates a namirasoft disk usage based price volume by an id

ns-nws-volume namirasoftdiskusagebasedprice update {id}

Copied!

--workspace_id (String)

--region_id (String)

--name (String)

--description (String)

--size (Integer)

Schemas


VolumeCategory

{
  "name": "VolumeCategory",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityCategoryInput

{
  "name": "EntityCategoryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    }
  }
}

VolumeField

{
  "name": "VolumeField",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "value": {
      "type": "Any",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityFieldInput

{
  "name": "EntityFieldInput",
  "type": "Object",
  "required": true,
  "fields": {
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "value": {
      "type": "Any",
      "required": false
    }
  }
}

VolumeTag

{
  "name": "VolumeTag",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "value": {
      "type": "String",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityTagInput

{
  "name": "EntityTagInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "value": {
      "type": "String",
      "required": false
    }
  }
}

Volume

{
  "name": "Volume",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "workspace_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "VolumeType",
      "type": "Enum",
      "required": true,
      "valids": [
        "NamirasoftDiskFixedPrice",
        "NamirasoftDiskUsageBasedPrice",
        "NamirasoftBucketStorage",
        "AWSEFS",
        "AWSS3",
        "GCPFilestore",
        "GCPCloudStorage",
        "AzureFiles",
        "AzureBlobStorage",
        "SFTP"
      ]
    },
    "meta": {
      "type": "Any",
      "required": false
    },
    "status": {
      "name": "VolumeStatus",
      "type": "Enum",
      "required": true,
      "valids": [
        "Pending",
        "InProgress",
        "Ready",
        "Failed"
      ]
    },
    "status_message": {
      "type": "String",
      "required": false
    },
    "description": {
      "type": "String",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

AWSEFSCreate

{
  "name": "AWSEFSCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "aws_credential_id": {
      "type": "String",
      "required": true
    },
    "aws_name": {
      "type": "String",
      "required": true
    }
  }
}

AWSEFSUpdate

{
  "name": "AWSEFSUpdate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "aws_credential_id": {
      "type": "String",
      "required": false
    },
    "aws_name": {
      "type": "String",
      "required": false
    }
  }
}

AWSS3Create

{
  "name": "AWSS3Create",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "aws_credential_id": {
      "type": "String",
      "required": true
    },
    "aws_name": {
      "type": "String",
      "required": true
    }
  }
}

AWSS3Update

{
  "name": "AWSS3Update",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "aws_credential_id": {
      "type": "String",
      "required": false
    },
    "aws_name": {
      "type": "String",
      "required": false
    }
  }
}

AzureBlobStorageCreate

{
  "name": "AzureBlobStorageCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "azure_credential_id": {
      "type": "String",
      "required": true
    },
    "azure_name": {
      "type": "String",
      "required": true
    }
  }
}

AzureBlobStorageUpdate

{
  "name": "AzureBlobStorageUpdate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "azure_credential_id": {
      "type": "String",
      "required": false
    },
    "azure_name": {
      "type": "String",
      "required": false
    }
  }
}

AzureFilesCreate

{
  "name": "AzureFilesCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "azure_credential_id": {
      "type": "String",
      "required": true
    },
    "azure_name": {
      "type": "String",
      "required": true
    }
  }
}

AzureFilesUpdate

{
  "name": "AzureFilesUpdate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "azure_credential_id": {
      "type": "String",
      "required": false
    },
    "azure_name": {
      "type": "String",
      "required": false
    }
  }
}

GCPCloudStorageCreate

{
  "name": "GCPCloudStorageCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "gcp_credential_id": {
      "type": "String",
      "required": true
    },
    "gcp_name": {
      "type": "String",
      "required": true
    }
  }
}

GCPCloudStorageUpdate

{
  "name": "GCPCloudStorageUpdate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "gcp_credential_id": {
      "type": "String",
      "required": false
    },
    "gcp_name": {
      "type": "String",
      "required": false
    }
  }
}

GCPFilestoreCreate

{
  "name": "GCPFilestoreCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "gcp_credential_id": {
      "type": "String",
      "required": true
    },
    "gcp_name": {
      "type": "String",
      "required": true
    }
  }
}

GCPFilestoreUpdate

{
  "name": "GCPFilestoreUpdate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "gcp_credential_id": {
      "type": "String",
      "required": false
    },
    "gcp_name": {
      "type": "String",
      "required": false
    }
  }
}

NamirasoftBucketStorageCreate

{
  "name": "NamirasoftBucketStorageCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "size": {
      "type": "Integer",
      "required": true
    }
  }
}

NamirasoftBucketStorageUpdate

{
  "name": "NamirasoftBucketStorageUpdate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "size": {
      "type": "Integer",
      "required": false
    }
  }
}

NamirasoftDiskFixedPriceCreate

{
  "name": "NamirasoftDiskFixedPriceCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "size": {
      "type": "Integer",
      "required": true
    }
  }
}

NamirasoftDiskFixedPriceUpdate

{
  "name": "NamirasoftDiskFixedPriceUpdate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "size": {
      "type": "Integer",
      "required": false
    }
  }
}

NamirasoftDiskUsageBasedPriceCreate

{
  "name": "NamirasoftDiskUsageBasedPriceCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "size": {
      "type": "Integer",
      "required": true
    }
  }
}

NamirasoftDiskUsageBasedPriceUpdate

{
  "name": "NamirasoftDiskUsageBasedPriceUpdate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "region_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "size": {
      "type": "Integer",
      "required": false
    }
  }
}

Enums

VolumeType

NamirasoftDiskFixedPrice

NamirasoftDiskUsageBasedPrice

NamirasoftBucketStorage

AWSEFS

AWSS3

GCPFilestore

GCPCloudStorage

AzureFiles

AzureBlobStorage

SFTP

VolumeStatus

Pending

InProgress

Ready

Failed

Namira Software Corporation

©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.