GET/api/v1/documents/{slug}/slug-check

Check an address

Whether a document could move to new_slug, without changing anything: available, or a code that says why not (same, invalid, reserved, taken or folder), plus the links it would have on markdrop.in and on its workspace's domain. For people who may change its address.

Token optionalOr edit secret60 per minute per IP

Guide: Addresses

Code samples and Try it

Path parameters

slugstringRequired
The document's address: the part after markdrop.in/.

Query parameters

new_slugstringRequired
The address to check. Up to 100 characters.

Headers

X-Edit-Secretstring
The document's edit secret (sk_…), for a document published without an account. See Edit key.

Responses

200OK.
422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
429Too many requests from your IP address. Wait the seconds in Retry-After.

bash

curl 'https://api.markdrop.in/api/v1/documents/k3x9q2m/slug-check?new_slug=release-notes' \
  -H "Authorization: Bearer $MARKDROP_TOKEN"

javascript

const res = await fetch("https://api.markdrop.in/api/v1/documents/k3x9q2m/slug-check?new_slug=release-notes", {
  headers: {
    Authorization: `Bearer ${process.env.MARKDROP_TOKEN}`,
  },
});
const data = await res.json();

python

import os

import requests

r = requests.get(
    "https://api.markdrop.in/api/v1/documents/k3x9q2m/slug-check?new_slug=release-notes",
    headers={"Authorization": f"Bearer {os.environ['MARKDROP_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

Try it

API token (optional)

Leave it empty to send the request anonymously. Kept in this tab only, and sent only to the API. Create a token

slugrequired

new_slugrequired

X-Edit-Secret

Your request

curl 'https://api.markdrop.in/api/v1/documents/k3x9q2m/slug-check?new_slug=release-notes'

Sends to api.markdrop.in from your browser. ⌘ ↵ sends too.

Did this page help?