POSTARYX

Authentication

Set up OAuth2 or API key authentication for the Postiz CLI

Authenticate using the device flow, no client ID or secret needed:

postiz auth:login

This will:

  1. Display a one-time code in your terminal
  2. Open your browser to authorize
  3. Automatically save credentials to ~/.postiz/credentials.json

Auth Commands

# Check current auth status (verifies credentials are still valid)
postiz auth:status

# Remove stored credentials
postiz auth:logout

API Key

Alternatively, set your Postiz API key as an environment variable:

export POSTIZ_API_KEY=your_api_key_here

You can get your API key from the Postiz Settings page.

OAuth2 credentials take priority over the API key when both are present.

Environment Variables

VariableRequiredDefaultDescription
POSTIZ_API_KEYNo*-Your Postiz API key
POSTIZ_API_URLNohttps://api.postiz.comCustom API endpoint (for self-hosted Postiz)
POSTIZ_AUTH_SERVERNohttps://cli-auth.postiz.comCustom auth server URL (for self-hosted auth server)

*Either OAuth2 (via postiz auth:login) or POSTIZ_API_KEY is required.

Self-hosting the auth server

postiz auth:login uses a hosted auth server by default, which works whether your Postiz is cloud or self-hosted. If you would rather run that piece yourself, see Self-hosting the CLI auth server.

Introduction

Automate social media posting from the command line with the Postiz CLI

Managing Posts

Create, list, and delete social media posts from the command line

On this page

OAuth2 (Recommended)Auth CommandsAPI KeyEnvironment VariablesSelf-hosting the auth server