Shlink

Shlink is a self‑hosted, PHP‑based URL shortener that provides a RESTful API, a command‑line interface, and Docker images for easy deployment. It enables users to create and manage short URLs under their own domain, supports custom domains, tagging, visit tracking, redirect rules, and integrates with services like Mercure for real‑time updates. The open‑source project is actively maintained and documented at shlink.io.

Shlink publishes 8 API contracts indexed on the APIs.io network, including Domains API, Integrations API, Monitoring API, and 5 more. Tagged areas include Company, URL-Shortener, PHP, Self-Hosted, and Open-Source.

The Shlink catalog on APIs.io includes 1 Spectral governance ruleset.

Shlink’s developer surface includes changelog, authentication, documentation, and 13 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

30.7/100 thin Agent 29/100 agent ready Full breakdown ↓
scored 2026-10-31 · rubric v0.25.0 · Show this score on your site →

1 published contract 1 Agent Skills

CompanyURL-ShortenerPHP Self-HostedOpen-SourceREST-API

Kin Score

Kin Score How this is scored →
scored 2026-10-31 · rubric v0.25.0

Composite quality — 30.7/100 · thin

Contract Quality 9.8 / 21

Developer Ergonomics 6.0 / 17

Access Clarity 0.0 / 17

Operational Transparency 1.7 / 11

Contract Governance 2.2 / 10

Discoverability 4.9 / 9

Regulatory Posture 4.0 / 15

Agent readiness — 29/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 0 / 6

Agent Skills 5 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics could not be measured. We hold no machine-readable contract for this provider to read, so there is nothing to measure a write surface against. Excluded rather than scored zero: never-measured and measured-empty are different facts. Publishing an OpenAPI is what makes this facet — and several others — scorable at all.

The six quality facets above are damped to 85 points between them, because the conditional facet above carries the other 15. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 85% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/shlink/"><img src="https://apis.io/badge/shlink/card.svg" alt="Shlink on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Delegated User Identity +6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented)
Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document
Typed Event Surface +6 pts — AsyncAPI document, OR webhooks/callbacks objects in the as-published OpenAPI, OR common[].type includes Webhooks

6 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Access Clarity scores 0.0 — up to +20.0 composite points
Contract Quality scores 46.3 — up to +13.4 composite points
Developer Ergonomics scores 35.0 — up to +13.0 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/shlink/apis.yml: open an issue on github.com/api-evangelist/shlink to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

APIs 8

Individual APIs this provider publishes, each with its own machine-readable definition.

Shlink Domains API

Operations to manage domains used on short URLs

Shlink Integrations API

Handle services with which shlink is integrated

Shlink Monitoring API

Public endpoints designed to monitor the service

Shlink Redirect rules API

Handle dynamic rule-based redirects

Shlink Short URLs API

Operations that can be performed on short URLs

Shlink Tags API

Let you handle the list of available tags

Shlink URL Shortener API

Non-rest endpoints, used to be publicly exposed

Shlink Visits API

Operations to manage visits on short URLs

Scroll for all 8

Agent Skills 1

Packaged agent skills for driving this provider's APIs from an AI assistant.

shlink-short-url-management

AGENT SKILL

Pricing Plans 1

Published pricing tiers and plan structures.

Shlink Plans Pricing

0 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Shlink Rate Limits

0 limits

RATE LIMITS

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

Shlink API Rules

13 rules · 10 errors 1 warnings 2 info

SPECTRAL

OpenAPI Overlays 1

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Shlink Openapi Overlay

1 action · update

UNRECORDED

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Shlink Authentication

1 scheme

SECURITY

Shlink Domain Security

TLSv1.3 · DNSSEC

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Shlink Scopes

OAuth 2.0 · no documented scopes

0 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Shlink Agentic Access

52 operations · 18 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 2

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

AgentSkill

AgentSkill

Design & Contract 5

Pagination, idempotency, versioning, errors, and events

Spectral

Vocabulary

Components

ErrorCatalog

Conformance

Build 2

SDKs, sample code, and the tooling you integrate with

SDKs

SDKs

Packages

Packages

Access & Security 2

Authentication, authorization, and security posture

Authentication

Authentication

DomainSecurity

DomainSecurity

Operate 1

Status, limits, changes, and where to get help

ChangeLog

ChangeLog

Company 1

The organization behind the API

Website

Website

Other 2

Properties that don't map to a standard resource type

Overlay

Overlay

Hosts

Hosts

Source (apis.yml)

aid: shlink
name: Shlink
description: Shlink is a self‑hosted, PHP‑based URL shortener that provides a RESTful API, a command‑line interface, and Docker
  images for easy deployment. It enables users to create and manage short URLs under their own domain, supports custom domains,
  tagging, visit tracking, redirect rules, and integrates with services like Mercure for real‑time updates. The open‑source
  project is actively maintained and documented at shlink.io.
url: https://artifacts.apis.io/shlink/apis.yml
x-type: company
x-source: harvest:new-submission
x-tier: profiled
x-tier-reason: enrichment pass 2026-10-28 (modular-v1; was harvest)
specificationVersion: '0.20'
created: '2026-10-28'
modified: '2026-10-28'
image: https://raw.githubusercontent.com/shlinkio/shlink.io/main/public/images/shlink-hero.png
tags:
- Company
- URL-Shortener
- PHP
- Self-Hosted
- Open-Source
- REST-API
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
- FN: APIs.json
  email: info@apis.io
common:
- type: AgenticAccess
  url: agentic-access/shlink-agentic-access.yml
- type: Spectral
  url: rules/shlink-rules.yml
- type: Vocabulary
  url: vocabulary/shlink-vocabulary.yml
- type: AgentSkill
  url: skills/_index.yml
- type: Components
  url: components/shlink-components.yml
- type: ChangeLog
  url: changelog/shlink-changelog.yml
- type: Authentication
  url: authentication/shlink-authentication.yml
- type: ErrorCatalog
  url: errors/shlink-problem-types.yml
- type: Conformance
  url: conformance/shlink-conformance.yml
- type: Overlay
  url: overlays/shlink-openapi-overlay.yaml
- type: Hosts
  url: hosts/shlink-hosts.yml
- type: SDKs
  url: packages/shlink-packages.yml
- type: Packages
  url: packages/shlink-packages.yml
- type: Documentation
  url: https://shlink.io/documentation
- type: DomainSecurity
  url: security/shlink-domain-security.yml
- type: Website
  url: https://shlink.io/
apis:
- aid: shlink:shlink-domains-api
  name: Shlink Domains API
  description: Operations to manage domains used on short URLs
  humanURL: https://shlink.io/documentation/api-docs
  tags:
  - Domains
  properties:
  - type: OpenAPI
    url: openapi/shlink-domains-api-openapi.yml
- aid: shlink:shlink-integrations-api
  name: Shlink Integrations API
  description: Handle services with which shlink is integrated
  humanURL: https://shlink.io/documentation/api-docs
  tags:
  - Integrations
  properties:
  - type: OpenAPI
    url: openapi/shlink-integrations-api-openapi.yml
- aid: shlink:shlink-monitoring-api
  name: Shlink Monitoring API
  description: Public endpoints designed to monitor the service
  humanURL: https://shlink.io/documentation/api-docs
  tags:
  - Monitoring
  properties:
  - type: OpenAPI
    url: openapi/shlink-monitoring-api-openapi.yml
- aid: shlink:shlink-redirect-rules-api
  name: Shlink Redirect rules API
  description: Handle dynamic rule-based redirects
  humanURL: https://shlink.io/documentation/api-docs
  tags:
  - Redirect rules
  properties:
  - type: OpenAPI
    url: openapi/shlink-redirect-rules-api-openapi.yml
- aid: shlink:shlink-short-urls-api
  name: Shlink Short URLs API
  description: Operations that can be performed on short URLs
  humanURL: https://shlink.io/documentation/api-docs
  tags:
  - Short URLs
  properties:
  - type: OpenAPI
    url: openapi/shlink-short-urls-api-openapi.yml
- aid: shlink:shlink-tags-api
  name: Shlink Tags API
  description: Let you handle the list of available tags
  humanURL: https://shlink.io/documentation/api-docs
  tags:
  - Tags
  properties:
  - type: OpenAPI
    url: openapi/shlink-tags-api-openapi.yml
- aid: shlink:shlink-url-shortener-api
  name: Shlink URL Shortener API
  description: Non-rest endpoints, used to be publicly exposed
  humanURL: https://shlink.io/documentation/api-docs
  tags:
  - URL Shortener
  properties:
  - type: OpenAPI
    url: openapi/shlink-url-shortener-api-openapi.yml
- aid: shlink:shlink-visits-api
  name: Shlink Visits API
  description: Operations to manage visits on short URLs
  humanURL: https://shlink.io/documentation/api-docs
  tags:
  - Visits
  properties:
  - type: OpenAPI
    url: openapi/shlink-visits-api-openapi.yml
x-submission-probe: 200, 2026-10-26
x-enrichment:
  date: '2026-10-28'
  status: nochange
  artifacts_added: 0
  pass: modular-v1
  engine: identity=oss,contract=oss,surfaces=oss,docs=oss,regulatory=oss

Shlink API — frequently asked questions

Does Shlink have an API?

Yes. APIs.io lists 8 APIs from Shlink, including Shlink Domains API, Shlink Integrations API and Shlink Monitoring API, and 5 more.

Is there an OpenAPI specification for the Shlink API?

Yes. APIs.io indexes 8 OpenAPI specifications for Shlink, each linked for download from this page.

How do I authenticate with the Shlink API?

Shlink uses bearer-token authentication (1 scheme). The details are profiled on APIs.io as Shlink Authentication.

Is the Shlink API ready for AI agents?

Shlink has a Kin Score of 30.7 out of 100 (thin) and an Agent Readiness score of 29.2 (agent-ready), scored by API Evangelist on 2026-10-31.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/shlink"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/shlink/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/shlink/evidence"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.