Epic.io API Documentation

Actions

Retrieves completed and in progress Actions

• GET actions

  Retrieves a list of all completed and in progress Actions for a specific customer / company

• GET actions/{actionId}

  Retrieves an Action with the specified ActionId

• GET actions/getInProgressAction/{targetId}

  Retrieves an in progress Action with the specified TargetId

• GET actions/getServerTime

  Retrieves the time from the server

AlertRules

Information related to Alert Rules and settings for monitoring virtual machines

• GET alertRules

  Retrieves a list of all Alert Rules for a specific customer / company

• GET alertRules/{alertRuleId}

  Retrieves an Alert Rule with the specified AlertRuleId

• GET alertRules/getNodes

  Retrieves a list of all currently monitored nodes

• GET alertRules/getVolumes

  Retrieves a list of all nodes with their current volumes

• GET alertRules/getSites

  No documentation available.

• GET alertRules/getGroups

  No documentation available.

• POST alertRules

  Creates a new Alert Rule

• POST alertRules/{alertRuleId}

  Updates the specified Alert Rule

• DELETE alertRules/{alertRuleId}

  Deletes the Alert Rule with the specified AlertRuleId

• GET alertRules/getlogs/{alertRuleId}

  Retrieves the Alert Log records with the specified AlertRuleId

• GET alertRules/{machineId}/trippedAlerts

  Retrieves the Alert Log records that exceeded the Alert Rule threshold with the specified MachineId

Alerts

Information related to Alert notification profiles and settings

• GET alerts

  Retrieves a list of Alerts for a specific customer / company

• GET alerts/{alertId}

  Retrieves an Alert and it's recipients with the specified AlertId

• GET alerts/alertprofiles

  Retrieves a list of all Alert Profiles for a specific customer / company

• GET alerts/alertprofiles/{alertProfileId}

  Retrieves an Alert Profile and it's recipients with the specified AlertProfileId

• PUT alerts/alertprofiles/{alertProfileId}

  Updates the specified Alert Profile

• DELETE alerts/deleteAlertProfile/{alertProfileId}

  Deletes the Alert Profile with the specified AlertProfileId

• POST alerts/alertprofiles

  Creates a new Alert Profile

• GET alerts/datatables

  No documentation available.

• GET alerts/alertSourceTypes

  No documentation available.

• POST alerts/alertSourceTypes

  No documentation available.

• POST api/Alerts?alertProfileId={alertProfileId}

  No documentation available.

BareMetal

• GET baremetal/inventory?warehouseId={warehouseId}

  No documentation available.

• POST baremetal/inventory?warehouseId={warehouseId}

  No documentation available.

• GET baremetal/bareMetalTemplates?warehouseId={warehouseId}

  No documentation available.

• POST baremetal/bareMetalTemplates?warehouseId={warehouseId}

  No documentation available.

• POST baremetal/{bareMetalId}

  No documentation available.

• GET baremetal/{bareMetalId}

  No documentation available.

Billing

Information related to customer billing and invoice payments

• GET billing

  Retrieves a list of all Orders for a specific customer

• GET billing/{orderId}

  Retrieves an Order and it's details and payments with the specified OrderId

• GET billing/invoicesDue

  Retrieves a list of all Invoices with balances due for a specific customer

• GET billing/accountOnFile

  Retrieves the stored Customer Bank Account information

• GET billing/countries

  Retrieves Countries

• PUT billing/accountOnFile

  Updates the stored Customer Bank Account information

• POST billing/payInvoice

  The function for the payment of invoices and delegating them as either paid or unpaid

• GET billing/points

  Retrieves the Points Balance for a specific customer

• GET billing/templates?warehouseId={warehouseId}&entityType={entityType}

  Retrieves a list of all Templates with the specified WarehouseId and EntityType

• GET api/Billing

  No documentation available.

• GET api/Billing?currencyCode={currencyCode}

  Retrieves a list of Items and their prices with the specified ItemIds and CurrencyCode

• GET api/Billing?billingSetupId={billingSetupId}

  Retrieves a Billing Setup with the specified BillingSetupId

• GET api/Billing?entityId={entityId}

  Retrieves a Billing Setup with the specified EntityId

• GET api/Billing?bundleId={bundleId}

  Retrieves a Bundle with the specified BundleId

• GET api/Billing?templateId={templateId}

  Retrieves a Template with the specified TemplateId

• POST api/Billing?billingSetupId={billingSetupId}&itemId={itemId}&quantityToAdd={quantityToAdd}

  Adds an Item to an existing Billing Setup with the specified BillingSetupId, ItemId, and Quantity to add

• POST api/Billing?billingSetupId={billingSetupId}&itemId={itemId}&quantity={quantity}

  Updates a BillingSetup with the specified BillingSetupId, ItemId, and Quantity

• POST api/Billing?billingSetupId={billingSetupId}&itemId={itemId}

  Removes an Item from a Billing Setup with the specified BillingSetupId and ItemId

Dns

Retrieves and sets Domain Name Service settings

• GET domain

  Retrieves a list of all Domains for a specific customer / company

• GET domain/{domainId}

  Retrieves a Domain with the specified DomainId

• DELETE domain/{domainId}

  Deletes the Domain with the specified DomainId

• DELETE domain/arecords/{aRecordId}

  Deletes the A Record for a Domain with the specified ARecordId

• DELETE domain/txtrecords/{txtRecordId}

  Deletes the Text Record for a Domain with the specified TxtRecordId

• DELETE domain/mxrecords/{mxRecordId}

  Deletes the Mail Server (MX) Record for a Domain with the specified MxRecordId

• DELETE domain/cnamerecords/{cNameRecordId}

  Deletes the Host Alias (cName) Record for a Domain with the specified CNameRecordId

• DELETE domain/soarecords/{soaRecordId}

  Deletes the Start of Authority (SoA) Record for a Domain with the specified SoaRecord

• POST domain

  Creates a new Domain

• POST domain/{domainId}/arecord

  Creates a new A Record for a specified Domain

• POST domain/{domainId}/soarecord

  Creates a new Start of Authority (SoA) Record for a specified Domain

• POST domain/{domainId}/txtrecord

  Creates a new Text Record for a specified Domain

• POST domain/{domainId}/mxrecord

  Creates a new Mail Server (MX) record for a specified Domain

• POST domain/{domainId}/cnamerecord

  Creates a new Host Alias (cName) Record for a specified Domain

• POST domain/defaultnsrecord

  Creates a Default NameSpace (NS) Record for a specified Domain

• PUT domain/{domainId}/arecord

  Edits the selected A Record for a specified Domain

• PUT domain/{domainId}/soarecord

  Edits the selected Start of Authority (SoA) Record for a specified Domain

• PUT domain/{domainId}/cnamerecord

  Edits the selected Host Alias (cName) Record for a specified Domain

• PUT domain/{domainId}/mxrecord

  Edits the selected Mail Service (MX) Record for a specified Domain

• PUT domain/{domainId}/txtrecord

  Edits the selected Text Record for a specified Domain

• DELETE api/Dns

  Deletes the NameSpace (NS) Record for a Domain with the specified DefaultNsRecord

Escalation

• POST escalation/addSchedule

  No documentation available.

• POST escalation/updateLayers/{scheduleId}

  No documentation available.

• POST escalation/updatePageProfile

  No documentation available.

• POST escalation/addPageProfile

  No documentation available.

• GET escalation/pageProfiles

  No documentation available.

• DELETE escalation/deleteProfile?profileId={profileId}

  No documentation available.

• GET escalation/getAlertProfiles

  No documentation available.

• GET escalation/getEditProfile?profileId={profileId}

  No documentation available.

• GET escalation/getPageProfileAlertRule?alertRuleId={alertRuleId}

  No documentation available.

• GET escalation/getProfileIncidents?profileId={profileId}

  No documentation available.

• GET escalation/getIncident?incidentId={incidentId}

  No documentation available.

• POST escalation/deleteSchedule/{scheduleId}

  No documentation available.

• GET escalation/getSchedule/{scheduleId}

  No documentation available.

• GET escalation/getSchedules

  No documentation available.

• POST escalation/resolveIncidents

  No documentation available.

• POST escalation/escalationsPerDay?profileId={profileId}&startDate={startDate}&endDate={endDate}

  No documentation available.

• POST escalation/createIncident

  No documentation available.

• GET escalation/datatables?profileId={profileId}

  No documentation available.

• GET api/Escalation

  No documentation available.

• GET api/Escalation?alertQueueId={alertQueueId}

  No documentation available.

FailoverProfiles

Profiles for the use of Failovers for your virtual machine(s)

• GET failover

  Retrieves a list of all Failover Profiles for a specific customer / company

• GET failover/regions

  Retrieves a list of all Regions available for a specific customer / company

• GET failover/{aRecordFailoverId}

  Retrieves a Failover Profile with the specified ARecordFailoverId

• GET failover/logs/{domainId}

  Retrieves a list of A Record Machine Logs with the specified DomainId

• POST failover/create

  Creates a new A Record Failover

• PUT failover/{aRecordFailoverId}

  Updates the specified A Record Failover

• DELETE failover/{aRecordFailoverId}/delete

  Deletes the A Record Failover with the specified ARecordFailoverId

• GET failover/failovertypes

  Retrieves a list of all Failover Types available for a specific customer / company

• GET failover/failoversetting

  Retrieves the Domain for the Failover record

• GET failover/changeIsUpDetails?logId={logId}

  No documentation available.

FirewallRules

Used to allow or deny access to specific Firewall Services on the firewall

• GET firewallRules

  Retrieves a list of all Firewall Rules for a specific customer / company

• GET firewallRules/{firewallRuleId}

  Retrieves a Firewall Rule with the specified FirewallRuleId

• PUT firewallRules/{firewallRuleId}

  Updates the specified Firewall Rule

• POST firewallRules

  Creates a new Firewall Rule

• DELETE firewallRules/{firewallRuleId}

  Deletes the Firewall Rule with the specified FirewallRuleId

• POST firewallRules/updateRuleOrder

  Updates the Firewall Rule order

FirewallService

Manage and maintain the services to allow or deny access through the firewall

• GET FirewallService

  Retrieves a list of all Firewall Services for a specific customer / company

• GET FirewallService/{firewallServiceId}

  Retrieves a Firewall Service with the specified FirewallServiceId

• GET FirewallService/rules/{firewallServiceId}

  Retrieves a list of Firewall Rules based on a specified FirewallServiceId

• POST FirewallService

  Creates a new Firewall Service

• DELETE FirewallService/{firewallServiceId}

  Deletes the Firewall Service with the specified FirewallServiceId

• DELETE FirewallService/rule/{firewallRuleId}

  Deletes the Firewall Rule with the specified FirewallRuleId

• GET FirewallService/{customerId}/firewall/{firewallRuleId}

  Retrieves a list of Virtual Machines associated to a Firewall Rule with the specified CustomerId and FirewallRuleId

• PUT FirewallService/{firewallServiceId}

  Updates the specified Firewall Service

Hosts

Displays information related to the Virtual Machine(s) Host Servers

• GET hosts

  Retrieves a list of all available Host Servers for a specific customer / company

• GET hosts/{hostId}

  Retrieves a Host with the specified HostId

• GET hosts/getWarehouse/{warehouseId}

  Retrieves a Warehouse with the specified WarehouseId

• GET hosts/getAvailableWarehouses

  Retrieves a list of available Warehouses and the Host Servers within those Warehouses

Logging

Related to the logging of changes made within the portal

• GET {subsystem}/target/{id}

  Retrieves a list of all Change Logs for the specified Subsystem and Id

Monitor

Information related to the monitoring information for Virtual Machines

• GET monitor/{machineId}

  Retrieves the most recent Machine Statistics with the specified MachineId

• GET monitor/machineStats/{machineId}?dateTimeUtc={dateTimeUtc}

  Retrieves statistics from the specified amount of history up to five minutes for the specified machineId

• GET monitor/nodestats/{machineId}?dateTimeUtc={dateTimeUtc}

  Retrieves the most recent Node Statistics with the specified MachineId and a default of the past 6 hours

• GET monitor/node/{machineId}

  Retrieves a list of all Node information with the specified MachineId

• GET monitor/{machineId}/powerSettings

  Retrieves current power settings

• GET monitor/{machineId}/cpuStats?startDate={startDate}&endDate={endDate}

  Retrieves CPU Statistics with the specified MachineId, StartDate, and EndDate

• GET monitor/{machineId}/interfaceStats?interfaceId={interfaceId}&startDate={startDate}&endDate={endDate}

  Retrieves Network Interface Statistics with the specified InterfaceId, StartDate, and EndDate

• PUT monitor/{machineId}

  Updates the specified Node

• GET monitor/{id}/sqlInfo?sqlInfoId={sqlInfoId}

  Retrieves SQL Information for the specified SqlProfileId and SqlInfoId

• GET monitor/{id}/waitstatslist?sqlInfoId={sqlInfoId}

  Retrieves a list of Wait Statistics for the specified SqlProfileId and SqlInfoId

• GET monitor/{id}/processlist?sqlInfoId={sqlInfoId}

  Retrieves a list of Process Information for the specified SqlProfileId and SqlInfoId

• GET monitor/{id}/sqlfileslist?sqlInfoId={sqlInfoId}

  Retrieves a list of SQL File Information for the specified SqlProfileId and SqlInfoId

• GET monitor/{id}/topquerylist?sqlInfoId={sqlInfoId}

  Retrieves a list of top queries information for the specified SqlProfileId and SqlInfoId

• GET monitor/{id}/indexfragmentationlist?sqlInfoId={sqlInfoId}

  Retrieves a list of index fragmentation information for the specified SqlProfileId and SqlInfoId

• GET monitor/{id}/lastbackuptimelist

  Retrieves a list of index fragmentation information for the specified SqlProfileId

• GET monitor/{id}/sqlconfigurationlist?sqlInfoId={sqlInfoId}

  Retrieves a list of sqlconfiguration information for the specified SqlProfileId and SqlInfoId

• GET monitor/{id}/sqlconfigurationlistitem

  Retrieves a list of sqlconfigurationitem information for the specified SqlProfileId and SqlInfoId

• GET monitor/{id}/iostallinfo?startDate={startDate}&endDate={endDate}

  Retrieves Input / Output Stall Information for the specified MachineId (or SqlProfileId), StartDate, and EndDate

• GET monitor/{id}/packetinfo?startDate={startDate}&endDate={endDate}

  Retrieves Packet Information for the specified SqlProfileId, StartDate, and EndDate

• GET monitor/{id}/sessioninfo?startDate={startDate}&endDate={endDate}

  Retrieves Session Information for the specified SqlProfileId, StartDate, and EndDate

• GET monitor/{id}/sqlcpuinfo?startDate={startDate}&endDate={endDate}

  Retrieves Cpu Usage Information for the specified SqlProfileId, StartDate, and EndDate

• GET monitor/{id}/memoryinfo?startDate={startDate}&endDate={endDate}

  Retrieves Memory Information for the specified SqlProfileId, StartDate, and EndDate

• GET monitor/{id}/queryinfo?startDate={startDate}&endDate={endDate}

  Retrieves Query Information for the specified SqlProfileId, StartDate, and EndDate

• GET monitor/{id}/pageinfo?startDate={startDate}&endDate={endDate}

  Retrieves Page Information for the specified SqlProfileId, StartDate, and EndDate

• GET monitor/{id}/processinfo?startDate={startDate}&endDate={endDate}

  Retrieves Process Information for the specified MachineId (or SqlProfileId), StartDate, and EndDate

• GET monitor/{id}/databaseinfo?startDate={startDate}&endDate={endDate}

  Retrieves Database Information for the specified MachineId (or SqlProfileId), StartDate, and EndDate

• GET monitor/{id}/waitstatsinfo?startDate={startDate}&endDate={endDate}

  Retrieves Wait Statistic Information for the specified MachineId (or SqlProfileId), StartDate, and EndDate

• GET monitor/{id}/azureinfo?startDate={startDate}&endDate={endDate}

  Retrieves Azure Information for the specified SqlProfileId, StartDate, and EndDate

• GET monitor/gethelphints?hintCategory={hintCategory}

  No documentation available.

• GET monitor/getwaitdesc

  No documentation available.

• GET monitor/getAlertsEnabledSqlProfiles

  No documentation available.

• GET monitor/getSqlProfiles?machineId={machineId}

  No documentation available.

• GET monitor/topTenCpu

  No documentation available.

• GET monitor/topTenMem?hour={hour}

  No documentation available.

• GET monitor/topTenVolume?hour={hour}

  No documentation available.

• GET monitor/topTenAlerts

  No documentation available.

• GET monitor/topTenSqlAlerts

  No documentation available.

• GET monitor/topTenSqlMem?hour={hour}

  No documentation available.

• GET monitor/topTenSqlCpu?hour={hour}

  No documentation available.

• GET monitor/topTenIoStall?hour={hour}

  No documentation available.

• GET monitor/topTenSqlWaitStats?hour={hour}

  No documentation available.

• GET monitor/baseSqlInfo?sqlProfileId={sqlProfileId}&sqlInfoId={sqlInfoId}

  No documentation available.

• GET monitor/sqlTreeMap

  No documentation available.

• GET monitor/{id}/replicationDetails?groupId={groupId}

  Retrieves replication details for the specified SqlProfileId and GroupId

• GET monitor/{id}/testReplicationDetails?groupId={groupId}

  No documentation available.

• POST monitor/{id}/scheduleForRestart?machineId={machineId}

  No documentation available.

• GET monitor/{sqlProfileId}/compressionData

  No documentation available.

• GET api/Monitor?sqlProfileId={sqlProfileId}&startDate={startDate}&endDate={endDate}

  No documentation available.

• GET api/Monitor?sqlProfileId={sqlProfileId}&day={day}&startDate={startDate}&endDate={endDate}

  No documentation available.

• GET api/Monitor?sqlProfileId={sqlProfileId}&hour={hour}&startDate={startDate}&endDate={endDate}

  No documentation available.

• GET api/Monitor?sqlProfileId={sqlProfileId}&sqlHash={sqlHash}&day={day}&startDate={startDate}&endDate={endDate}

  No documentation available.

• GET api/Monitor?sqlProfileId={sqlProfileId}&sqlHash={sqlHash}&hour={hour}&startDate={startDate}&endDate={endDate}

  No documentation available.

• GET api/Monitor?sqlProfileId={sqlProfileId}&sqlHash={sqlHash}&planHash={planHash}

  No documentation available.

• POST api/Monitor

  No documentation available.

ProbeRules

Related to the probes used for monitoring Virtual Machine(s) and Services

• GET probe/sql

  Retrieves the current SQL Server Time

• GET probe

  Retrieves a list of all Probe Profiles for a specific customer / company

• GET probe/{profileId}

  Retrieves a Probe Profile with the specified ProfileId

• GET probe/checkTypes

  Retrieves a list of Probe Check Types for a specific customer / company

• GET probe/checkTypes/{checkTypeId}

  Retrieves a Probe Check Type with the specified CheckTypeId

• GET probe/alertProfiles/{alertProfileId}

  Retrieves an Alert Profile with the specified AlertProfileId

• GET probe/alertProfiles

  Retrieves a list of Alert Profiles for a specific customer / company

• GET probe/locations

  Retrieves a list of available Locations for Probe Profiles

• GET probe/locations/{locationId}

  Retrieves a Probe Location with the specified LocationId

• GET probe/results/{profileId}?startDate={startDate}&endDate={endDate}

  Retrieves the Probe Statistic Results with the specified ProfileId and StartDate

• POST probe

  Creates a new Probe Profile

• PUT probe

  Updates the specified Probe Profile

• DELETE probe/{profileId}

  Deletes the Probe Profile with the specified ProfileId

• GET probe/alertInfo/{incidentId}

  No documentation available.

Reporting

Retrieves reporting information that is collected by the Epic Monitor Agent

• GET reporting/groups

  Retrieves a list of all Node Groups

• GET reporting/{groupId}

  Retreives a Node Group with the specified GroupId

• DELETE reporting/{groupId}

  Deletes a Node Group with the specified GroupId

• PUT reporting/groups/{groupId}

  Edits the selected Node Group

• GET reporting/stats/{domainId}?startDateUtc={startDateUtc}

  Retrieves a list of Domain Zone Query Statistics with a specified DomainId and StartDate Get a domain zone query statistics

• GET reporting/registration/{nodeId}

  Retrieves a Registration Code with the specified NodeId

• GET reporting/nodes

  Retrieves a list of all available Nodes for a specific customer / company

• GET reporting/reports/offline

  Retrieves a list of Nodes that are currently offline

• GET reporting/reports/online

  Retrieves a list of Nodes that are currently online

• GET reporting/sqlMonitors

  No documentation available.

• GET reporting/sites

  Retrieves a list of all Sites for a specific customer / company

• GET reporting/sites/{siteId}

  Retrieves a Site with the specified SiteId

• GET reporting/sites/avaliableNodes

  Retrieves a list of all Nodes not attached to a Site

• GET reporting/sites/availableSqlProfiles

  No documentation available.

• PUT reporting/sites/{siteId}

  Updates the selected Site

• PUT reporting/saveDisabledAlerts

  No documentation available.

• POST reporting/sites

  Creates a new Site

• DELETE reporting/{siteId}

  Deletes the Site with the specified SiteId

• POST reporting/nodeandsqlsearch?input={input}

  Searches the list of Nodes adn Sql Profiles for the specified string

• POST reporting/nodesearch?input={input}

  Searches the list of Nodes for the specified string

• POST reporting/sqlServerSearch?input={input}

  No documentation available.

• POST reporting/enableAlerting?id={id}&profileType={profileType}

  No documentation available.

• GET reporting/healthOverview

  Retrieves the specified Node's Health Overview

• DELETE reporting/nodes/{nodeId}

  Deletes the Node with the specified NodeId

• GET reporting/sqlProfilById/{sqlProfileId}

  Retrieves a SQL Profile with the specified SqlProfileId

• GET reporting/recommendedAlerts

  No documentation available.

• POST reporting/addOrUpdateNodeSqlProfile

  Creates or updates SqlProfile

• POST reporting/enableAllAlerts

  No documentation available.

• POST reporting/extendAllAlerts

  No documentation available.

• POST reporting/ignoreRecommendedAlert?alertSourceId={alertSourceId}&resourceName={resourceName}

  No documentation available.

• POST api/Reporting?sqlProfileId={sqlProfileId}

  No documentation available.

ResourceBundle

Information related to Resource Bundles and the resources attached to them

• GET resourceBundles?warehouseId={warehouseId}

  Retrieves a list of all Resource Bundles with the specified WarehouseId

• GET resourceBundles/{bundleId}

  Retrieves a Resource Bundle with the specified BundleId

• GET resourceBundles/{bundleId}?warehouseId={warehouseId}

  Retrieves a list of all Templates that can be added to a Resource Bundle with the specified WarehouseId

• POST resourceBundles

  Used for a customer to purchase a Resource Bundle based on the currently available Resource Templates

• GET resourceBundles/{bundleId}/details

  Retrieves the Resource Bundle Details with the specified BundleId

StackpathSites

• DELETE api/StackpathSites?siteId={siteId}

  No documentation available.

• GET api/StackpathSites?siteId={siteId}&ruleId={ruleId}

  No documentation available.

• DELETE api/StackpathSites?siteId={siteId}&ruleId={ruleId}

  No documentation available.

• GET api/StackpathSites?siteId={siteId}&startDate={startDate}&endDate={endDate}

  No documentation available.

• DELETE api/StackpathSites

  No documentation available.

• DELETE api/StackpathSites?siteId={siteId}&certificateId={certificateId}

  No documentation available.

Support

Support content and sections

• GET support/sections

  Retrieves a list of all Support Sections for a specific customer / company

• GET support/contents

  Retrieves a list of all Support Content for a specific customer / company

• GET support/contents/{cultureCode}

  Retrieves a list of all Support Content with the specified CultureCode

• GET support/content/{sectionId}/{cultureCode}

  Retrieves a list of all Support Content with the specified SectionId and CultureCode

• GET support/topics/{cultureCode}

  Retrieves a list of topics with descriptions by culture code and organized by priority. Use content/{sectionId}/{cultureCode} to get specific support documentation.

Tickets

Retrieves and assigns information for tickets

• GET tickets

  Retrieves a list of all the Tickets associated with the specific customer / company

• GET tickets/{ticketId}

  Retrieves a Ticket with the specified TicketId

• POST tickets

  Creates a new Ticket

• POST tickets/CreateDetail

  Updates the selected Ticket Detail

• GET tickets/ticketAttachment/{ticketAttachmentId}

  Retrieves a Ticket Attachment with the specified TicketAttachmentId

UserDevice

Ability to view and modify registered mobile devices

• POST userdevices

  Registers and updates a User's Device to be used with push notification alerts

• GET userdevices

  Retrieves a list of all User Devices for a specified User

Users

Related to the creation, management, and removal of User profiles for your company

• GET users

  Retrieves a list of all users for a specific customer / company

• GET users/checkcustomercolotype

  No documentation available.

• GET users/user

  Retrieves the currently logged in User's information

• GET users/admins

  Retrieves a list of all Users with Administrative privileges

• PUT users/userName

  Updates a user's profile information

• GET users/uiculture

  Retrieves a list of all of the available User Interface Cultures

• GET users/{userId}

  Retrieves a User with the specified UserId

• POST users

  Creates a new User account and sends confirmation email for User to complete profile registration

• PUT users/editUser

  Edits the selected User

• GET users/userRole?userId={userId}

  Retrieves the Role of a User with the specified UserId

• GET users/roles

  Retrieves a list of available User Roles

• DELETE users/{userId}

  Deletes the selected User profile

• GET users/userCustomer

  No documentation available.

VirtualMachines

Displays information related to Virtual Machine(s)

• GET virtualmachines?includeDestroyed={includeDestroyed}

  Retrieves a list of all Virtual Machines for a specific customer / company

• GET virtualmachines/{vmId}

  Retrieves a Virtual Machine with the specified VirtualMachineId

• GET virtualmachines/{vmId}/warehouse

  Retrieves the Warehouse a Virtual Machine is in with the specified VirtualMachineId

• GET virtualmachines/warehouses

  Retrieves a list of all Warehouses for a specific customer / company

• POST virtualmachines

  Creates a new Virtual Machine

• POST virtualmachines/{vmId}/clone

  Clones the selected Virtual Machine

• PATCH virtualmachines/{vmId}/upgrade

  Upgrades the selected Virtual Machine

• GET virtualmachines/config?adapterId={adapterId}

  Retrieves a list of Virtual Machine Network Adapters with the specified AdapterId

• POST virtualmachines/editConfig

  Edits the selected Virtual Machine Network Adapter

• PATCH virtualmachines/virtualMachines/{vmId}/upgrade?memory={memory}&cpu={cpu}&bandwidthId={bandwidthId}&disk={disk}

  Upgrades the selected VirtualMachine with the specified VirtualMachineId, Memory, CPU, BandwidthId, and Disk

• GET virtualmachines/virtualMachines/{vmId}/getdescription

  Retreives a description of Virtual Machine

• POST virtualmachines/updatedescription

  Updates a description of Virtual Machine

• DELETE virtualmachines/{adapterId}?vmId={vmId}

  Deletes a Network Adapter with the specified VirtualMachineId and AdapterId

• GET virtualmachines/packages

  Retrieves a list of pre-defined hardware specification templates for creating a new Virtual Machine

• GET virtualmachines/images

  Retrieves a list of usable operating systems for installation onto a new Virtual Machine

• POST virtualmachines/{vmId}/actions/{type}

  Handles the dispatch of pre-defined actions with the specified VirtualMachineId and Type

• GET virtualmachines/{vmId}/console

  Retrieves the URL for a remote connection to a Virtual Machine with the specified VirtualMachineId

• DELETE virtualmachines/{vmId}

  Deletes a Virtual Machine with the specified VirtualMachineId

Vlan

Related to setting up and maintaining Virtual Local Area Networks

• GET vlans

  Retrieves a list of all Virtual LANs for a specific custoemr / company

• GET vlans/{vlanId}

  Retrieves a VLAN with the specified VlanId

• POST vlans

  Creates a new VLAN