Platform API
Overview
AddOn
post Enable an AddOn for a stack item.
post Disable an AddOn for a stack item.
get Returns the stack item add-ons.
get Get New Relic application URL.
post Get an embedded chart URL.
get Get add-on list.
get Get add on details.
Application Templates
get Get a list of application templates.
Application
post Add (a) new application(s) to an existing environment.
post Clone an existing application.
post Launch an application
post Runs a scenario template on an application
post Stop an application
post Toggle application state
get Check if a user has access to an application.
delete Delete an existing application.
get Returns the details for a specific application.
post Update an existing application
get Get linked applications.
post Save the configuration data for an application.
get Validate an application: check if there are stack items, check for variations, check all metadata is present.
post Enable automatic deployments for an application.
post Disable automatic deployments for an application.
get Get automatic deployment status for an application.
post Launch Hyperlane application.
post Link applications.
ApplicationPath
post Add a new ApplicationPath.
delete Delete an ApplicationPath.
post Update an existing ApplicationPath.
post Toggle the HTTPS redirection.
EnvironmentUrl
post Add a new EnvironmentUrl.
delete Delete an existing EnvironmentUrl.
post Update an existing EnvironmentUrl.
post Add an environment URL.
post Toggle proxy mode for multiple Environment URLs.
delete Delete an environment URL.
post Update an environment URL.
post Activate Let's Encrypt.
post Save SSL certificate.
delete Delete active SSL certificate.
post Toggle proxy mode for an environment URL.
get List environment URLs.
Environment URL
post Activate Let's Encrypt for an existing environment URL.
User Access
post Eject a from an application.
post Update existing users on an application.
get Get application users
post Invite a user.
post Assign a team member to a project, environment or application.
post Update users on customer level.
post Remove a user from a customer.
post Remove user access.
post Resend invitation.
delete Revoke an unaccepted invitation.
get List available roles per level.
get List project access for user.
post Eject a from an environment.
post Update existing users on an environment.
get Get environment users
post Returns the list of project IDs the given user for a given customer has access to.
post Eject a user from a project.
post Update existing users on a project.
post Add existing users to a project.
get Check if a user has the required roles of a project.
get Get project users
Template Action
get Returns an empty TemplateAction page which includes: TemplateAction, availableHomes, metaData.
get Returns the list of available template actions.
Custom Action
get Returns the detail of a TemplateAction which includes: TemplateAction, availableHomes, metaData.
post Save a new or existing custom action.
delete Delete a custom action.
post Execute a custom action on a stack item.
Artifact
get Check if a user has access to an artifact.
get Returns a list of artifacts for a given application or stack item.
get Returns a list of artifacts.
get Returns a list of volumes available to create artifacts from.
post Create a new artifact based on the given criteria.
post Deploy an artifact.
post Deploy artifact volumes.
Backup
get Get a list of automated backups for a stack item ID.
post Restore an automated backup for a stack item.
post Execute a backup for a stack item.
get Get a list of backups.
get Get a list of backups for a stack item ID.
delete Delete a backup for a stack item.
post Restore a backup for a stack item.
post Unmount a mounted backup for a stack item.
BackupConfig
delete Delete backup config for a stack item.
get Get all backup configs for a stack item.
post Create backup config for a stack item.
Billing Profile
post Creates billing profile.
get Get billing profile balance.
get List billing profile account balances
get Get invoice
get Get billing profile invoices list.
get List invoices.
get List billing profiles.
get List payment methods.
get Get project usages.
get List transactions.
get Get billing profile detail.
post Creates a new billing profile.
get Get default billing profile.
get List project billing info
post Update project billing info
Payment method
post Create payment method
post Update payment method.
delete Delete payment method.
Blueprint
get List Blueprints
post Create a new Blueprint.
delete Delete a blueprint.
get Get a Blueprint.
post Update a Blueprint.
Cloudview
post Perform an action on a container
get Retrieve a list of inventory items
get Retrieve the cloud inventory summary counters
get Retrieve the details of an inventory item by its name
Component Category
get Get component category list.
get Get component category detail.
ComponentType
get Get component types list.
get Get the details for a specific component type.
Component
get Get component list.
get Get component detail.
get Get Custom Variation Baseline
get Get component variation list.
Environment
get Get container status.
post Add environment(s) to a project.
post Clone an environment.
get List environment names.
get List environment datacenter coordinates.
get List environment types.
delete Delete an existing environment.
get Get environment details.
post Update an existing environment.
post Clear Environment cache.
post Toggle proxy mode for the given Environment which will allow seamless enabling of various security features.
get Get shared stack items for environment.
get List environment URLs.
get Retrieve cost overview for an environment
post Get SLA related info.
Customer
get Get customer slug.
get Get the details of a team.
post Update the info of a team.
get Get customer users
Datacenter
get List available datacenters
get List available datacenters
Project Plan
post Update the plan for a project.
get Get project plan details.
Stack Item
get Get last backup metadata for a stack item.
Project
post Change project file transfer mode.
get List environments for a project.
get Project running scenarios.
post Creates a new project for a customer.
delete Delete an existing project.
get Returns the details for a specific project.
post Update an existing project.
get Returns the list of environments of a project.
post Fork a project into a new project.
get Get the permissions a user has for a given project drilled down to all the applications of the project.
get Get a list of usages.
get Get project list
post Get project list
get Get project properties
post Create, update or delete project properties
Addons
post Toggle addon on stack item.
post Refresh addon status between environments.
Hyperlane SFTP Users
get List SFTP users for an environment.
post Configure SFTP users for an environment.
Hyperlane Memory Boost
post Toggle debug mode for a stack item.
Help
post Send support request.
Scenario
get Returns a single completed or running scenario.
get Returns the list of completed scenarios.
get Returns the details of a running job.
get Returns the details of a finished job.
get Returns the list of completed child jobs.
get Returns the list of completed scenarios.
get Returns the list of completed scenarios.
get Returns the list of running scenarios of a given environment.
get List finished scenarios
get Returns the list of events that can be attached to a scenario.
post Persist one or more scenarios.
get Returns the list of available scenarios.
get Returns the details for a specific scenario.
delete Delete a scenario.
get Returns the workflow for a specific scenario.
post Send all the Action's of a Scenario to Torque.
post Cancel a running scenario.
post Save the target stack item of a scenario action.
post Generates a webhook token for a given scenario.
post Enables or disables the git deploy webhook for a scenario.
Kubernetes
get Retrieve supported Kubernetes versions
get Get kubernetes version
get Get kubernetes resources baseline
get Get Kubernetes variations for a version
get Retrieve Kubernetes clusters
post Create or validate a Kubernetes cluster
get Retrieve a Kubernetes cluster by ID
post Update or validate a Kubernetes cluster configuration
delete Delete a Kubernetes cluster
get Retrieve Kubernetes cluster configuration
get Get Kubernetes cluster hostnames
get Retrieve node pools for a Kubernetes cluster
post Enable HTTPS/SSL and launch a Kubernetes cluster
post Recycle nodes in a Kubernetes cluster
post Enable Let's Encrypt certificate for a hostnameId
post Upload SSL certificate for a hostname
delete Delete SSL certificate for a hostname
Metadata
get Get application metadata.
post Save application metadata.
get Get environment metadata.
post Save environment metadata.
post Reload application metadata.
post Reload environment metadata.
get Get stack item metadata.
post Update stack item metadata.
post Delete stack item metadata key.
Network
post Create a new network for an environment
Status
get Check the API status
Policy
get List all policies for registration.
get Get policy detail.
get List unsigned policies.
get List all policies.
post Sign a policy.
get Get policy detail.
Webhook
get Execute a webhook
post Execute a webhook
Provider
get Get the list of available providers
ProviderCredentials
get Get provider credentials list
post Create or update provider credentials
get Get required fields for provider credentials
get Get provider credentials by ID
delete Delete provider credentials by ID
Region
get Get the list of available regions
Scenario Action
get Get scenario action metadata.
post Save scenario action metadata.
Scheduler
post Create a new schedule.
get List all scheduled actions.
get List all schedules for a type.
get Get scheduling types.
delete Delete a schedule.
post Update a schedule.
Service
get Get service list.
get Get service detail.
post Enable service in environment.
post Disable service in environment.
Stack
post Add stack items
get Get stack item hierarchy
get Get stack item add-ons
get Get stack item
post Update stack item
StackItem
post Refresh SSH keys
get Verify stack item access
post Scale stack item
post Launch stack item
post Stop stack item
get Get platform variables
get Validate custom variation
get Get custom variation baseline
delete Delete stack item
Stack Item Service
post Toggle remote access
post Apply ports
post Create stack item service
post Update stack item service
delete Delete stack item service
Deploy Log
get List deploy logs
Stack Item Action
post Execute stack item action
Technology
get Get technology list.
VCS Host
post Create a new VCS Host.
get Get the list of VCS hosts.
get Get the list of VCS host providers.
delete Delete a VCS Host.
get Get a VCS Host.
post Update a VCS Host.
VCS Repository
post Create a new VCS repository.
post Get branches and tags for a VCS repository.
get Get a list of commits for a given application.
get Get the list of VCS repositories.
delete Delete a VCS repository.
get Get a VCS repository.
post Update a VCS repository.
Websocket
get Request a stream for a container.
get Request a stream for an environment.
Zone
get Get the list of available zones
Get Started
post Enable an AddOn for a stack item.