API Key Auth

Path parameters

Plane Documentation

Discord

GitHub

x-api-key

Plane

Self-hosting

API Reference

Webhooks

Sign in

List projects

Self-hosting allows you to have full control over your applications and data. It’s a great way to ensure privacy, control, and customization.

Overview

Self-host Plane

Docker

Kubernetes

Database and storage

Configure external database and storage

Starting 0.14, we are introducing a new role for self-managed instances called `Instance admin`.

Instance admin and God mode

Plane offers several methods you can choose from to let your users log in to your Plane instance. Configure these methods in `Authentication` on `/god-mode` of your instance.

Google OAuth

Github OAuth

OIDC SSO

SAML SSO

Either during your set-up or sometime later, you will want to set SMTP settings to let your users get emails to reset passwords, onboard themselves right, and get notifications for changes, and receive exports of your data.

Communication

Email communication

Host your Plane instance in your custom domain. Our steps differ slightly depending on whether you are hosting on a public IP or a private/internal IP. Follow the steps listed below.

Brand instance

Users can reset their password through the terminal of the Plane application. You need to login to backend docker container and run the below command for resetting a user's password.

Reset password

Telemetry

Data collection and usage

Upgrade from Community

Upgrade from Community to Commercial Edition

Update Plane version

Prime CLI

View logs

View container logs

Community backup and restore

Backup and restore data on Community edition

The Plane API is organized around REST. Our API has predictable resource-oriented URLs, accepts application/json request bodies, returns JSON responses, and uses standard HTTP response codes, authentication, and verbs.

Introduction

Plane API Documentation

Projects let you manage teams and tasks within your Workspace.

Add project

Get project details

Update project details

Delete project

Add state

List states

Get state details

Update state details

Delete state

Add label

List labels

Get label details

Update label details

Delete label

Links can be added to an issue to point to some external resources

Add link

List links

Get link details

Update link details

Delete link

Inside an issue, you can add as many details as you like to get your work done.

Add issue

List issues

Get issue details

Update issue details

Delete issue

Issue activities are the history of all the changes that happened to the issue like property changes etc.

List issue activity

Get issue activity details

Add issue comment

List issue comments

Gets the details of a comment of an issue

Get issue comment details

Update issue comment details

Delete issue comment

Modules are smaller, focused projects that help you group and organize issues within a specific time frame. They allow you to break down your work into manageable chunks and track progress towards specific goals or objectives.

Add module

List modules

Get module details

Update module details

Delete module

It contains all the list of issues which are inside a module.

Add module issue

List module issues

Delete module issue

Add cycle

List cycles

Get cycle details

Update cycle details

Delete cycle

Add cycle issue

List cycle issues

Delete cycle issue

Add intake issue

List intake issues

Get intake issue detail

Update intake issue detail

Delete intake issue

A webhook triggers a HTTP POST request on the specified url, whenever there is a change in an event. Like a new project is created, updated or deleted then a webhook can be triggered to receive the required payload.

API Reference

​Path parameters

Path parameters