Shlink Monitoring API
Public endpoints designed to monitor the service
Work with this as data
Every API 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 apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/shlink:shlink-monitoring-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Shlink Monitoring API
version: '3.0'
description: 'Operations tagged Monitoring across 3 of this provider''s published API definitions: shlink-openapi-v5.1.4.json, shlink-openapi-v5.1.0.json, shlink-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: '{scheme}://{host}'
variables:
scheme:
enum:
- https
- http
default: https
host:
default: ''
tags:
- name: Monitoring
description: Public endpoints designed to monitor the service
paths:
/rest/health:
get:
tags:
- Monitoring
summary: Check healthiness
description: Checks the healthiness of the service, making sure it can access required resources.
operationId: health
responses:
'200':
description: The passing health status
content:
application/json:
schema:
type: object
properties:
status:
enum:
- pass
- fail
type: string
description: The status of the service
version:
type: string
description: Shlink version
links:
type: object
properties:
about:
type: string
description: About shlink
project:
type: string
description: Shlink project repository
description: A list of links
example:
status: pass
version: 2.10.0
links:
about: https://shlink.io
project: https://github.com/shlinkio/shlink
'503':
description: The failing health status
content:
application/json:
schema:
type: object
properties:
status:
enum:
- pass
- fail
type: string
description: The status of the service
version:
type: string
description: Shlink version
links:
type: object
properties:
about:
type: string
description: About shlink
project:
type: string
description: Shlink project repository
description: A list of links
example:
status: fail
version: 2.10.0
links:
about: https://shlink.io
project: https://github.com/shlinkio/shlink
default:
description: Unexpected error.
content:
application/json:
schema:
required:
- type
- title
- detail
- status
type: object
properties:
type:
type: string
description: A machine unique code
title:
type: string
description: A unique title
detail:
type: string
description: A human-friendly error description
status:
type: number
description: HTTP response status code
servers:
- url: '{scheme}://{host}'
variables:
scheme:
enum:
- https
- http
default: https
host:
default: ''
components:
securitySchemes:
ApiKey:
type: apiKey
description: A valid shlink API key
name: X-Api-Key
in: header
externalDocs:
description: Find more info on how to start using this API here
url: https://shlink.io/documentation/api-docs
x-refined-from:
- shlink-openapi-v5.1.4.json
- shlink-openapi-v5.1.0.json
- shlink-openapi.json