Jump to Content
Community
Website
Documentation
Exchange
Support
Developer
Home
Guides
API Reference
v5.5.1
v5.5.2
v5.5.3
v6.0.0
v6.0.1
v6.0.2
v6.0.3
v6.0.4
v6.0.5
v6.0.6
v6.0.7
v6.0.8
v6.0.9
v6.0.10
v6.0.11
v6.1.0
v6.1.1
v6.1.2
v6.2.0
v6.2.1
v6.2.2
v6.2.3
v6.2.4
v6.2.5
v6.2.6
v6.2.7
v6.2.8
v6.2.9
v6.2.10
v6.2.11
v6.3.0
v6.3.1
v6.3.2
v6.3.3
v6.3.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.9
v7.0.10
v7.0.11
v8.0-dev
v8.0.0
v8.0.1
v8.0.2
v8.0.3
v8.0.4
v8.0.5
Community
Website
Documentation
Exchange
Support
Developer
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v8.0.5
Home
Guides
API Reference
Deletes a Backup Job
Search
JUMP TO
Morpheus API
Activity
Retrieves Activity
get
Alerts
List All Alerts
get
Create a New Alert
post
Get a Specific Alert
get
Update Alert
put
Delete a Specific Alert
delete
Appliance Settings
Get Appliance Settings
get
Update Appliance Settings
put
Toggle Maintenance Mode
post
Reindex Search
post
Approvals
Retrieves a Specific Approval Item
get
Updates a Specific Approval Item
put
Retrieves all Approvals
get
Retrieves a Specific Approval
get
Apps
Get All Apps
get
Create an App
post
Get a Specific App
get
Updating an App
put
Delete an App
delete
Add Existing Instance to App
post
Apply State of an App
post
Undo Delete of an App
put
Prepare To Apply an App
get
Refresh State of an App
post
Remove Instance from App
post
Get Security Groups for an App
get
Set Security Groups for an App
post
Get State of an App
get
Validate Apply State for an App
post
Archives
Get All Archive Buckets
get
Create an Archive Bucket
post
Get a Specific Archive Bucket
get
Update an Archive Bucket
put
Delete an Archive Bucket
delete
Get All Archive Files
get
Upload Archive File
post
Download an Archive File
get
Get Archive File Details
get
Delete Archive File
delete
Get Archive File Links
get
Create an Archive File Link
post
Delete an Archive File Link
delete
Download a Public Archive File
get
Download an Archive File Link
get
Authentication
Reset user password
post
Request a reset password email
post
Retrieves information about current user roles and permissions
get
Provides authentication via username and password
post
Automation
Retrieves all Execute Schedules
get
Creates a Execute Schedule
post
Retrieves a Specific Execute Schedule
get
Updates a Execute Schedule
put
Deletes a Execute Schedule
delete
Executes an Execution Request
post
Retrieves a Specific Execution Request
get
Retrieves all Power Schedules
get
Creates a Power Schedule
post
Retrieves a Specific Power Schedule
get
Updates a Power Schedule
put
Deletes a Power Schedule
delete
Add Instances to a Power Schedule
put
Add Servers to a Power Schedule
put
Remove Instances from a Power Schedule
put
Remove Servers from a Power Schedule
put
Retrieves all Scale Thresholds
get
Creates a Scale Threshold
post
Retrieves a Specific Scale Threshold
get
Updates a Scale Threshold
put
Deletes a Scale Threshold
delete
Retrieves all Tasks
get
Creates a Task
post
Retrieves a Specific Task
get
Updates a Task
put
Deletes a Task
delete
Executes a Task
post
Retrieves all Workflows
get
Creates a Workflow
post
Retrieves a Specific Workflow
get
Updates a Workflow
put
Deletes a Workflow
delete
Executes a Workflow
post
Retrieves all Task Types
get
Retrieves a Specific Task Type
get
Backup Settings
Get Backup Settings
get
Update Backup Settings
put
Backups
Retrieves all Backups
get
Creates a Backup
post
Retrieves a Specific Backup
get
Updates a Backup
put
Deletes a Backup
delete
Executes a Backup
post
Retrieves all Backup Jobs
get
Creates a Backup Job
post
Retrieves a Specific Backup Job
get
Updates a Backup Job
put
Deletes a Backup Job
delete
Executes a Backup Job
post
Retrieves all Backup Results
get
Retrieves a Specific Backup Result
get
Deletes a Backup Result
delete
Retrieves all Backup Restores
get
Executes a Backup Restore
post
Retrieves a Specific Backup Restore
get
Deletes a Backup Restore
delete
Billing
Retrieves billing information for the requesting user's account.
get
This endpoint will retrieve a specific account by id if the user has permission to access it
get
Retrieves billing information for all instances on the requestor's account.
get
Retrieves billing information for an instance in the requestor's account. Use instanceUUID whenever possible.
get
Retrieves billing information for all servers (container hosts) on the requestor's account.
get
Retrieves billing information for a specific server (container host) in the requestor's account. Use refUUID whenever possible.
get
Retrieves billing information for all zones on the requestor's account.
get
Retrieves billing information for a specific zone in the requestor's account. Use zoneUUID whenever possible.
get
Blueprints
Get All Blueprints
get
Create a Blueprint
post
Get a Specific Blueprint
get
Updating a Blueprint
put
Delete a Blueprint
delete
Update Blueprint Image
post
Update Blueprint Permissions
put
Budgets
Retrieves all Budgets
get
Creates a Budget
post
Retrieves a Specific Budget
get
Updates a Budget
put
Deletes a Budget
delete
Catalog Items
Get All Catalog Item Types
get
Create a Catalog Item Type
post
Get a Specific Catalog Item Type
get
Update a Catalog Item Type
put
Delete a Catalog Item Type
delete
Update Logo For Catalog Item Type
put
Checks
List All Check Apps
get
Create a New Check App
post
Mute All Check Apps
put
Get a Specific Check App
get
Update Check App
put
Delete a Specific Check App
delete
Mute Check App
put
List All Checks
get
Create a New Check
post
Mute All Checks
put
Get a Specific Check
get
Updates a Check
put
Delete a Specific Check
delete
Mute Check
put
List All Check Types
get
Get a Specific Check Type
get
List All Check Groups
get
Create a New Check Group
post
Get a Specific Check Group
get
Update Check Group
put
Delete a Specific Check Group
delete
Mute Check Group
put
Mute All Check Groups
put
Clients
Get All Oauth Clients
get
Create an Oauth Client
post
Retrieves a Specific Oauth Client
get
Updates an Oauth Client
put
Deletes an Oauth Client
delete
Clouds
Retrieves all Cloud Types
get
Retrieves a Specific Cloud Type
get
Retrieves all Clouds
get
Creates a Cloud
post
Retrieves a Specific Cloud
get
Updates a Cloud
put
Deletes a Cloud
delete
Retrieves all Datastores for Specified Cloud
get
Retrieves a Datastore for Specified Cloud
get
Updates a Specified Datastore for Specified Cloud
put
Retrieves all resource folders for Specified Cloud
get
Retrieves a Resource Folder for Specified Cloud
get
Updates a Resource Folder for Specified Cloud
put
Retrieves all Resource Pools for Specified Cloud
get
Creates a Specified Resource Pool for Specified Cloud
post
Retrieves a Resource Pool for Specified Cloud
get
Updates a Specified Resource Pool for Specified Cloud
put
Deletes a Resource Pool for Specified Cloud
delete
Refreshes a Cloud
post
Update Logo For Cloud
post
Retrieves all Security Groups for a Cloud
get
Sets Security Groups for a Cloud
post
Cluster Layouts
Get All Cluster Layouts
get
Create a Cluster Layout
post
Get a Specific Cluster Layout
get
Update a Cluster Layout
put
Delete a Cluster Layout
delete
Clone a Cluster Layout
post
Cluster Packages
Get All Cluster Packages
get
Create a Cluster Package
post
Get a Specific Cluster Package
get
Update a Cluster Package
put
Delete a Cluster Package
delete
Clusters
Get All Cluster Types
get
Get All Clusters
get
Create a Cluster
post
Get a Specific Cluster
get
Update Cluster
put
Delete a Cluster
delete
Get API Config
get
Apply Template to Cluster (Kubernetes)
post
Get Containers for a Cluster
get
Get a Specific Cluster Container
get
Delete Container
delete
Restart a Container
put
Get Cluster Datastores
get
Create a Cluster Datastore
post
Get a Specific Cluster Datastore
get
Update Cluster Datastore
put
Delete a Cluster Datastore
delete
Get Deployments
get
Get a Specific Cluster Deployment
get
Delete Deployment
delete
Restart a Deployment
put
Get Cluster History
get
Get Cluster History Details
get
Get Cluster History Event
get
Get Jobs
get
Get a Specific Cluster Job
get
Delete a Job
delete
Get Masters (Kubernetes)
get
List Namespaces (Kubernetes)
get
Add Namespace (Kubernetes)
post
Get Namespace (Kubernetes)
get
Update Namespace (Kubernetes)
put
Delete a Namespace (Kubernetes)
delete
Update Cluster Permissions
put
Get Pods
get
Get a Specific Pod for a Cluster
get
Restart a Pod
put
Add Worker
post
Delete a Worker
delete
Get Services
get
Get a Specific Cluster Service
get
Delete a Service
delete
Get Stateful Sets
get
Get a Specific Cluster Statefulset
get
Delete a Stateful Set
delete
Restart a Stateful Set
put
Get Cluster Upgrade Versions (Kubernetes)
get
Upgrade a Cluster (Kubernetes)
post
Get Volumes
get
Get a Specific Cluster Volume
get
Delete a Volume
delete
Get Replicasets
get
Get a Specific Cluster Replicaset
get
Get Daemonsets
get
Get a Specific Cluster Daemonset
get
Get Endpoints
get
Get a Specific Cluster Endpoint
get
Get Ingresses
get
Get a Specific Cluster Ingress
get
Get Policies
get
Get a Specific Cluster Policy
get
Get VolumeClaims
get
Get a Specific Cluster VolumeClaim
get
Get Configmaps
get
Get a Specific Cluster Configmap
get
Get Secrets
get
Get a Specific Cluster Secret
get
Update Worker Count
put
Get Workers
get
Refreshes a Cluster
get
Contacts
List All Contacts
get
Create a New Contact
post
Get a Specific Contact
get
Update Contact
put
Delete a Specific Contact
delete
Containers
Get a Specific Container
get
Execute Container Action
put
List Container Actions
get
Clone Specific Container to Image
put
Eject a Specific Container
put
Import a Specific Container
put
Restart a Specific Container
put
Start a Specific Container
put
Stop a Specific Container
put
Suspend a Specific Container
put
Attach Floating IP to Container
put
Detach Floating IP from Container
put
Credentials
Get All Credential Types
get
Get a Specific Credential Type
get
Retrieves all Credentials
get
Creates a Credential
post
Retrieves a Specific Credential
get
Updates a Credential
put
Deletes a Credential
delete
Cypher
List Cypher Keys
get
Read or Create a Cypher Key
get
Write a Cypher
post
Delete a Cypher
delete
Datastores
Deployments
Get All Deployments
get
Create a new Deployment
post
Get a Specific Deployment
get
Updating a Deployment
put
Delete a Deployment
delete
Get All Versions For a Deployment
get
Create a new Deployment Version
post
Get a Specific Deployment Version
get
Updating a Deployment Version
put
Delete a Deployment Version
delete
List Deployment Files
get
Upload a Deployment File
post
Delete a Deployment File
delete
Deploys
Get all Deploys
get
Update a Deploy
put
Delete a Deploy
delete
Run a Deploy
post
Get all Deploys for an Instance
get
Deploy to an Instance
post
Email Templates
Retrieves all Email Templates
get
Creates an Email Template
post
Retrieves a Specific Email Template
get
Updates an Email Template
put
Deletes an Email Template
delete
Environments
List All Environments
get
Create a New Environment
post
Get a Specific Environment
get
Update Environment
put
Delete a Specific Environment
delete
Toggle Active State of Environment
put
Groups
Retrieves all Groups
get
Creates a Group
post
Retrieves a Specific Group
get
Updates a Group
put
Deletes a Group
delete
Updates a Group's Zones
put
Guidance
Retrieves all Guidance Recommendations
get
Retrieves a Specific Guidance Recommendation
get
Executes a Specific Guidance Recommendation
put
Ignores a Specific Guidance Recommendation
put
Retrieves Guidance Stats
get
Retrieves Guidance Types
get
Guidance Settings
Get Guidance Settings
get
Update Guidance Settings
put
Health
Retrieves Appliance Health
get
Retrieves Appliance Health Alarms
get
Acknowledge Many Health Alarms
put
Retrieves a Specific Appliance Health Alarm
get
Acknowledge a Health Alarm
put
Retrieves Appliance Health Logs
get
Export Appliance Health Logs
get
History
Retrieves Process History
get
Retrieves a Specific Process
get
Retry a Specific Process
post
Cancel a Specific Process
post
Hosts
Host Types
get
Get a Specific Host Type
get
Get All Hosts
get
Add a Baremetal Host
post
Get a Specific Host
get
Updating a Host
put
Delete a Host
delete
Assign To Tenant
put
Install Agent
put
Convert To Managed
put
Resize a Host
put
Get list of snapshots for a Host
get
Start a Host
put
Stop a Host
put
Restart a Host
put
Upgrade Agent
put
Run Workflow on a Host
put
Updating a label for a Server's Network
put
Enable Maintenance Mode
put
Leave Maintenance Mode
put
Manage Host Placement
put
Change Server Cloud
put
Get list of devices for a Host
get
Assign a Host Device
put
Detach a Host Device
put
Attach a Host Device
put
Get Available Service Plans for a Host
get
Identity Sources
Retrieves all Identity Sources
get
Creates an Identity Source
post
Retrieves a Specific Identity Source
get
Updates an Identity Source
put
Deletes an Identity Source
delete
Updates an Identity Source Subdomain
put
Image Builds
Boot Scripts
get
Create a Boot Script
post
Get a Specific Boot Script
get
Update a Boot Script
put
Delete a Boot Script
delete
Get All Image Builds
get
Create an Image Build
post
Get a Specific Image Build
get
Update an Image Build
put
Delete an Image Build
delete
List Image Build Executions
get
Run an Image Build
post
Preseed Scripts
get
Create a Preseed Script
post
Get a Specific Preseed Script
get
Update a Preseed Script
put
Delete a Preseed Script
delete
Incidents
List All Incidents
get
Create a New Incident
post
Get a Specific Incident
get
Update Incident
put
Close a Specific Incident
delete
Mute Incident
put
Reopen a Specific Incident
get
Mute All Incidents
put
Instances
Get All Instance Types for Provisioning
get
Get Specific Instance Type for Provisioning
get
Get All Instances
get
Create an Instance
post
Retrieves a Specific Instance
get
Updating an Instance
put
Delete an instance
delete
Execute Instance Action
put
List Instance Actions
get
Apply State of an Instance
post
Backup an instance
put
Get list of backups for an Instance
get
Cancel Expiration of an Instance
put
Cancel Removal of an Instance
put
Cancel Shutdown of an Instance
put
Clone to Image
put
Clone an Instance
put
Get Container Details
get
Delete All Snapshots of Instance
delete
Delete All Snapshots of Instance Container
delete
Eject an instance
put
Get Env Variables
get
Extend Expiration of an Instance
put
Extend Shutdown of an Instance
put
Get Instance History
get
Import Snapshot of an Instance
put
Create Linked Clone of Instance Snapshot
put
Lock an Instance
put
Updating a label for an Instance's Network
put
Prepare To Apply an Instance
get
Refresh State of an Instance
post
Resize an Instance
put
Restart an instance
put
Revert Instance to Snapshot
put
Get Security Groups for an Instance
get
Set Security Groups for an Instance
post
Snapshot an Instance
put
Get list of snapshots for an Instance
get
Start an instance
put
Get State of an Instance
get
Stop an instance
put
Suspend an instance
put
Get an Instance Scale Threshold
get
Updates an Instance Scale Threshold
put
Get all Instance Schedules
get
Create a new Instance Schedule
post
Get a Specific Instance Schedule
get
Updating an Instance Schedule
put
Deletes an Instance Schedule
delete
Unlock an Instance
put
Validate Apply State for an Instance
post
Run Workflow on an Instance
put
Remove From Control
delete
Get Available Service Plans for an Instance
get
Get Statistics for all Instances
get
Get a Specific Snapshot
get
Delete Snapshot of Instance
delete
Integrations
Retrieves all Integration Types
get
Retrieves a Specific Integration Type
get
Retrieves a Option Types for a Specific Integration Type
get
Retrieves all Integrations
get
Creates an Integration
post
Retrieves a Specific Integration
get
Updates an Integration
put
Deletes an Integration
delete
Refresh an Integration
post
Get ServiceNow Integration Objects
get
Creates an Exposed ServiceNow Catalog Item
post
Get a Specific ServiceNow Integration Object
get
Deletes a ServiceNow Integration object
delete
Get All Integration Inventory
get
Get a Specific Integration Inventory
get
Updating an Integration Inventory
put
Invoices
List All Invoice Line Items
get
Get a Specific Invoice Line Item
get
List All Invoices
get
Get a Specific Invoice
get
Update Invoice Tags
put
Jobs
Retrieves all Job Executions
get
Retrieves a Specific Job Execution
get
Retrieves a Specific Job Execution Event
get
Retrieves all Jobs
get
Creates a Job
post
Retrieves a Specific Job
get
Updates a Job
put
Deletes a Job
delete
Executes a Specific Job
put
Key Pairs
Creates a Key Pair
post
Generates a Key Pair
post
Retrieves a Specific Key Pair
get
Deletes a Key Pair
delete
Library
Get All Scripts
get
Create a Script
post
Get a Specific Script
get
Update a Script
put
Delete a Script
delete
Get All Node Types
get
Create a Node Type
post
Get a Specific Node Type
get
Update a Node Type
put
Delete a Node Type
delete
Get All File Templates
get
Create a File Template
post
Get a Specific File Template
get
Update a File Template
put
Delete a File Template
delete
Get All Instance Types
get
Create an Instance Type
post
Get a Specific Instance Type
get
Update an Instance Type
put
Delete an Instance Type
delete
Get All Layouts For an Instance Type
get
Create a Layout
post
Toggle Featured For Instance Type
put
Update Logo For Instance Type
post
Get All Layouts
get
Get a Specific Layout
get
Update a Layout
put
Delete a Layout
delete
Update Layout Permissions
post
Get All Option Lists
get
Create an Option List
post
Get a Specific Option List
get
Update an Option List
put
Delete an Option List
delete
List Items for a Specific Option List
get
Get All Inputs
get
Create an Input
post
Get A Specific Input
get
Update an Input
put
Delete an Input
delete
Get All Option Forms
get
Create an Option Form
post
Get a Specific Option Form
get
Update an Option Form
put
Delete an Option Form
delete
Get All Spec Templates
get
Create a Spec Template
post
Get a Specific Spec Template
get
Update a Spec Template
put
Delete a Spec Template
delete
Retrieves all Security Package Types
get
Retrieves a Specific Security Package Type
get
Deletes a Security Scan
delete
Retrieves all OsTypes
get
Create an OsType
post
Get an OsType
get
Update an OsType
put
Delete an OsType
delete
Get an OsTypeImage
get
Delete an OsTypeImage
delete
Create an OsTypeImage
post
Get List of Virtual Images
get
Create a Virtual Image
post
Get a Specific Virtual Image
get
Update a Virtual Image
put
Delete a Virtual Image
delete
Convert Virtual Image File
post
Remove Virtual Image File
delete
Get a List of Virtual Image Locations
get
Delete a Virtual Image Location
delete
Upload Virtual Image File
post
License
Get license
get
Install license key
post
Uninstall license key
delete
Test license key
post
Load Balancers
Get All Load Balancer Types
get
Get a Specific Load Balancer Type
get
Get All Load Balancers
get
Create a Load Balancer
post
Get a Specific Load Balancer
get
Update a Load Balancer
put
Delete a Load Balancer
delete
Get All Load Balancer Monitors For Load Balancer
get
Create a Load Balancer Monitor
post
Get a Specific Load Balancer Monitor
get
Update a Load Balancer Monitor
put
Delete a Load Balancer Monitor
delete
Get All Load Balancer Pools For Load Balancer
get
Create a Load Balancer Pool
post
Get a Specific Load Balancer Pool
get
Update a Load Balancer Pool
put
Delete a Load Balancer Pool
delete
Get All Load Balancer Profiles For Load Balancer
get
Create a Load Balancer Profile
post
Get a Specific Load Balancer Profile
get
Update a Load Balancer Profile
put
Delete a Load Balancer Profile
delete
Refresh a Load Balancer
put
Get All Load Balancer Virtual Servers For Load Balancer
get
Create a Load Balancer Virtual Server
post
Get a Specific Load Balancer Virtual Server
get
Update a Load Balancer Virtual Server
put
Delete a Load Balancer Virtual Server
delete
Get All Load Balancer Pool Nodes For Load Balancer Pool
get
Create a Load Balancer Pool Node
post
Get a Specific Load Balancer Pool Node
get
Update a Load Balancer Pool Node
put
Delete a Load Balancer Pool Node
delete
Log Settings
List All Log Settings
get
Update Log Settings
put
Create a New Syslog Rule
post
Delete a Specific Syslog Rule
delete
Logs
Retrieves Logs
get
Monitoring Settings
Get Monitoring Settings
get
Update Monitoring Settings
put
Networks
Network Types
get
Get a Specific Network Type
get
Get All Networks
get
Create a Network
post
Get a Specific Network
get
Update a Network
put
Delete a Network
delete
Get all Static Routes for a Network
get
Create a Network Static Route
put
Get a Static Route for a Network
get
Update a Network Static Route
put
Delete a Network Static Route
delete
Get Subnets for a Network
get
Get all Network Groups
get
Create a Network Group
post
Get a Specific Network Group
get
Update a Network Group
put
Delete a Network Group
delete
Get all Network Router Types
get
Get a Specific Network Router Type
get
Get all Network Routers
get
Create a Network Router
post
Get a Specific Network Router
get
Update a Network Router
put
Delete a Network Router
delete
Get all BGP Neighbors for Network Router
get
Create a Network Router BGP Neighbor
post
Get a Network Router BGP Neighbor
get
Update Network Router BGP Neighbor
put
Delete a Network Router BGP Neighbor
delete
Get all Firewall Rules for Network Router
get
Create a Network Router Firewall Rule
post
Get a Firewall Rule for Network Router
get
Update a Network Router Firewall Rule
put
Delete a Network Router Firewall Rule
delete
Get all Network Firewall Rule Groups for Network Router
get
Create a Network Router Firewall Rule Group
post
Get a Firewall Rule Group for Network Router
get
Update a Network Router Firewall Rule Group
put
Delete a Network Router firewall rule group
delete
Get all Network Router NATs for Network Router
get
Create a Network Router NAT
post
Get a Network Router NAT
get
Update Network Router NAT
put
Delete a Network Router NAT
delete
Update Network Router Permissions
put
Get all Routes for Network Router
get
Create a Network Router Route
post
Get a Route for Network Router
get
Delete a Network Router Route
delete
Get all Network Pools
get
Create a Network Pool
post
Get a Specific Network Pool
get
Update a Network Pool
put
Delete a Network Pool
delete
Get all IP Addresses for a Specific Network Pool
get
Create a Network Pool IP Address
post
Get a Specific IP Address for a Specific Network Pool
get
Delete a host record associated with an IP Address for a Specific Network Pool
delete
Get All Floating IPs
get
Get a Specific Floating IP
get
Release a Floating IP
put
Get all Network Domains
get
Create a Network Domain
post
Get a Specific Network Domain
get
Update a Network Domain
put
Delete a Network Domain
delete
Get all Network Proxies
get
Create a Network Proxy
post
Get a Specific Network Proxy
get
Update a Network Proxy
put
Delete a Network Proxy
delete
Get All Network Servers
get
Create a Network Server
post
Get a Specific Network Server
get
Update a Network Server
put
Delete a Network Server
delete
Refresh a Network Server/Integration
post
Get all Network DHCP Relays for Network Relay
get
Create a Network DHCP Relay
post
Get a Specific Network DHCP Relay
get
Update a Network DHCP Relay
put
Delete a Network DHCP Relay
delete
Get all Network DHCP Servers for Network Server
get
Create a Network DHCP Server
post
Get a Specific Network DHCP Server
get
Update a Network DHCP Server
put
Delete a Network DHCP Server
delete
Get all Network Edge Clusters for Network Server
get
Get a Specific Network Edge Cluster
get
Update a Network Edge Cluster
put
Get all Network Firewall Rules for Network Server
get
Create a Network Firewall Rule
post
Get a Specific Network Firewall Rule
get
Update a Network Firewall Rule
put
Delete a Network Firewall Rule
delete
Get all Network Firewall Rule Groups for Network Server
get
Create a Network Firewall Rule Group
post
Get a Specific Network Firewall Rule Group
get
Update a Network Firewall Rule Group
put
Delete a Network firewall rule group
delete
Get all Network Server Groups for Network Server
get
Create a Network Server Group
post
Get a specific Network Server Group
get
Update a Network Server Group
put
Delete a Network Server Group
delete
Get all Network Transport Zones for Network Server
get
Create a Network Transport Zone
post
Get a Specific Network Transport Zone
get
Update a Network Transport Zone
put
Delete a Network Transport Zone
delete
Get All Network Services
get
Get All Network Pool Servers
get
Create a Network Pool Server
post
Get a Specific Network Pool Server
get
Update a Network Pool Server
put
Delete a Network Pool Server
delete
Get All Network Pool Server Types
get
Retrieves a Specific Network Pool Server Type
get
Get All Subnet Types
get
Get All Subnets
get
Create a Subnet
post
Get a Specific Subnet
get
Update a Subnet
put
Delete a Subnet
delete
Options
Retrieves a list of Code/GIT Repositories
get
Get Option Source Data
get
Retrieves input option values
get
Retrieves network options by zone/cloud
get
Ping
Basic information about current Morpheus Installation
get
Plugins
Retrieves all Plugins
get
Upload Plugin
post
Retrieves a Specific Plugin
get
Updates a Plugin
put
Deletes a Plugin
delete
Policies
Retrieves all Policies
get
Creates a Policy
post
Retrieves a Specific Policy
get
Updates a Policy
put
Deletes a Policy
delete
Retrieves Policies for a Group
get
Creates a Policy for a Group
post
Retrieves a Specific Policy for a Group
get
Updates a Policy for a Group
put
Deletes a Policy for a Group
delete
Retrieves Policies for a Cloud
get
Creates a Policy for a Cloud
post
Retrieves a Specific Policy for a Cloud
get
Updates a Policy for a Cloud
put
Deletes a Policy for a Cloud
delete
Retrieves all Policy Types
get
Price Sets
Retrieves all Price Sets
get
Creates a Price Set
post
Retrieves a Specific Price Set
get
Updates a Price Set
put
Deactivates a Price Set
put
Prices
Retrieves all Prices
get
Creates a Price
post
Retrieves a Specific Price
get
Updates a Price
put
Deactivates a Price
put
Provisioning
Retrieves all Provision Types
get
Retrieves a Specific Provision Type
get
Provisioning Settings
Get Provisioning Settings
get
Update Provisioning Settings
put
Provisioning Licenses
Get All Licenses
get
Create a License
post
Get a Specific License
get
Update a License
put
Delete a License
delete
Get Reservations for Specific License
get
Reports
This endpoint retrieves all available report types
get
Returns all reports
get
Run specified report
post
This endpoint returns a specific report result
get
This endpoint will delete a report result
delete
Downloads a specific report result as a file attachment
get
Resource Pools
Get all Resource Pool Groups
get
Create a Resource Pool Group
post
Get a Specific Resource Pool Group
get
Update a Resource Pool Group
put
Delete a Resource Pool Group
delete
Roles
List roles
get
Create role
post
Get role
get
Update role
put
Delete role
delete
Customizing Blueprint Access
put
Customizing Catalog Item Type Access
put
Customizing Cloud Access
put
Customizing Group Access
put
Customizing Instance Type Access
put
Updating Role Permissions
put
Customizing Persona Access
put
Customizing Report Type Access
put
Customizing Task Access
put
Customizing Workflow Access
put
Customizing VDI Pool Access
put
Search
Provides global search for all types of objects
get
Security Groups
Retrieves all Security Groups
get
Creates a Security Group
post
Retrieves a Specific Security Group
get
Updating a Security Group
put
Deletes a Security Group
delete
Creates a Security Group Location
post
Deletes a Security Group Location
delete
Retrieves all Security Group Rules
get
Creates a Security Group Rule
post
Retrieves a Specific Security Group Rule
get
Updates a Security Group Rule
put
Deletes a Security Group Rule
delete
Security Packages
Retrieves all Security Packages
get
Creates a Security Package
post
Retrieves a Specific Security Package
get
Updates a Security Package
put
Deletes a Security Package
delete
Security Scans
Retrieves all Security Scans
get
Retrieves a Specific Security Scan
get
Service Catalog
Get Catalog Cart
get
Clear Catalog Cart
delete
Add Catalog Item to Cart
put
Remove a Catalog Item From Cart
delete
Checkout Catalog Cart
post
List Catalog Inventory Items
get
Get a Specific Catalog Inventory Item
get
Delete a Catalog Inventory Item
delete
Place Catalog Order
post
List Catalog Types
get
Get a Specific Catalog Type
get
Service Plans
Retrieves all Service Plans
get
Creates a Service Plan
post
Retrieves a Specific Service Plan
get
Updates a Service Plan
put
Deletes a Service Plan
delete
Activates a Service Plan
put
Deactivates a Service Plan
put
Setup
Setup appliance
post
SSL Certificates
Get All SSL Certificates
get
Create a Certificate
post
Get a Specific Certificate
get
Update a Certificate
put
Delete a Certificate
delete
Storage
Retrieves all Storage Buckets
get
Creates a Storage Bucket
post
Retrieves a Specific Storage Bucket
get
Updates a Storage Bucket
put
Deletes a Storage Bucket
delete
Retrieves all Storage Server Types
get
Retrieves a Specific Storage Server Type
get
Retrieves all Storage Servers
get
Creates a Storage Server
post
Retrieves a Specific Storage Server
get
Updates a Storage Server
put
Deletes a Storage Server
delete
Retrieves all Storage Volume Types
get
Retrieves a Specific Storage Volume Type
get
Retrieves all Storage Volumes
get
Creates a Storage Volume
post
Retrieves a Specific Storage Volume
get
Updates a Storage Volume
put
Deletes a Storage Volume
delete
Tenants
List All Tenants
get
Create a Tenant
post
List available roles for a tenant
get
Get tenant
get
Update tenant
put
Delete a Specific Tenant
delete
Get Subtenant Groups
get
Create a Group for Subtenant
post
Get a Specific Group for Subtenant
get
Updating a Group for Subtenant
put
Delete a Group for Subtenant
delete
Updating Group Zones for Subtenant
put
Create a User For a Tenant
post
Usage
Retrieves Usage Records
get
Users
User Settings
get
Update User Settings
put
Get Available API Clients
get
Update Avatar
post
Delete Avatar
delete
Revoke API Access Token
put
Update Desktop Background
post
Delete Desktop Background
delete
Regenerate API Access Token
put
List All Users
get
Create a New User
post
Get a Specific User
get
Update user
put
Delete a User
delete
Get a Specific User Permissions
get
List available roles for a user
get
VDI
Retrieves all VDI Apps
get
Creates a VDI App
post
Retrieves a Specific VDI App
get
Updates a VDI App Configuration or Icon
put
Deletes a VDI App
delete
Retrieves all VDI Gateways
get
Creates a VDI Gateway
post
Retrieves a Specific VDI Gateway
get
Updates a VDI Gateway Configuration
put
Deletes a VDI Gateway
delete
Retrieves all VDI Pools
get
Creates a VDI Pool
post
Retrieves a Specific VDI Pool
get
Updates a VDI Pool Configuration or Icon
put
Deletes a VDI Pool
delete
Retrieves all VDI Allocations
get
Retrieves a Specific VDI Allocation
get
List Virtual Desktops
get
Get a Specific Virtual Desktop
get
Allocate Virtual Desktop
post
Whitelabel Settings
Get Whitelabel Settings
get
Update Whitelabel Settings
put
Update Images
post
Download Image
get
Reset Image
delete
Wiki
Retrieves an App Wiki Page
get
Update an App Wiki Page
put
Retrieves a Cluster Wiki Page
get
Update a Cluster Wiki Page
put
Retrieves a Group Wiki Page
get
Update a Group Wiki Page
put
Retrieves an Instance Wiki Page
get
Update an Instance Wiki Page
put
Retrieves a Server Wiki Page
get
Update a Server Wiki Page
put
Retrieves all Wiki categories associated with the account
get
Retrieves wiki pages associated with the account.
get
Create a Wiki Page
post
Retrieves a specific Wiki page
get
Updates a Wiki Page
put
Deletes a Wiki Page
delete
Retrieves a Cloud Wiki Page
get
Update a Cloud Wiki Page
put
Powered by
Deletes a Backup Job
delete
https://{serverURL}/api/backups/jobs/
{id}
Deletes a specified backup job.
Language
Shell
Python
PowerShell
JavaScript
Go
Credentials
Bearer
Bearer
URL
Base URL
https://
CHANGEME
/api/backups/jobs/{id}
RESPONSE
Click
Try It!
to start a request and see the response here!