API Key Auth

Get module details

Path parameters

x-api-key

Plane

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

Plane's Editions

Understanding Plane's editions

Docker

Kubernetes

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

Instance admin and God mode

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.

Email

Email notifications

External database and storage

Configure external PostgreSQL, Redis and S3 storage

Host your Plane instance in your custom domain.

Custom domain

Private storage buckets

Switch from public to private buckets • Commercial Edition

External reverse proxy

Configure external reverse proxy

Telemetry

Data collection and usage

Upgrade to Commercial Edition

Upgrade from Community to Commercial Edition

Backup and restore

Backup and restore data

View logs

View container logs

Move to another server

Move your Plane instance to a new server • Commercial Edition

CLIs

Command line tools

Installation errors

License errors

CLI errors

Storage errors

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

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.

Webhooks

Plane Documentation

Discord

GitHub

Self-hosting

API Reference

Sign in

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

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

Configure GitHub App for Plane integration

Slack

Configure Slack App for Plane integration

GitLab

Configure GitLab Application for Plane integration

Update to latest version

Update Plane version

For versions before v0.14.0

Mandatory checkpoint at v0.14.0 • Community Edition

Projects let you manage teams and tasks within your Workspace.

Add project

List projects

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

Gets the details of an issue using the UUID

Get issue by UUID

Gets the details of an issue using the sequence id

Get issue by sequence ID

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

Provides a comprehensive suite of endpoints for adding, modifying, and deleting issue types within your project.

Lets you create custom issue types in your project.

Add issue type

Fetches all available issue types in your project.

List issue types

Retrieves details for a specific issue type using its unique ID.

Get issue type details

Allows you to modify an existing issue type.

Update issue type

Lets you to remove an existing issue type from your project.

Delete issue type

Offers a set of endpoints designed for adding, modifying, and deleting custom properties associated with issue types in your project.

Define additional attributes for an issue type in your project.

Add issue properties

Fetches all custom properties associated with a specific issue type in your project.

List issue properties

Retrieves detailed information about a specific custom property for an issue type in your project.

Get property details

Lets you modify existing properties for an issue type in your project.

Update issue properties

Remove specific custom properties from an issue type in your project.

Delete issue properties

Provides a set of endpoints for adding, modifying, and deleting options within the dropdown custom property types.

Allows you to define a list of options for the dropdown property type.

Add dropdown options

Retrieves all available options for a specific dropdown custom property.

List property options

Retrieves information about a specific option within a dropdown property.

Get option details

Lets you modify existing options within a dropdown property.

Update property options

Enables you to remove specific options from a dropdown custom property.

Delete property options

Provides a set of endpoints for adding, modifying, and deleting values within the Number custom property types.

Allows you to specify the values for a custom property.

Add property values

Fetches the values of the custom property.

List property values

Allows you to manage file attachments associated with issues and Intake issues. You can upload new attachments and retrieve existing attachments for a specific issue.

Get attachments

Creates a pre-signed POST form data for uploading an attachment directly to S3. This endpoint handles the first step of the two-and-a-half step upload process where you first get the upload credentials and then use them to upload the actual file.

Get upload credentials

Upload the file using the credentials generated by the [Get upload credentials](/api-reference/issue-attachments/get-upload-credentials) endpoint.

Upload file

Notifies the server that an attachment has been successfully uploaded to S3. This endpoint should be called after you've [uploaded the file](/api-reference/issue-attachments/upload-file).

Complete upload

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

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

Enables you to track time spent on issues within a project. Worklogs track duration in minutes and include details like description, timestamps, and user information.

Retrieve a list of worklogs for a specific issue.

Worklogs for an issue

Get worklogs for a specific issue

Aggregates the worklogs and provides the total time spent on each issue in the project.

Total logged time

Get total time for each issue

Add a new worklog entry for a specific issue.

Create Worklog

Update an existing worklog entry. You can change the description or duration of the worklog.

Update Worklog

Delete a specific worklog entry from an issue.

API Reference

​Path parameters

Path parameters