Cloakup API

Introduction

Programmatic access to Cloakup campaigns and domains

The Cloakup API lets you manage campaigns and domains with API keys. All public endpoints live under /v1 on https://api.cloakup.me.

Quickstart

Create a key, send your first request, and follow the recommended workflow.

Authentication

API key format, scopes, rate limits, and prerequisites.

Campaigns API

List, create, update, clone, and toggle campaigns.

Domains API

Register, verify, list, and delete domains.

Base URL

https://api.cloakup.me

No trailing slash. Set CLOAKUP_API_URL in clients and scripts.

Use with AI

Each page has Copy page, View as Markdown, Open in ChatGPT, and Open in Claude. ChatGPT and Claude fetch the public Markdown URL, so this works after the docs are deployed.

You can also load Markdown directly:

What you need

  1. A Cloakup plan with API keys enabled
  2. An API key created in Settings → API Keys in the dashboard
  3. A key with the right scopes for each endpoint

API keys are shown only once at creation. Store them securely. Revoked or expired keys return 401.

  1. Register a domain: POST /v1/domains → PATCH /v1/domains/:id/verify until verified: true
  2. Create a campaign with the minimal example — keep deny_always: false or omit it
  3. Confirm with GET /v1/campaigns/:id or list (in_review must be false for production)

Read Production safety before creating campaigns. Wrong defaults can send all traffic to the safe page.

Quickstart

From API key to your first authenticated request

On this page

Base URLUse with AIWhat you needRecommended workflow