Blackoutly Console — organisation API

Let your own systems (Intune, scripts) see and remove Blackoutly activations of your organisation's computers.

API version 1.0.0 · base URL https://api.blackoutly.com · OpenAPI 3.1.0

Download the OpenAPI description (JSON) — for Swagger UI, Redoc, Postman

For Blackoutly Enterprise organisations. Typical use: when a computer is retired in Microsoft Intune, your script removes its Blackoutly activation, so the seat is free for another computer.

Tokens

The organisation's administrator creates a token at https://console.blackoutly.com/my → API for your systems:

• shown once (the console keeps only its SHA-256 hash) and starts with bo_;
• valid for 30, 90, 180 or 365 days — never more than a year; make a new one before it ends;
• may read only (GET /api/v1/org/devices) or read and remove activations (also POST /api/v1/org/remove);
• works only from the IP addresses / networks given for it (IPv4 or IPv6, at most 20; changeable without a new token);
• can be revoked at any time; at most 10 tokens an organisation.

Send it in the header Authorization: Bearer bo_… over HTTPS. No cookies are used or set.

Computers

A computer is named by its computer ID — 64 hexadecimal characters, the same the program shows in Settings → License and BlackoutlyCli.exe computer-id prints (short_id is its first 12 characters, as A1B2-C3D4-E5F6) — or, when removing, by its BIOS serial number (as Intune lists it). Computer names are never collected.

Log and limits

Every call — answered or refused — is kept for 90 days (time, token name, address, path, result, number of computers) and shown to the organisation's administrator at /my. At most 30 calls a minute from one address (then 429), at most 200 computers in one call.

Errors

An error answer is {"error": "<code>"}:

Endpoints

GET /api/v1/org/devices

The activated computers. Every computer of the organisation whose activation is counted now (removed ones are not listed). Needs a token that may read.

Example answer:

{
  "devices": [
    {
      "computer_id": "a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8f90",
      "short_id": "A1B2-C3D4-E5F6",
      "edition": "enterprise",
      "program": "0.0.10",
      "last_seen": "2026-10-20T08:14:03+00:00"
    }
  ]
}

Example call (PowerShell):

$h = @{ Authorization = "Bearer $env:BLACKOUTLY_TOKEN" }
Invoke-RestMethod https://api.blackoutly.com/api/v1/org/devices -Headers $h

POST /api/v1/org/remove

Remove activations. Removes the activations of these computers (by serial number or computer ID): their seats are free for other computers at once. Each computer learns it at its next weekly check-in and runs as Blackoutly Free from its next start; it does not activate itself again — someone presses Activate in Settings → License (if a seat is free). Needs a token that may remove activations.

Request body (JSON): RemoveRequest

{
  "computers": [
    "5CG1234XYZ",
    "a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8f90"
  ]
}

Example answer:

{
  "results": [
    {
      "computer": "5CG1234XYZ",
      "result": "removed"
    },
    {
      "computer": "a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8f90",
      "result": "not_activated"
    }
  ]
}

Example call (PowerShell):

$h = @{ Authorization = "Bearer $env:BLACKOUTLY_TOKEN" }
Invoke-RestMethod https://api.blackoutly.com/api/v1/org/remove -Method Post -Headers $h -ContentType application/json `
    -Body (@{ computers = @("5CG1234XYZ") } | ConvertTo-Json)

Data

Device

DevicesResponse

RemoveRequest

RemoveResult

RemoveResponse

Error