| Path | Method | Description |
|---|---|---|
| /api/v1/analytics/metrics | get | Retrieve all metrics |
| /api/v1/analytics/platforms/{platformId} | get | Retrieve metrics for specific platform |
| /api/v1/analytics/summary | get | Retrieve usage summary |
| /api/v1/analytics/summaryUsage | get | Retrieve usage summary for all platforms |
| /api/v1/analytics/platformsUsage | get | Retrieve percentage platforms usage |
| /api/v1/analytics/operatingSystems | get | Retrieve information about operating systems in use |
| Path | Method | Description |
|---|---|---|
| /api/v1/auth/externalProviders | get | List of configured external identity providers |
| /api/v1/auth/externalProviders | post | Adds new external identity provider for saml |
| /api/v1/auth/externalProviders/{providerId} | delete | Delete external identity provider |
| /api/v1/auth/externalProviders/{providerId} | get | Configured external identity provider by id |
| /api/v1/auth/login | post | login |
| Path | Method | Description |
|---|---|---|
| /api/v1/user/checkCredentials | post | checkCredentials |
| /api/v1/user/forgotPassword | post | forgotPassword |
| /api/v1/user/me | get | getMe |
| /api/v1/user/removeSubscription | delete | removeSubscription |
| /api/v1/user/resetPassword | post | resetPassword |
| /api/v1/user/users | get | getUsers |
| /api/v1/user/users | post | createUser |
| /api/v1/user/users/{user_id} | delete | deleteUser |
| /api/v1/user/users/{user_id} | get | getUser |
| /api/v1/user/users/{user_id} | put | updateUser |
| /api/v1/user/users/{user_id}/setAccessRights | put | setAccessRights |
| /api/v1/user/users/{user_id}/setPassword | put | setPassword |
| /api/v1/user/users/{user_id}/setRole | put | setRole |
| /api/v1/user/validateToken | post | validateToken |
| Path | Method | Description |
|---|---|---|
| /api/v1/configuration/platformAccess | get | Get platform access configutation |
| /api/v1/configuration/platformAccess | put | Set platform access configutation |
| /api/v1/configuration/platformAccess/{platform_id} | get | Get platform access value |
| /api/v1/configuration/mailProviders | get | Get all mail providers |
| /api/v1/configuration/mailProviders | post | Add new provider data |
| /api/v1/configuration/mailProviders/{provider_id} | get | Get provider data |
| /api/v1/configuration/mailProviders/{provider_id} | put | Edit provider |
| /api/v1/configuration/mailProviders/{provider_id} | delete | Delete provider |
| /api/v1/configuration/mailProviders/default | get | Get data for default mail provider |
| /api/v1/configuration/mailProviders/default/{provider_id} | put | Set default mail provider |
| /api/v1/configuration/mailProviders/default/{provider_id} | delete | Unset mail provider as default |
| /api/v1/configuration/managementToolTypes | get | Get management tool types |
| /api/v1/configuration/managementTools | get | Get all management tools |
| /api/v1/configuration/managementTools | post | Create new management tool |
| /api/v1/configuration/managementTools/{tool_id} | get | Get specified management tool |
| /api/v1/configuration/managementTools/{tool_id} | put | Update specified management tool |
| /api/v1/configuration/logo | post | Send logo image to be stored |
| /api/v1/configuration/logo | get | Get logo image |
| Path | Method | Description |
|---|---|---|
| /api/v1/subscription/subscriptions | get | Retrieve list of all subscriptions |
| /api/v1/subscription/subscriptions | post | Create new subscription. Provided credentials are validated against target platform |
| /api/v1/subscription/subscriptions/{subscription_id} | get | Get single subscription for specified subscription_id |
| /api/v1/subscription/subscriptions/{subscription_id} | delete | Delete subscription for given id |
| /api/v1/subscription/subscriptions/{subscription_id} | put | Modify subscription for given id |
| /api/v1/subscription/subscriptions/{subscription_id}/tokens | get | Get token for a subscription |
| /api/v1/subscription/validateVm | put | Validate a VM against a policy. |
| /api/v1/subscription/validateWorkshift | put | Validate a workshift against a policy. |
| Path | Method | Description |
|---|---|---|
| /api/v1/management/registerVm | post | Register Vm in management tool |
| /api/v1/management/unregisterVm | delete | Unregister Vm from management tool |
| /api/v1/management/isManaged | get | Check if a vm is managed |
| /api/v1/management/managedVms | get | Return list of managed VM ids |
| /api/v1/management/testConnectivity | post | Check connection with Vm |
| /api/v1/management/installApp | post | Install application |
| /api/v1/management/uninstallApp | delete | Uninstall application |
| /api/v1/management/details | get | Get vm details |
| /api/v1/management/getBootstrapScript | get | Get bootstrap script |
| /api/v1/management/unregisterSubscriptionVms | delete | Unregister vms from subscription |
| /api/v1/management/replaceApps | post | Upload apps metadata |
| /api/v1/management/apps | get | List apps |
| /api/v1/management/apps/{app_id} | get | Get app by id |
| /api/v1/management/tools/{tool_id}/apps/{app_name} | get | Get app by name |
| /api/v1/management/appInstances | get | List apps instances |
| /api/v1/management/appInstances | post | Create an app instance |
| /api/v1/management/appInstances/{app_instance_id} | get | Get an app instance |
| /api/v1/management/appInstances/{app_instance_id} | delete | It is allowed to delete app instances that are in one of the following states: INITIAL, INSTALL_FAILED, UNINSTALL_SUCCEEDED, UNINSTALL_FAILED. |
| /api/v1/management/appInstances/{app_instance_id}/uninstall | put | put uninstall |
| /api/v1/management/tools/{tool_id}/tokens | post | Generate a new token for the given tool |
| /api/v1/management/tools/{tool_id}/tokens/{token_value} | delete | Delete the token |
| Path | Method | Description |
|---|---|---|
| /api/v1/tag/tags | get | Returns a list of all tags with values |
| /api/v1/tag/tags | post | Creates tag with given name and values |
| /api/v1/tag/tags/{tagName} | delete | Delete tag with given name |
| /api/v1/tag/tags/{tagName} | get | Returns the specified tag |
| /api/v1/tag/tags/{tagName} | put | Update some fields of a tag |
| Path | Method | Description |
|---|---|---|
| /api/v1/notification/email | post | Send email |
| Path | Method | Description |
|---|---|---|
| /api/v1/webhook/contentTypes | get | Get available content types for webhooks |
| /api/v1/webhook/eventTypes | get | Get available event types for webhooks |
| /api/v1/webhook/webhooks | get | Get list of defined webhooks |
| /api/v1/webhook/webhooks | post | Create a new webhook |
| /api/v1/webhook/webhooks/{webhook_id} | delete | Delete specified webhook |
| /api/v1/webhook/webhooks/{webhook_id} | get | Get single webhook |
| /api/v1/webhook/webhooks/{webhook_id} | put | Update specified webhook |
| /api/v1/webhook/webhooks/{webhook_id}/disable | delete | Disable specified webhook |
| /api/v1/webhook/webhooks/{webhook_id}/enable | put | Enable specified webhook |
| Path | Method | Description |
|---|---|---|
| /api/v1/whitelist/imageOS | get | Get image type (OS) for a image |
| /api/v1/whitelist/osList | get | Get os types and distributions as a list |
| /api/v1/whitelist/images | post | Add single image to whitelist |
| /api/v1/whitelist/images | get | Get images from whitelist |
| /api/v1/whitelist/images | delete | Delete whitelist |
| /api/v1/whitelist/images/{imageId} | get | Get single image |
| /api/v1/whitelist/images/{imageId} | put | Please use PATCH method. This action will be removed on 14.05.2019 |
| /api/v1/whitelist/images/{imageId} | delete | Remove image from whitelist |
| /api/v1/whitelist/images/{imageId} | patch | Update operating system for image |
| Path | Method | Description |
|---|---|---|
| /api/v1/vmware/compute/availabilityZones | get | List all Availability Zones |
| /api/v1/vmware/compute/flavors | get | Get the list of all flavors |
| /api/v1/vmware/compute/flavors/{flavorId} | get | Get specific flavor by id |
| /api/v1/vmware/compute/images | get | The endpoint is used only by the analytics service and should be deprecated in favor of whitelist/images. |
| /api/v1/vmware/compute/images/{imageId} | get | Get specific images by id |
| /api/v1/vmware/compute/interfaces | get | List of network interfaces |
| /api/v1/vmware/compute/keypairs | get | List all keypairs |
| /api/v1/vmware/compute/keypairs/generate | post | Create a new keypair |
| /api/v1/vmware/compute/keypairs/import | post | Import a new public keypair |
| /api/v1/vmware/compute/keypairs/{keypairId} | delete | Delete a specific keypair |
| /api/v1/vmware/compute/networks | get | List all networks |
| /api/v1/vmware/compute/networks/{networkId}/subnets | get | List all subnets which belong to the given network |
| /api/v1/vmware/compute/privateImages | get | Get private images |
| /api/v1/vmware/compute/privateImages/{imageId} | get | Get specific private image by id |
| /api/v1/vmware/compute/publicImages | get | Get public images |
| /api/v1/vmware/compute/publicImages/{imageId} | get | Get specific public image by id |
| /api/v1/vmware/compute/regions | get | List all regions |
| /api/v1/vmware/compute/securityGroups | get | List of security groups. The result is always an empty list. There are no security groups in VMWare. |
| /api/v1/vmware/compute/snapshots | get | Get list of all snapshots |
| /api/v1/vmware/compute/snapshots | post | Create a new snapshot |
| /api/v1/vmware/compute/snapshots/{snapshotId} | delete | Delete snapshot |
| /api/v1/vmware/compute/validateSubscription | post | Validate subscription before adding it |
| /api/v1/vmware/compute/vms | get | List all virtual machines |
| /api/v1/vmware/compute/vms | post | Create a new VM |
| /api/v1/vmware/compute/vms/{vmId} | delete | Delete a VM |
| /api/v1/vmware/compute/vms/{vmId} | get | Get virtual machine by id |
| /api/v1/vmware/compute/vms/{vmId} | patch | Modify VM properties. Currently it is possible to modify the VM flavor. |
| /api/v1/vmware/compute/vms/{vmId}/command/{action} | put | Execute action on a VM. Actions are start, poweroff, softReboot, hardReboot. |
| /api/v1/vmware/compute/vms/{vmId}/details | get | Get VM details |
| /api/v1/vmware/compute/vms/{vmId}/management | get | Check if management service for the VM is available |
| /api/v1/vmware/compute/vms/{vmId}/password | get | Get the password in an encrypted form for the virtual machine |
| /api/v1/vmware/compute/vms/{vmId}/setTag | put | Set a tag value for a VM |
| /api/v1/vmware/compute/vms/{vmId}/workshift | delete | Delete the VM Workshift |
| /api/v1/vmware/compute/vms/{vmId}/workshift | post | Create a VM Workshift |
| /api/v1/vmware/compute/vms/{vmId}/workshift | put | Update the VM Workshift |
| /api/v1/vmware/compute/volumeTypes | get | Get a list of all volume types user can create volume with |
| /api/v1/vmware/compute/volumes | get | Get list of all volumes |
| /api/v1/vmware/compute/volumes | post | Create a new volume |
| /api/v1/vmware/compute/volumes/{volume_id} | patch | Modify volume properties. Currently it is possible to change to volume size. |
| /api/v1/vmware/compute/volumes/{volume_id}/detach | delete | Dettaches and deletes a volume |
| Path | Method | Description |
|---|---|---|
| /api/v1/azure/compute/publicImages | get | Lists all public images for specified subscription |
| /api/v1/azure/compute/publicImages/{image_id} | get | Gets a single public image by id |
| /api/v1/azure/compute/privateImages | get | Lists private images for specified subscription |
| /api/v1/azure/compute/privateImages/{image_id} | get | Gets a single private image by id |
| /api/v1/azure/compute/validateSubscription | post | Validate subscription credentials |
| /api/v1/azure/compute/images/{image_id} | get | Gets a single image by id |
| /api/v1/azure/compute/regions | get | If subscriptionId is not passed as query parameters endpoint returns list of regions not scoped to any subscription. Otherwise it returns regions for specified subscription. |
| /api/v1/azure/compute/availabilityZones | get | Lists availability zones for specified subscription |
| /api/v1/azure/compute/availabilitySets | get | Lists availability sets for specified subscription and resource group |
| /api/v1/azure/compute/availabilitySets/{availability_set_id} | get | Gets availability set by id |
| /api/v1/azure/compute/resourceGroups | get | Lists resource groups |
| /api/v1/azure/compute/resourceGroups | post | Creates new resource group |
| /api/v1/azure/compute/flavors | get | Lists flavors for specified subscription |
| /api/v1/azure/compute/flavors/{flavor_id} | get | Gets a single flavor by ID |
| /api/v1/azure/compute/vms | get | Lists virtual machines for specified subscription |
| /api/v1/azure/compute/vms | post | May provision managed or unmanaged virtual machine in accordance to the `managementToolId` property. If such is set and points to valid `management tool`, virtual machine will have aformentioned tool deployed and it will be possible to install the application on it. |
| /api/v1/azure/compute/vms/{vm_id} | get | Gets a single virtual machine by ID |
| /api/v1/azure/compute/vms/{vm_id} | patch | Modifies specified virtual machine |
| /api/v1/azure/compute/vms/{vm_id} | delete | Endpoint takes care of deleting the virtual machine from the platform. It also removes: - OS volume - all network interfaces - management if VM was managed by management tool - workshift if VM had one - initial password if VM was provisioned with one |
| /api/v1/azure/compute/vms/{vm_id}/workshift | post | Create a VM Workshift |
| /api/v1/azure/compute/vms/{vm_id}/workshift | put | Update a VM Workshift |
| /api/v1/azure/compute/vms/{vm_id}/workshift | delete | Delete VM Workshift |
| /api/v1/azure/compute/vms/{vm_id}/management | get | Gets specified virtual machine management status |
| /api/v1/azure/compute/vms/{vm_id}/command/{action} | put | Executes power action on a VM. Only specified VMPowerAction are allowed. |
| /api/v1/azure/compute/vms/{vm_id}/password | get | Gets specified virtual machine encrypted password |
| /api/v1/azure/compute/vms/{vm_id}/details | get | If specified virtual machine is provision with enabled management details will contain information gathered by management tool. Aither way it will contains basic information |
| /api/v1/azure/compute/volumes | get | Lists volumes for specified subscription |
| /api/v1/azure/compute/volumes | post | Creates new volume |
| /api/v1/azure/compute/volumes/{volume_id} | get | Gets a single volume by ID |
| /api/v1/azure/compute/volumes/{volume_id} | patch | Modify volume properties |
| /api/v1/azure/compute/volumes/{volume_id} | delete | Removes volume |
| /api/v1/azure/compute/volumes/{volume_id}/attach | put | Attaches volume |
| /api/v1/azure/compute/volumes/{volume_id}/detach | delete | Dettaches volume |
| /api/v1/azure/compute/volumeTypes | get | Lists volume types |
| /api/v1/azure/compute/vms/{vm_id}/assignFloatingIp | put | Assigns a floating public IP v4 to specified VM |
| /api/v1/azure/compute/vms/{vm_id}/unassignFloatingIp | delete | Unassigns floating public IP from specified VM |
| /api/v1/azure/compute/vms/{vm_id}/securityGroups/{security_group_id} | put | Assigns a new network security group and unassigns old one |
| /api/v1/azure/compute/vms/{vm_id}/securityGroups/{security_group_id} | delete | Unassigns specified security group from specified VM |
| /api/v1/azure/compute/vms/{vm_id}/setTag | put | Sets/unsets tag in virtual machine |
| /api/v1/azure/compute/keypairs | get | Lists keypairs |
| /api/v1/azure/compute/keypairs/{keypair_id} | get | Gets a single keypair |
| /api/v1/azure/compute/keypairs/{keypair_id} | delete | Delets a single keypair |
| /api/v1/azure/compute/keypairs/generate | post | Generate a new keypair |
| /api/v1/azure/compute/keypairs/import | post | Import a public key |
| /api/v1/azure/compute/networks | get | List networks for specified subscription |
| /api/v1/azure/compute/networks/{network_id}/subnets | get | Lists subnets for specified network and subscription |
| /api/v1/azure/compute/interfaces | get | Lists interfaces for specified subscription |
| /api/v1/azure/compute/securityGroups | get | Lists security groups for specified subscription |
| /api/v1/azure/compute/snapshots | get | Get list of all snapshots |
| /api/v1/azure/compute/snapshots | post | Create a new snapshot |
| /api/v1/azure/compute/snapshots/{snapshot_id} | delete | Delete snapshot |
| Path | Method | Description |
|---|---|---|
| /api/v1/aws/compute/availabilityZones | get | List all availability zones |
| /api/v1/aws/compute/flavors | get | Lists flavors |
| /api/v1/aws/compute/flavors/{flavor_id} | get | Get flavor by id |
| /api/v1/aws/compute/images/{image_id} | get | Gets image by id |
| /api/v1/aws/compute/interfaces | get | Gets interfaces for specified subscription |
| /api/v1/aws/compute/keypairs | get | Lists keypairs |
| /api/v1/aws/compute/keypairs/generate | post | Create a new keypair |
| /api/v1/aws/compute/keypairs/import | post | Import a new public key |
| /api/v1/aws/compute/keypairs/{keypair_id} | delete | Delete keypair by id |
| /api/v1/aws/compute/keypairs/{keypair_id} | get | Get keypair by id |
| /api/v1/aws/compute/networks | get | Gets list of all networks |
| /api/v1/aws/compute/networks/{network_id}/subnets | get | Lists subnets of specified network and subscription |
| /api/v1/aws/compute/privateImages | get | Lists private images |
| /api/v1/aws/compute/privateImages/{image_id} | get | Gets private image by id |
| /api/v1/aws/compute/publicImages | get | Lists public images |
| /api/v1/aws/compute/publicImages/{image_id} | get | Gets public image by id |
| /api/v1/aws/compute/regions | get | Lists regions |
| /api/v1/aws/compute/securityGroups | get | Lists security groups for specified subscription |
| /api/v1/aws/compute/snapshots | get | Lists snapshots |
| /api/v1/aws/compute/snapshots | post | Creates a new snapshot |
| /api/v1/aws/compute/snapshots/{snapshot_id} | delete | Deletes snapshots |
| /api/v1/aws/compute/validateSubscription | post | Validate subscription credentials |
| /api/v1/aws/compute/vms | get | Gets list of all vms |
| /api/v1/aws/compute/vms | post | Create a new virtual machine |
| /api/v1/aws/compute/vms/{vm_id} | delete | Deletes VM by id |
| /api/v1/aws/compute/vms/{vm_id} | get | Gets vm by id |
| /api/v1/aws/compute/vms/{vm_id} | patch | Modify VM properties |
| /api/v1/aws/compute/vms/{vm_id}/command/{action} | put | Excecutes power action on a VM |
| /api/v1/aws/compute/vms/{vm_id}/details | get | Gets VM details |
| /api/v1/aws/compute/vms/{vm_id}/management | get | Gets management status for a VM |
| /api/v1/aws/compute/vms/{vm_id}/password | get | Get encrypted password for a VM |
| /api/v1/aws/compute/vms/{vm_id}/securityGroups/{security_group_id} | delete | Removes Security Group from a specified VM |
| /api/v1/aws/compute/vms/{vm_id}/securityGroups/{security_group_id} | put | Assign Security Group to a specified VM |
| /api/v1/aws/compute/vms/{vm_id}/setTag | put | Set tag value for VM |
| /api/v1/aws/compute/vms/{vm_id}/workshift | delete | Delete VM Workshift |
| /api/v1/aws/compute/vms/{vm_id}/workshift | post | Add a workshift to the VM |
| /api/v1/aws/compute/vms/{vm_id}/workshift | put | Update VM Workshift |
| /api/v1/aws/compute/volumeTypes | get | Gets a list of all volume types user can create volume with |
| /api/v1/aws/compute/volumes | get | Gets list of all volumes |
| /api/v1/aws/compute/volumes | post | Creates a new EBS volume |
| /api/v1/aws/compute/volumes/{volume_id} | delete | Deletes volume by id |
| /api/v1/aws/compute/volumes/{volume_id} | get | Gets volume by id |
| /api/v1/aws/compute/volumes/{volume_id} | patch | Modify volume properties |
| /api/v1/aws/compute/volumes/{volume_id}/attach | put | Attach volume to specified VM |
| /api/v1/aws/compute/volumes/{volume_id}/detach | delete | Detach volume from a specified vm |