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
v8.0.6
v8.0.7
v8.0.8
Community
Website
Documentation
Exchange
Support
Developer
API Reference
Moon (Dark Mode)
Sun (Light Mode)
v8.0.8
Home
Guides
API Reference
Retrieves all Datastores for Specified Cloud
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
Create a Datastore for Specified Cloud
post
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
Retrieves all Datastores
get
Create a Datastore
post
Retrieves a Datastore
get
Updates a Specified Datastore
put
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
Snapshot a Host
put
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
