Develop & integrate

Drive Notploy from the API, CLI, SDK, MCP server, VS Code and your CI/CD pipelines.

Everything you can do in the dashboard is available to code. This section documents the interfaces Notploy exposes so deployments and operations can live inside your existing tooling rather than beside it.

Interfaces

CLI

Manage Notploy from the terminal.

API

The REST endpoints behind everything, with an OpenAPI reference.

SDK

TypeScript client for programmatic use.

MCP

Model Context Protocol server for AI-assisted tooling.

VS Code

Editor integration.

Integrations

Git providers and CI/CD workflows.

Concepts before endpoints

All interfaces speak the same model described in Core concepts: organizations, projects, environments, services and deployments. The API is the source of truth; the CLI, SDK and MCP server are thin clients over it.

Authentication

Programmatic access uses API keys (or tokens) scoped to a user or organization. The CLI and SDK authenticate with a key you generate in the dashboard. See API keys for creation, scope and handling.

Automation patterns

Deploy from CI — trigger a deployment when a branch is pushed, either through the provider webhook (auto-deploy), by calling the API from your pipeline, or with the official GitHub Actions action.
Preview environments — create temporary deployments per pull request. See Preview deployments.
Infrastructure as code — reconcile projects and services with the SDK or CLI.

Building on Notploy

Templates & examples — deployable blueprints.
Contributing — development environment and where to make changes.

Status of interfaces

The API and CLI are the most stable interfaces. The SDK mirrors the API. The MCP server and VS Code extension are integration surfaces whose contracts may evolve faster — check each page for its current status.