API reference
22 API v6 endpoints, grouped by service. Each one explains what it does, who can call it, its limits and its errors, and you can try it from its page.
Base URL
https:
Authentication
Every request carries your API key in the Authorization: header. Without it, the API returns 401.
Before you start
Endpoints by service
Utilities (1 endpoints)
Diagnostic endpoints, available to any API key. Use them to verify your credentials are wired correctly.
Tools (2 endpoints)
General-purpose catalogs you can consume from your app. Available to any API key.
URL Shortener (11 endpoints)
Create and manage short links on your domains, and read their click analytics.
- POST
/Create a short linkPublish a short link with a generated code or your own alias. Charged on creation, unless your plan includes it.api/ v6/ urlshortener/ links - POST
/Create short links in bulkUp to 1,000 links in one request, with one result per link and a single charge for what was created.api/ v6/ urlshortener/ links/ batch - GET
/List short linksYour links, paginated, with search, filters, sorting and their visit counters.api/ v6/ urlshortener/ links - GET
/List available domainsDomains your organization can publish links on, with the default first.api/ v6/ urlshortener/ domains - GET
/Get a short linkOne of your links by domain and code.api/ v6/ urlshortener/ links/ {domain}/ {code} - PATCH
/Update a short linkChange the destination, the status or the expiry. Domain and code do not change.api/ v6/ urlshortener/ links/ {domain}/ {code} - DELETE
/Delete a short linkThe link stops redirecting and disappears from the API. Its code stays taken, and you can restore it for 90 days.api/ v6/ urlshortener/ links/ {domain}/ {code} - POST
/Restore a deleted linkBrings back a link of yours that you deleted, with the same code and no new charge.api/ v6/ urlshortener/ links/ {domain}/ {code}/ restore - GET
/Link statisticsRange totals, a daily or hourly series and breakdowns by country, device, OS, browser or source.api/ v6/ urlshortener/ links/ {domain}/ {code}/ stats - GET
/Organization overviewInventory, range activity against the previous period, trends, top links and breakdowns for your whole organization.api/ v6/ urlshortener/ overview - GET
/URL Shortener pricingWhat creating a link and each visit cost your organization, and whether its plan includes it.api/ v6/ urlshortener/ pricing
Storage (7 endpoints)
Read what your organization stores: usage, consumption, files, download links, retention and pricing. Read-only; storage never pauses.
- GET
/SummaryWhat your organization has stored now, the month so far and what is deleted soon.api/ v6/ storage/ summary - GET
/UsageSeries of the storage used (GB-months and cost) per day, month or hour.api/ v6/ storage/ usage - GET
/List filesYour organization’s files, newest first, paginated by cursor.api/ v6/ storage/ objects - GET
/Get a fileThe detail of a file of your organization.api/ v6/ storage/ objects/ {id} - GET
/Download linkA temporary link to download a file.api/ v6/ storage/ objects/ {id}/ download-url - GET
/RetentionHow long each file type is kept before it is deleted.api/ v6/ storage/ retention - GET
/Storage pricingThe price per GB-month applied to your organization today, and the next one if already set.api/ v6/ storage/ pricing
Organization (1 endpoints)
Organization profile, cost centers and users. Includes personal data.