Create an instance

post

https://api.mamutecloud.com/app/instance

Creates an app or a managed database, depending on the product. The response comes back immediately with status: provisioning; provisioning continues in the background and status_reason names the step if it fails.

A managed database returns its password once here, in app_credentials, and never again. It also needs firewall_rules: the engine port stays closed until an address is allowed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

One of product, docker_image, source_s3_key or git is required, and so is size.

name

string

required

product

string

Marketplace product name, e.g. wordpress, postgresql, mysql.

docker_image

string

Public image, or private with registry_auth.

source_s3_key

string

Bundle uploaded through POST /app/deploy/upload.

git

object

Deploy from a connected git repository.

size

string

enum

tier

string

enum

deprecated

Allowed:

dedicated

boolean

Defaults to false

A machine of its own, filled entirely by this instance. Required for port ranges, priced separately because it costs the whole machine, and refused for a managed database.

port_ranges

array of objects

port_ranges

region

string

container_port

integer

health_check_path

string

environment_variables

object

custom_domain

string

registry_auth

object

Credentials for a private registry. Stored encrypted.

firewall_rules

array of objects

firewall_rules

backup_enabled

boolean

backup_frequency_days

integer

backup_retention_days

integer

Responses

400

Invalid size, invalid firewall rule, or a database size on an app product

401

Authentication required

402

Refused by billing: no balance, or no price configured for the size in this environment

403

Insufficient balance. Trial balance cannot be used for app instances.

201Created