Contact Support

Changelog

Trust Center

Aptible

Documentation

Guides

Sign up

Log in

Browse the commands available through the Aptible CLI

All CLI Commands

A Platform as a Service (PaaS) that gives startups everything developers need to launch and scale apps and databases that are secure, reliable, and compliant — no manual configuration required.

Home

Aptible Documentation

Learn what Aptible is and why scaling companies use it to host their apps and data in the cloud

Introduction to Aptible

Overview

Deploy a starter template

Deploy a starter template Ruby on Rails app on Aptible

Ruby on Rails

Ruby on Rails - Starter Template

Deploy a starter template Node.js app using the Express framework on Aptible

Node.js + Express

Node.js + Express - Starter Template

Deploy a starter template Python app using the Django framework on Aptible

Python + Django

Python + Django - Starter Template

Deploy a starter template PHP app using the Laravel framework on Aptible

PHP + Laravel

PHP + Laravel - Starter Template

Deploy our Python demo app using the Flask framework with Managed PostgreSQL Database and Redis instance

Python + Flask

Python + Flask - Demo App

Learn how to deploy your custom code on Aptible

Deploy your custom code

Learn how Aptible streamlines app deployment, allowing developers to effortlessly push code in seconds

Apps - Overview

Managing Apps

Learn about Aptible Managed Databases that automate provisioning, maintenance, and scaling

Managed Databases - Overview

Learn about provisioning Managed Databases on Aptible

Provisioning Databases

Learn about the key components of the Aptible platform architecture and how they work together to help you deploy and manage your resources

Architecture - Overview

Learn about using Stacks to deploy resources to various regions

Stacks

Learn about grouping resources with environments

Environments

Learn more about operations work on Aptible - with minimal downtime and rollbacks

Operations

Learn about how Aptible simplifies infrastructure maintenance

Maintenance

Reliability Division of Responsibilities

Learn more about scaling on-demand without worrying about any underlying configurations or capacity availability

Scaling - Overview

Learn about scaling Apps CPU, RAM, and containers - manually or automatically

App Scaling

Learn about scaling Databases CPU, RAM, IOPS and throughput

Database Scaling

Learn about using Container Profiles to optimize spend and performance

Container Profiles

CPU Allocation

Learn how Aptible enforces memory limits to ensure predictable performance

Memory Management

Learn about observability features on Aptible to help you monitor, analyze and manange your Apps and Databases

Observability - Overview

Learn about tracking changes to your resources with Activity

Activity

Sources

Learn how Aptible enables dev teams to meet regulatory compliance requirements (HIPAA, HITRUST, SOC 2, PCI) and pass security audits

Security & Compliance - Overview

Roles & Permissions

Learn about application vulnerability scanning provided by Aptible

Security Scans

Learn how Aptible automatically provides DDoS Protection

DDoS Protection

Managed Host Intrusion Detection (HIDS)

Explore all integrations and tools used with Aptible

All Integrations and Tools

Learn about using the Datadog Integration for logging and monitoring

Datadog Integration

Learn about using the Entitle integration for just-in-time access to Aptible resources

Entitle Integration

Learn about sending Aptible logs to Mezmo

Mezmo Integration

Network Integrations: VPC Peering & VPN Tunnels

Learn about sending Aptible logs to Sumo Logic

Sumo Logic Integration

Learn how to integrate Twingate with your Aptible account

Twingate Integration

Learn how manage billing & payments within Aptible

Billing & Payments

Pricing

Learn more about using the Aptible CLI for managing resources

Aptible CLI - Overview

The Aptible CLI provides configuration options such as MFA support, customizing output format, and overriding configuration location.

CLI Configurations

Learn about navigating the Aptible Dashboard

Dashboard

Terraform

Metadata Variables

Aptible Metadata Variables

Interface Feature Availability Matrix

Glossary

Explore guides for using the Aptible platform

Browse Guides

Explore guides for deploying and managing Apps on Aptible

All App Guides

How to create an app

How to scale apps and services

How to set and modify configuration variables

How to deploy to Aptible with CI/CD

How to define services

Learn how to deploy your code to Aptible from a Docker Image

How to deploy via Docker Image

Guide for deploying from Git using Dockerfile Deploy

How to deploy from Git

Guide for migrating from deploying via Docker Image to deploying via Git

How to migrate from deploying via Docker Image to deploying via Git

Horizontal Autoscaling Guide

How to synchronize configuration and code changes

How to migrate from Dockerfile Deploy to Direct Docker Image Deploy

Deploy Metric Drain with Terraform

Getting Started with Docker

How to access configuration variables during Docker build

Guide for migrating a NodeJS app from Heroku to Aptible

How to migrate a NodeJS app from Heroku to Aptible

How to generate certificate signing requests

How to expose a web app to the Internet

How to use Nginx with Aptible Endpoints

How to make Dockerfile Deploys faster

Learn how to connect your app to S3 to accept file uploads

How to use S3 to accept file uploads

Learn how to use cron to run and automate scheduled tasks on Aptible

How to use cron to run scheduled tasks

How to serve static assets

Client certificate authentication, also known as two-way SSL authentication, is a form of mutual Transport Layer Security(TLS) authentication that involves both the server and the client in the authentication process. Users and the third party they are working with need to establish, own, and manage this type of authentication.

How to establish client certificate authentication

Explore guides for deploying and managing databases on Aptible

All Database Guides

Learn how to configure PostgreSQL Databases on Aptible

How to configure Aptible PostgreSQL Databases

Learn how to connect Fivetran with your Aptible Databases

How to connect Fivetran with your Aptible databases

How to scale databases

Automate Database migrations

Upgrade PostgreSQL with logical replication

Dump and restore PostgreSQL

The goal of this guide is to test the schema of an existing Database against another Database version in order to see if it's compatible with the desired version. The primary reason to do this is to ensure a Database's schema is compatible with a higher version before upgrading.

Test a PostgreSQL Database's schema on a new version

Dump and restore MySQL

Use mysqldump to test for upgrade incompatibilities

Upgrade MongoDB

Upgrade Redis

Explore guides for enhancing observability on Aptible

All Observability Guides

For all operations performed, Aptible collects operation logs. These logs are retained only for active resources and can be viewed in the following ways.

How to access operation logs

How to export Activity Reports

Guide for setting up Datadog Application Performance Monitoring (APM) on your Aptible apps

How to set up Datadog APM

Learn how to set up application performance monitoring

How to set up application performance monitoring

Learn how to deploy and use Aptible-hosted analytics and monitoring with Grafana

How to deploy and use Grafana

This guide will walk you through setting up a self-hosted Elasticsearch - Logstash - Kibana (ELK) stack on Aptible.

How to set up a self-hosted Elasticsearch Log Drain with Logstash and Kibana (ELK)

How to set up Elasticsearch Log Rotation

Learn how to set up a PaperTrail Log Drain on Aptible

How to set up a Papertrail Log Drain

How to set up a self-hosted HTTPS Log Drain

How to set up Kibana on Aptible

Explore guides for using the Aptible Platform

Platform Guides

Learn how to migrate resources from MedStack to Aptible

MedStack Migration Guide

MedStack to Aptible Migration Guide

Learn how to achieve HIPAA compliance on Aptible, the leading platform for hosting HIPAA-compliant apps & databases

How to achieve HIPAA compliance on Aptible

Learn how to create and deprovision dedicated stacks

How to create and deprovison dedicated stacks

How to create environments

How to delete environments

How to deprovision resources

How to handle vulnerabilities found in security scans

How to migrate environments

Learn how to approach responding to security questionnaires and audits on Aptible

How to navigate security questionnaires and audits

How to restore resources

Learn how to upgrade and downgrade your Aptible plan

How to upgrade or downgrade my plan

To use SSO, you must configure both the SSO provider and Aptible with metadata related to the SAML protocol. This documentation covers the process in general terms applicable to any SSO provider. Then, it covers in detail the setup process in Okta.

How to set up Single Sign On (SSO)

This guide provides detailed instructions on how to set up a custom SAML application in Auth0 for integration with Aptible.

How to Set Up Single Sign-On (SSO) for Auth0

Aptible supports SCIM 2.0 provisioning through Okta using the Aptible SCIM integration. This setup enables you to automate user provisioning and de-provisioning for your organization.

Provisioning with Okta (SCIM)

Aptible supports SCIM 2.0 provisioning through Entra Identity using the Aptible SCIM integration. This setup enables you to automate user provisioning and de-provisioning for your organization.

Provisioning with Entra Identity (SCIM)

Learn how to deploy your infrastructure with best practices for setting up your Aptible account

Best Practices Guide

Learn how to take your infrastructure to the next level with advanced best practices

Getting Started

Core Concepts

Reference

All CLI Commands