Short.io

Removes a hostname from the domain's allowed-hostnames list. via DELETE /domains/allowedHostnames/{domainId}

Deletes DNS records of the given name and type. Omit `value` to remove every matching record. via DELETE /domains/dnsRecord

Deletes the domain's favicon. via DELETE /domains/favicon/{domainId}

Removes the domain from the current user's favorites. via DELETE /domains/favorite/{domainId}

Removes an IP address from the domain's exclusion list. via DELETE /domains/ipExclusions/{domainId}

Removes the domain's link-signature key (sets it to null), disabling redirect URL signing for the domain. via DELETE /domains/link-signature-key/{domainId}

Deletes the domain's QR code settings, reverting to defaults. via DELETE /domains/qrCodeSettings/{domainId}

Disables daily S3 click export for the domain. via DELETE /domains/s3exports/{domainId}

Deletes theme settings for the domain, reverting it to the default theme. via DELETE /domains/theme/{domainId}

Delete link country via DELETE /link_country/{linkId}/{country}

Delete link region by country via DELETE /link_region/{linkId}/{country}/{region}

Delete links of a domain within a created-at date interval. Provide any combination of bounds (at least one is required): - `createdAfter` / `createdBefore`: Unix timestamps in milliseconds - `days`: relative upper bound (delete links older than N days) Optionally restrict deletion to links whose `conditionalColumn` matches `conditionalMatch`. Deletion runs asynchronously. via DELETE /links

Deletes a bundle by ULID id via DELETE /links/bundle/{id}

Removes a link from a bundle by its link template ID via DELETE /links/bundle/{id}/links/{linkTemplateId}

Delete link by id **Rate limit**: 20/s via DELETE /links/{link_id}

Delete links in bulk by ids **Rate limit**: 1/s via DELETE /links/delete_bulk

Delete link permissions via DELETE /links/permissions/{domainId}/{linkId}/{userId}

Delete post via DELETE /links/post/{id}

Revoke a hosted QR code via DELETE /links/qr/hosted/{id}

Shows all domains of current user via GET /api/domains

Get domain links via GET /api/links

Lists audit log entries for a team or a domain. via GET /audit

Returns the domain's allowed-hostnames list. via GET /domains/allowedHostnames/{domainId}

Get domain details by id via GET /domains/{domainId}

Returns the customer-managed DNS records for a domain registered through Short.io. via GET /domains/dnsRecord

Returns the custom CSS applied to the domain's password prompt page. via GET /domains/password/{domainId}

Returns the default QR code settings applied to the domain's links. via GET /domains/qrCodeSettings/{domainId}

Returns the S3 click-export configuration and status for the domain. via GET /domains/s3exports/{domainId}

Returns theme settings for the domain. via GET /domains/theme/{domainId}

Returns the iOS/Android universal-link (app association) configuration for the domain. via GET /domains/universalLinks/{domainId}

Get link countries via GET /link_country/{linkId}

Get link regions via GET /link_region/{linkId}

Get all regions by country via GET /link_region/list/{country}

Returns bundle details by ULID id via GET /links/bundle/{id}

Returns all links in a bundle, ordered by sort order via GET /links/bundle/{id}/links

Returns all available bundle templates via GET /links/bundle/templates

Get link info by link id. Rate limit: 20/s via GET /links/{linkId}

**DEPRECATED** Get link info by original URL. Returns 404 if the domain does not exist in your organization. Rate limit: 20/s via GET /links/by-original-url

Get link info by path. Returns 404 if the domain does not exist in your organization. Rate limit: 20/s via GET /links/expand

Get links folders for the specified domain id via GET /links/folders/{domainId}

Get links folder for the specified domain id and user id via GET /links/folders/{domainId}/{folderId}

Returns all links with the same original URL. Returns 404 if the domain does not exist in your organization. via GET /links/multiple-by-url

Get link opengraph properties via GET /links/opengraph/{domainId}/{linkId}

Get link permissions via GET /links/permissions/{domainId}/{linkId}

Get post by ID via GET /links/post/{id}

List hosted QR codes via GET /links/qr/hosted

Simple version of link create endpoint. You can use it if you can not use POST method Returns 404 if the domain does not exist in your organization. **Rate limit**: 50/s via GET /links/tweetbot

Returns the organization's plan tier and billing period alongside its current usage counters: domain and link counts, paid link count, AI spend in microdollars, stored bytes, and remaining Pro/Team trial days. via GET /organizations/{organizationId}/planInfo

List the tags used across a domain via GET /tags/{domainId}

Get the most popular tags in a domain via GET /tags/{domainId}/popular

Updates the sort order of links in a bundle via PATCH /links/bundle/{id}/links

Create a domain via POST /domains

Adds a hostname to the domain's allowed-hostnames list. via POST /domains/allowedHostnames/{domainId}

Creates one or more DNS records for a domain registered through Short.io. via POST /domains/dnsRecord

Marks the domain as a favorite for the current user. via POST /domains/favorite/{domainId}

Adds an IP address to the domain's exclusion list, so clicks from it are not counted. via POST /domains/ipExclusions/{domainId}

Generates a new per-domain HMAC secret used by the redirector to sign redirect destination URLs, and returns it. Regenerating invalidates the previous key. via POST /domains/link-signature-key/{domainId}

Sets the custom CSS applied to the domain's password prompt page. via POST /domains/password/{domainId}

Creates or updates the default QR code settings applied to the domain's links. via POST /domains/qrCodeSettings/{domainId}

Enables daily S3 click export for the domain. via POST /domains/s3exports/{domainId}

Update domain settings via POST /domains/settings/{domainId}

Creates or updates theme settings for the domain. Colors are 6- or 8-character hex strings without the leading `#` (RRGGBB, or RRGGBBAA for transparency). via POST /domains/theme/{domainId}

Creates or updates the iOS/Android universal-link (app association) configuration for the domain. via POST /domains/universalLinks/{domainId}

Create link countries in bulk via POST /link_country/bulk/{linkId}

Create link country via POST /link_country/{linkId}

Create link regions in bulk via POST /link_region/bulk/{linkId}

Add region targeting to link via POST /link_region/{linkId}

This method creates a new link. If parameter "path" is omitted, it generates path by algorithm, chosen in domain settings. Notes: 1. If URL with a given path already exists and originalURL of the URL in database is equal to originalURL argument, it returns information about existing URL 2. If URL with a given path already exists and originalURL is different from originalURL in database, it returns error with a status `409` 3. If URL with a given originalURL exists, and no path is given, it returns information about existing URL and does not create anything 4. If URL with a given originalURL exists, and custom path is given, it creates a new short URL Returns 404 if the domain does not exist in your organization. **Rate limit**: 50/s via POST /links

Archive link via POST /links/archive

Archive links in bulk via POST /links/archive_bulk

Please use this method if you need to create big packs of links. It accepts up to 1000 links in one API call. It works almost the same as single link creation endpoint, but accepts an array of URLs and returns an array of responses. Returns list of Link objects. If any URL is failed to insert, it returns error object instead as array element. Method is not transactional – it can insert some links from the list and return an error for others. Returns 404 if the domain does not exist in your organization. **Rate limit**: 5 queries in 10 seconds via POST /links/bulk

Creates a new link bundle with customizable template, social media links, and branding via POST /links/bundle

Adds a short link to a bundle. If the link doesn't exist, it will be created. via POST /links/bundle/{id}/links

Update original url, title or path for existing URL by id **Rate limit**: 20/s via POST /links/{linkId}

NOT CALLABLE ON THIS CONNECTION -- refused by name; see the error for the reason. Fetch and inspect deep link configuration for a URL (public, hCaptcha-protected) via POST /links/deeplinks/debug

Creates a set of demo/example links to showcase various features of the short link service. Example links include: - A/B testing with split URLs - Mobile targeting (different URLs for Android/iPhone) - Expiring links with time limits - File download links - Password-protected links Returns 404 if the domain does not exist in your organization. **Rate limit**: 5/10s via POST /links/examples

Create a new folder via POST /links/folders

NOT CALLABLE ON THIS CONNECTION -- refused by name; see the error for the reason. Fetch and inspect OpenGraph tags for a URL (public, hCaptcha-protected) via POST /links/opengraph/debug

Add link permission via POST /links/permissions/{domainId}/{linkId}/{userId}

Creates a content page rendered at a short link via POST /links/post

NOT CALLABLE ON THIS CONNECTION -- refused by name; see the error for the reason. This method creates a new link. Only this method should be used in client-side applications If parameter "path" is omitted, it generates path by algorithm, chosen in domain settings. You can use it with public API key in your frontend applications (client-side javascript, Android & iPhone apps) **Rate limit**: 50/s via POST /links/public

Generate QR code for the link via POST /links/qr/{linkIdString}

Generate an AI QR code for the link via POST /links/qr/{linkIdString}/ai

Generate a hosted QR code for the link via POST /links/qr/{linkIdString}/hosted

Unarchive link via POST /links/unarchive

Unarchive links in bulk via POST /links/unarchive_bulk

Append a single tag to the links in bulk via POST /tags/bulk

Updates bundle details, social media links, and branding via PUT /links/bundle/{id}

Set link opengraph properties via PUT /links/opengraph/{domainId}/{linkId}

Update post via PUT /links/post/{id}