getall_ns_vm_image

GET
This feature is only available for desktop.
Feature is available only on desktop

Use this operation to get NetScaler XVA file

Resource URL

https://adm.cloud.com/massvc/{customerid}/nitro/v2/config/ns_vm_image

Path Parameters

ParameterTypeValueDescription
customerid
string
Required

Customer Id of the user

Header Parameters

ParameterTypeValueDescription
Authorization
string
Required

Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue

isCloud
string
Required

set the value to true in case of Cloud services, false for on-prem deployment

Query Parameters

ParameterTypeValueDescription
filter
string
Optional

Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example: property-name1:property-value1

pagesize
integer
Optional

Use this query-parameter to get the ns_vm_image resources in chunks.To be used along with pageno query parameter.

pageno
integer
Optional

Use this query-parameter to get the ns_vm_image resources in chunks.To be used along with pagesize query parameter.

count
string
Optional

Use this query-parameter to get the count of ns_vm_image resources.

Available values : yes

Responses

Response Details
Http CodeDescription
200

for ns_vm_image

{
  "ns_vm_image": {
    "file_size": "8156768",
    "file_name": "build-13.0-43.11_nc_64.tgz",
    "file_last_modified": "1579734319",
    "file_last_modified_epoch": "1579734319"
  }
}
400

Bad input parameter

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
401

Failed Authentication

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
403

Unauthorized

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
404

Item not found

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
409

Resource Conflict

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
500

Server Error

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
504

Gateway Timeout

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}

getbykey_ns_vm_image

GET
This feature is only available for desktop.
Feature is available only on desktop

Use this operation to get NetScaler XVA file

Resource URL

https://adm.cloud.com/massvc/{customerid}/nitro/v2/config/ns_vm_image/{file_name}

Path Parameters

ParameterTypeValueDescription
file_name
string
Required

File Name

customerid
string
Required

Customer Id of the user

Header Parameters

ParameterTypeValueDescription
Authorization
string
Required

Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue

isCloud
string
Required

set the value to true in case of Cloud services, false for on-prem deployment

Responses

Response Details
Http CodeDescription
200

for ns_vm_image

{
  "ns_vm_image": {
    "file_size": "8156768",
    "file_name": "build-13.0-43.11_nc_64.tgz",
    "file_last_modified": "1579734319",
    "file_last_modified_epoch": "1579734319"
  }
}
400

Bad input parameter

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
401

Failed Authentication

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
403

Unauthorized

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
404

Item not found

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
409

Resource Conflict

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
500

Server Error

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
504

Gateway Timeout

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}

download_ns_vm_image

GET
This feature is only available for desktop.
Feature is available only on desktop

Use this operation to download NetScaler XVA file

Resource URL

https://adm.cloud.com/massvc/{customerid}/nitro/v2/download/ns_vm_image/{file_name}

Path Parameters

ParameterTypeValueDescription
customerid
string
Required

Customer Id of the user

file_name
string
Required

File Name

Header Parameters

ParameterTypeValueDescription
Authorization
string
Required

Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue

isCloud
string
Required

set the value to true in case of Cloud services, false for on-prem deployment

Responses

Response Details
Http CodeDescription
200

Successful download for ns_vm_image

(no example available)
400

Bad input parameter

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
401

Failed Authentication

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
403

Unauthorized

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
404

Item not found

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
409

Resource Conflict

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
500

Server Error

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
504

Gateway Timeout

{
  "errorcode": 1001,
  "errormessage": "id cannot be found"
}
ns vm image-API-Spec