Applications

Explore this section for comprehensive information on endpoints related to the deployment, management, and operation of applications within our cloud software API environment.

Get a list of applications

GET/api/v1/servers/applications/GetApplications

Response

Success

Body

itemsnullable array of ApplicationsApiDetails (object)

Request

const response = await fetch('/api/v1/servers/applications/GetApplications', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "instanceDetails": {
        "id": "text",
        "cluster": "text",
        "status": "text",
        "privateIp": "text",
        "publicIp": "text",
        "createdBy": "text",
        "tenant": "text",
        "resourcePool": "text",
        "creationTime": "2024-12-21T16:24:58.959Z",
        "lastUpdated": "2024-12-21T16:24:58.959Z",
        "dns": "text",
        "persistedDirectAttachedStorage": false,
        "personalSharedStorage": false,
        "tenantSharedStorage": false
      },
      "applicationCatalogItem": {
        "name": "text",
        "applicationSourceDetailsUrl": "text",
        "versions": [
          {
            "name": "text",
            "imageUrl": "text",
            "imageLastPushDate": "2024-12-21T16:24:58.959Z",
            "platform": "text",
            "launchType": "text",
            "releaseNotesUrl": "text"
          }
        ]
      },
      "hardwarePackage": {
        "name": "text",
        "description": "text",
        "gpuCount": 0,
        "gpuType": "text",
        "gpuBrand": "text",
        "gpuName": "text",
        "vcpusCount": 0,
        "memoryGb": 0,
        "operatingSystemStorageGb": 0,
        "directAttachedStorageGb": 0,
        "pricePerHour": 0,
        "clusters": [
          "text"
        ]
      }
    }
  ]
}

Get detailed information about a specific application

GET/api/v1/servers/applications/GetApplicationDetails

Query parameters

Response

Success

Body

namenullable string

clusternullable string

statusnullable string

privateIpnullable string

publicIpnullable string

createdBynullable string

tenantnullable string

resourcePoolnullable string

applicationCatalogItemApplicationCatalogItemDto (object)

hardwarePackageHardwarePackageDto (object)

imageUrlnullable string

creationTimestring (date-time)

lastUpdatedstring (date-time)

imageRepositoryHostnamenullable string

imageRepositoryUsernamenullable string

imageRepositoryPasswordnullable string

sshUsernamenullable string

sshKeysnullable array of string

commandOverridenullable string

portsnullable array of integer (int32)

environmentVariablesnullable object

dnsnullable string

createdByTenantIdnullable string

createdByUserIdnullable string

applicationCatalogItemTypenullable string

readinessWatcherPortnullable string

persistedDirectAttachedStorageboolean

personalSharedStorageboolean

tenantSharedStorageboolean

Request

const response = await fetch('/api/v1/servers/applications/GetApplicationDetails?Id=my-jupyter-application&Cluster=Msc1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "cluster": "text",
  "status": "text",
  "privateIp": "text",
  "publicIp": "text",
  "createdBy": "text",
  "tenant": "text",
  "resourcePool": "text",
  "applicationCatalogItem": {
    "name": "text",
    "displayName": "text",
    "description": "text",
    "type": "text",
    "logoUrl": "text",
    "isDefault": false,
    "additionalProperties": "text",
    "versions": [
      {
        "name": "text",
        "imageUrl": "text",
        "imageLastPushDate": "2024-12-21T16:24:58.959Z",
        "description": "text",
        "platform": "text",
        "sourceDetailsUrl": "text",
        "additionalProperties": "text",
        "applicationCatalogItemId": 0,
        "id": 0
      }
    ],
    "id": 0
  },
  "hardwarePackage": {
    "name": "text",
    "displayName": "text",
    "description": "text",
    "logoUrl": "text",
    "gpuCount": 0,
    "gpuType": "text",
    "gpuBrand": "text",
    "gpuName": "text",
    "vcpusCount": 0,
    "memoryByte": 0,
    "operatingSystemStorageSize": 0,
    "operatingSystemStorageUnit": "text",
    "directAttachedStorageSize": 0,
    "directAttachedStorageUnit": "text",
    "pricePerHour": 0,
    "deploymentJson": "text",
    "available": false,
    "availableCount": 0,
    "maxCount": 0,
    "id": 0
  },
  "imageUrl": "text",
  "creationTime": "2024-12-21T16:24:58.959Z",
  "lastUpdated": "2024-12-21T16:24:58.959Z",
  "imageRepositoryHostname": "text",
  "imageRepositoryUsername": "text",
  "imageRepositoryPassword": "text",
  "sshUsername": "text",
  "sshKeys": [
    "text"
  ],
  "commandOverride": "text",
  "ports": [
    0
  ],
  "dns": "text",
  "createdByTenantId": "text",
  "createdByUserId": "text",
  "applicationCatalogItemType": "text",
  "readinessWatcherPort": "text",
  "persistedDirectAttachedStorage": false,
  "personalSharedStorage": false,
  "tenantSharedStorage": false
}

Get a list of application hardware configurations

GET/api/v1/servers/applications/GetConfigurations

Response

Success

Body

itemsnullable array of HardwarePackageDto (object)

Request

const response = await fetch('/api/v1/servers/applications/GetConfigurations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "name": "text",
      "displayName": "text",
      "description": "text",
      "logoUrl": "text",
      "gpuCount": 0,
      "gpuType": "text",
      "gpuBrand": "text",
      "gpuName": "text",
      "vcpusCount": 0,
      "memoryByte": 0,
      "operatingSystemStorageSize": 0,
      "operatingSystemStorageUnit": "text",
      "directAttachedStorageSize": 0,
      "directAttachedStorageUnit": "text",
      "pricePerHour": 0,
      "deploymentJson": "text",
      "available": false,
      "availableCount": 0,
      "maxCount": 0,
      "id": 0
    }
  ]
}

Get detailed information on available configurations for applications

GET/api/v1/servers/applications/GetAvailability

Query parameters

Response

Success

Body

itemsnullable array of HardwarePackageDto (object)

Request

const response = await fetch('/api/v1/servers/applications/GetAvailability?cluster=text&resourcePool=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "name": "text",
      "displayName": "text",
      "description": "text",
      "logoUrl": "text",
      "gpuCount": 0,
      "gpuType": "text",
      "gpuBrand": "text",
      "gpuName": "text",
      "vcpusCount": 0,
      "memoryByte": 0,
      "operatingSystemStorageSize": 0,
      "operatingSystemStorageUnit": "text",
      "directAttachedStorageSize": 0,
      "directAttachedStorageUnit": "text",
      "pricePerHour": 0,
      "deploymentJson": "text",
      "available": false,
      "availableCount": 0,
      "maxCount": 0,
      "id": 0
    }
  ]
}

Get a list of application catalog items

GET/api/v1/servers/applications/GetApplicationCatalogItems

Response

Success

Body

itemsnullable array of ApplicationsApiCatalogItem (object)

Request

const response = await fetch('/api/v1/servers/applications/GetApplicationCatalogItems', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "name": "text",
      "applicationSourceDetailsUrl": "text",
      "versions": [
        {
          "name": "text",
          "imageUrl": "text",
          "imageLastPushDate": "2024-12-21T16:24:58.959Z",
          "platform": "text",
          "launchType": "text",
          "releaseNotesUrl": "text"
        }
      ]
    }
  ]
}

Create a new application using a pre-defined configuration and application catalog item

POST/api/v1/servers/applications/CreateApplication

Body

name*string

The application name

Example: "my-jupyter-application"

cluster*string

The cluster you're operating on

Example: "Msc1"

hardwarePackageName*string

The name or unique identifier of the hardware package to use for the application.

Example: "g-nvidia-1xa100-40gb-pcie-14vcpu-112gb"

applicationCatalogItemName*string

The name of the application catalog item.

Example: "jupyter-notebook"

applicationCatalogItemVersion*string

The version name of the application catalog item.

Example: "python-3.11.9"

resourcePoolnullable string

The resource pool to use for the application

Example: "on-demand"

sshKeysnullable array of string

The SSH keys for accessing the application

persistDirectAttachedStorageboolean

Indicates whether to persist direct attached storage (if resource pool is reserved)

Example: false

personalSharedStorageboolean

Enable personal shared storage for the application

Example: true

tenantSharedStorageboolean

Enable tenant shared storage for the application

Example: true

jupyterTokennullable string

An authentication token for accessing Jupyter Notebook enabled applications

Example: "abc123"

Response

Accepted

Body

idnullable string

clusternullable string

statusnullable string

tenantnullable string

createdBynullable string

privateIpnullable string

publicIpnullable string

resourcePoolnullable string

dnsnullable string

sshUsernamenullable string

applicationCatalogItemNamenullable string

applicationCatalogItemVersionNamenullable string

hardwarePackageNamenullable string

persistedDirectAttachedStorageboolean

personalSharedStorageboolean

tenantSharedStorageboolean

Request

const response = await fetch('/api/v1/servers/applications/CreateApplication', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "applicationCatalogItemName": "jupyter-notebook",
      "applicationCatalogItemVersion": "python-3.11.9",
      "cluster": "Msc1",
      "hardwarePackageName": "g-nvidia-1xa100-40gb-pcie-14vcpu-112gb",
      "name": "my-jupyter-application"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "cluster": "text",
  "status": "text",
  "tenant": "text",
  "createdBy": "text",
  "privateIp": "text",
  "publicIp": "text",
  "resourcePool": "text",
  "dns": "text",
  "sshUsername": "text",
  "applicationCatalogItemName": "text",
  "applicationCatalogItemVersionName": "text",
  "hardwarePackageName": "text",
  "persistedDirectAttachedStorage": false,
  "personalSharedStorage": false,
  "tenantSharedStorage": false
}

Start an application that has been previously set up and provisioned, but is currently OFFLINE

POST/api/v1/servers/applications/StartApplication

Body

id*string

The application name

Example: "my-jupyter-application"

cluster*string

The cluster you're operating on

Example: "Msc1"

Response

Accepted

Body

id*string

The application name

Example: "my-jupyter-application"

cluster*string

The cluster you're operating on

Example: "Msc1"

Request

const response = await fetch('/api/v1/servers/applications/StartApplication', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "cluster": "Msc1",
      "id": "my-jupyter-application"
    }),
});
const data = await response.json();

Response

{
  "id": "my-jupyter-application",
  "cluster": "Msc1"
}

Stop an application that has been previously set up and provisioned, but is currently ONLINE

POST/api/v1/servers/applications/StopApplication

Body

id*string

The application name

Example: "my-jupyter-application"

cluster*string

The cluster you're operating on

Example: "Msc1"

Response

Accepted

Body

id*string

The application name

Example: "my-jupyter-application"

cluster*string

The cluster you're operating on

Example: "Msc1"

Request

const response = await fetch('/api/v1/servers/applications/StopApplication', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "cluster": "Msc1",
      "id": "my-jupyter-application"
    }),
});
const data = await response.json();

Response

{
  "id": "my-jupyter-application",
  "cluster": "Msc1"
}

Permanently delete a specified application, effectively wiping all its data and freeing up resources for other uses

DELETE/api/v1/servers/applications/DestroyApplication

Query parameters

Response

Accepted

Body

id*string

The application name

Example: "my-jupyter-application"

cluster*string

The cluster you're operating on

Example: "Msc1"

Request

const response = await fetch('/api/v1/servers/applications/DestroyApplication?Id=my-jupyter-application&Cluster=Msc1', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "my-jupyter-application",
  "cluster": "Msc1"
}

PreviousClusters NextVirtual machines

Last updated 3 days ago