Create a licence
/licencesCosts 2 rate-limit points · Rate limits
Add licence keys to the pool (keys, one string each), under a tag when given, as the Licence keys page's Add keys does. Orders still waiting for a key from that pool are served right after.
Keys already in the shop (and repeats within the request) are skipped and counted in skipped_duplicates; send allow_duplicates: true to add them anyway. Keys are deleted on the Licence keys page (or DELETE /licences/:id over REST).
Also searched asadd licence keysupload keyspaste license keysadd keys to tagtop up the key pool
Request body
keysarray of stringsRequiredallow_duplicatesbooleantagstringExample:ebook-2026
Errors
Missing or invalid API key.
The request failed validation, or sent a key the action does not take (code: "unknown_parameters" with unknown and accepted). Nothing was saved.
Rate limited. Cost-weighted per API key, shared with API v1: a read costs 1 point, a write 2, 40 points per fixed 60-second window. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix time the window ends); a 429 adds Retry-After (seconds), retry_after, retryable: true and a next_step in the body. A 429 did nothing: wait retry_after seconds, then send the same request again. The budget is per key, so every tool or script using the key shares it; prefer one list call with per_page over many single reads.
Every error has the same shape: see Errors.
curl -X POST "https://app.filemonk.io/api/v2/external/licences" \
-H "X-Auth-Token: $FILEMONK_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"keys": [
"ABCD-EFGH-IJKL-0001",
"ABCD-EFGH-IJKL-0002"
],
"tag": "ebook-2026"
}'const res = await fetch("https://app.filemonk.io/api/v2/external/licences", {
method: "POST",
headers: {
"X-Auth-Token": process.env.FILEMONK_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"keys": [
"ABCD-EFGH-IJKL-0001",
"ABCD-EFGH-IJKL-0002"
],
"tag": "ebook-2026"
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.filemonk.io/api/v2/external/licences",
headers={"X-Auth-Token": os.environ["FILEMONK_API_KEY"]},
json={
"keys": [
"ABCD-EFGH-IJKL-0001",
"ABCD-EFGH-IJKL-0002"
],
"tag": "ebook-2026"
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.filemonk.io/api/v2/external/licences")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["FILEMONK_API_KEY"], "Content-Type" => "application/json")
req.body = {
keys: [
"ABCD-EFGH-IJKL-0001",
"ABCD-EFGH-IJKL-0002"
],
tag: "ebook-2026"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"created": 2,
"skipped_duplicates": 0,
"tag": {
"name": "ebook-2026",
"virtual": false,
"licences": {
"total": 2,
"pending": 2,
"assigned": 0,
"used": 0
},
"digital_products": []
}
}{
"created": 2,
"skipped_duplicates": 0,
"tag": {
"name": "ebook-2026",
"virtual": false,
"licences": {
"total": 2,
"pending": 2,
"assigned": 0,
"used": 0
},
"digital_products": []
}
}{
"errors": [
"Invalid API key"
]
}{
"errors": [
"access.download_limit_count must be an integer of at least 0"
],
"field_errors": {
"access.download_limit_count": [
"must be an integer of at least 0"
]
}
}{
"errors": [
"You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
],
"code": "rate_limited",
"retry_after": 12,
"error": "Rate limit exceeded",
"message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
}Without allow_duplicates the key would be skipped and counted in skipped_duplicates.
curl -X POST "https://app.filemonk.io/api/v2/external/licences" \
-H "X-Auth-Token: $FILEMONK_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"keys": [
"ABCD-EFGH-IJKL-0001"
],
"tag": "ebook-2026",
"allow_duplicates": true
}'const res = await fetch("https://app.filemonk.io/api/v2/external/licences", {
method: "POST",
headers: {
"X-Auth-Token": process.env.FILEMONK_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"keys": [
"ABCD-EFGH-IJKL-0001"
],
"tag": "ebook-2026",
"allow_duplicates": true
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.filemonk.io/api/v2/external/licences",
headers={"X-Auth-Token": os.environ["FILEMONK_API_KEY"]},
json={
"keys": [
"ABCD-EFGH-IJKL-0001"
],
"tag": "ebook-2026",
"allow_duplicates": True
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.filemonk.io/api/v2/external/licences")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["FILEMONK_API_KEY"], "Content-Type" => "application/json")
req.body = {
keys: [
"ABCD-EFGH-IJKL-0001"
],
tag: "ebook-2026",
allow_duplicates: true
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"created": 1,
"skipped_duplicates": 0,
"tag": {
"name": "ebook-2026",
"virtual": false,
"licences": {
"total": 3,
"pending": 3,
"assigned": 0,
"used": 0
},
"digital_products": []
}
}{
"created": 1,
"skipped_duplicates": 0,
"tag": {
"name": "ebook-2026",
"virtual": false,
"licences": {
"total": 3,
"pending": 3,
"assigned": 0,
"used": 0
},
"digital_products": []
}
}{
"errors": [
"Invalid API key"
]
}{
"errors": [
"access.download_limit_count must be an integer of at least 0"
],
"field_errors": {
"access.download_limit_count": [
"must be an integer of at least 0"
]
}
}{
"errors": [
"You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
],
"code": "rate_limited",
"retry_after": 12,
"error": "Rate limit exceeded",
"message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
}