{ "item": [ { "name": "{ip}", "description": "", "item": [ { "id": "924b086a-8ff0-49a4-89f5-17e4492cf654", "name": "Lookup", "request": { "name": "Lookup", "description": { "content": "Answers what is known about a single IPv4 or IPv6 address. Which fields\ncome back is decided by the plan behind the presented key; with no key\nthe answer is `ip` and `is_vpn`.\n", "type": "text/plain" }, "url": { "path": [ ":ip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ip", "disabled": false, "description": { "content": "(Required) The IPv4 or IPv6 address to classify.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "noauth" } }, "response": [ { "id": "6fcdb254-ede9-448b-a3a1-fb1a8cf4a087", "name": "The classification. Present fields are those your plan includes; see\nthe tier table in the API description.\n", "originalRequest": { "url": { "path": [ ":ip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ip\": \"\",\n \"is_vpn\": \"\",\n \"is_hosting\": \"\",\n \"is_relay\": \"\",\n \"is_tor\": \"\",\n \"is_cdn\": \"\",\n \"is_resproxy\": \"\",\n \"is_dcproxy\": \"\",\n \"is_mobproxy\": \"\",\n \"vpn\": {\n \"provider\": \"\",\n \"last_seen\": \"\",\n \"confidence\": \"\",\n \"method\": \"\"\n },\n \"hosting\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"relay\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"tor\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"cdn\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"resproxy\": {\n \"provider\": \"\",\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"hits\": \"\",\n \"hits_days_pct\": \"\",\n \"providers_num\": \"\"\n },\n \"dcproxy\": {\n \"provider\": \"\",\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"hits\": \"\",\n \"hits_days_pct\": \"\",\n \"providers_num\": \"\"\n },\n \"mobproxy\": {\n \"provider\": \"\",\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"hits\": \"\",\n \"hits_days_pct\": \"\",\n \"providers_num\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b938f70c-f95b-4b82-8a3f-36f7316e8a41", "name": "The path segment is not a valid IP address.", "originalRequest": { "url": { "path": [ ":ip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eee7e875-b4de-4e30-922b-7879b20e7991", "name": "The presented API key is unknown, revoked, or expired.", "originalRequest": { "url": { "path": [ ":ip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5963d690-be06-40dc-892c-ddcef5dcf95e", "name": "The key restricts which source addresses may use it, and this\nrequest did not come from one of them.\n", "originalRequest": { "url": { "path": [ ":ip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9578e8a2-0757-42e3-b434-8e1d0e32b6f3", "name": "Either a transient rate limit or a spent allowance. `Retry-After` is\npresent for the former and absent for the latter, and is the only\nway to tell them apart.\n", "originalRequest": { "url": { "path": [ ":ip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying. Present ONLY when the rejection\nis a transient rate limit; its absence means an allowance is\nspent and retrying will not help.\n", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d6240ef-1e7c-44bd-bb31-9494a44b1ffb", "name": "The VPN dataset could not be consulted.", "originalRequest": { "url": { "path": [ ":ip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "myip", "description": "", "item": [ { "id": "59a74bcf-18bc-4d4d-b642-6838948ad1d0", "name": "My IP", "request": { "name": "My IP", "description": { "content": "Answers what is known about the address this request came from, which is\nthe same answer `GET /{ip}` gives for that address: the plan behind the\npresented key decides which fields come back, and the request counts\nagainst the same allowance.\n\nThe address is the one our edge observed, so a request through a proxy\nor a VPN reports the exit it left through rather than the machine that\nmade it. That is usually the point of asking.\n", "type": "text/plain" }, "url": { "path": [ "myip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "noauth" } }, "response": [ { "id": "1272ffa7-6b8a-460b-bf62-bf8c24ca901d", "name": "The classification of your own address. Present fields are those\nyour plan includes; see the tier table in the API description.\n", "originalRequest": { "url": { "path": [ "myip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ip\": \"\",\n \"is_vpn\": \"\",\n \"is_hosting\": \"\",\n \"is_relay\": \"\",\n \"is_tor\": \"\",\n \"is_cdn\": \"\",\n \"is_resproxy\": \"\",\n \"is_dcproxy\": \"\",\n \"is_mobproxy\": \"\",\n \"vpn\": {\n \"provider\": \"\",\n \"last_seen\": \"\",\n \"confidence\": \"\",\n \"method\": \"\"\n },\n \"hosting\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"relay\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"tor\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"cdn\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"resproxy\": {\n \"provider\": \"\",\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"hits\": \"\",\n \"hits_days_pct\": \"\",\n \"providers_num\": \"\"\n },\n \"dcproxy\": {\n \"provider\": \"\",\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"hits\": \"\",\n \"hits_days_pct\": \"\",\n \"providers_num\": \"\"\n },\n \"mobproxy\": {\n \"provider\": \"\",\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"hits\": \"\",\n \"hits_days_pct\": \"\",\n \"providers_num\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6210168c-5036-428c-ae60-22dd1cfc9ce3", "name": "The presented API key is unknown, revoked, or expired.", "originalRequest": { "url": { "path": [ "myip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40ad460b-450c-40f7-9473-d5bc08d55684", "name": "The key restricts which source addresses may use it, and this\nrequest did not come from one of them.\n", "originalRequest": { "url": { "path": [ "myip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e109486-890c-4e66-b15f-1e62da064517", "name": "Either the request rate was too high, or an allowance is spent.\nThe two are told apart by the message, not the status.\n", "originalRequest": { "url": { "path": [ "myip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6491974-2f20-44cc-a69d-f8228898c60b", "name": "The VPN dataset could not be consulted.", "originalRequest": { "url": { "path": [ "myip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "batch", "description": "", "item": [ { "id": "8603e10c-2644-49c7-8c75-7b0f3547c39f", "name": "Batch", "request": { "name": "Batch", "description": { "content": "Answers up to 1000 addresses in one call. Each distinct string in `ips`\nis one lookup: it costs exactly what `GET /{ip}` costs for that address\nand comes back with exactly the fields that call would carry for your\nplan. Exact duplicates collapse to one entry and one lookup.\n\nBoth maps in the answer are keyed by the string you sent, so nothing has\nto be lined up by position; the `ip` inside each result is the\nnormalized form. An address that could not be answered sits in `errors`\nwith the status and message the single lookup would have given, and\nnever disturbs the others: a string that is not an address is a `400`\nthere, and an allowance that runs out part way through leaves the\nremaining entries as `429`s.\n\nThe call itself fails only for the reasons below, and a `429` on the\ncall always carries `Retry-After`: the batch is admitted or refused\nwhole by the rate limit, so a per-entry `429` is always a spent\nallowance and never a throttle.\n", "type": "text/plain" }, "url": { "path": [ "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ips\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "id": "872464fe-1c64-4876-ab50-7aac59d5e871", "name": "One entry per distinct input string, in `results` or in `errors`.\nPresent fields within a result are those your plan includes; see the\ntier table in the API description.\n", "originalRequest": { "url": { "path": [ "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ips\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"eta\": {\n \"ip\": \"\",\n \"is_vpn\": \"\",\n \"is_hosting\": \"\",\n \"is_relay\": \"\",\n \"is_tor\": \"\",\n \"is_cdn\": \"\",\n \"is_resproxy\": \"\",\n \"is_dcproxy\": \"\",\n \"is_mobproxy\": \"\",\n \"vpn\": {\n \"provider\": \"\",\n \"last_seen\": \"\",\n \"confidence\": \"\",\n \"method\": \"\"\n },\n \"hosting\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"relay\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"tor\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"cdn\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"resproxy\": {\n \"provider\": \"\",\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"hits\": \"\",\n \"hits_days_pct\": \"\",\n \"providers_num\": \"\"\n },\n \"dcproxy\": {\n \"provider\": \"\",\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"hits\": \"\",\n \"hits_days_pct\": \"\",\n \"providers_num\": \"\"\n },\n \"mobproxy\": {\n \"provider\": \"\",\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"hits\": \"\",\n \"hits_days_pct\": \"\",\n \"providers_num\": \"\"\n }\n },\n \"adipisicing_0\": {\n \"ip\": \"\",\n \"is_vpn\": \"\",\n \"is_hosting\": \"\",\n \"is_relay\": \"\",\n \"is_tor\": \"\",\n \"is_cdn\": \"\",\n \"is_resproxy\": \"\",\n \"is_dcproxy\": \"\",\n \"is_mobproxy\": \"\",\n \"vpn\": {\n \"provider\": \"\",\n \"last_seen\": \"\",\n \"confidence\": \"\",\n \"method\": \"\"\n },\n \"hosting\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"relay\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"tor\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"cdn\": {\n \"provider\": \"\",\n \"confidence\": \"\",\n \"last_seen\": \"\"\n },\n \"resproxy\": {\n \"provider\": \"\",\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"hits\": \"\",\n \"hits_days_pct\": \"\",\n \"providers_num\": \"\"\n },\n \"dcproxy\": {\n \"provider\": \"\",\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"hits\": \"\",\n \"hits_days_pct\": \"\",\n \"providers_num\": \"\"\n },\n \"mobproxy\": {\n \"provider\": \"\",\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"hits\": \"\",\n \"hits_days_pct\": \"\",\n \"providers_num\": \"\"\n }\n }\n },\n \"errors\": {\n \"minim1\": {\n \"status\": \"\",\n \"error\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eff9f1cd-56a5-4529-a564-f22760c59e65", "name": "The body is not a batch, or names too few or too many addresses.", "originalRequest": { "url": { "path": [ "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ips\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "885a009c-3b0b-4c6f-90d4-85a19142e9ae", "name": "The presented API key is unknown, revoked, or expired.", "originalRequest": { "url": { "path": [ "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ips\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41808923-65f4-42af-bd94-8a545341dea9", "name": "The key restricts which source addresses may use it, and this\nrequest did not come from one of them.\n", "originalRequest": { "url": { "path": [ "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ips\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6404fbf2-9dd8-43f2-a89a-6b05e7b6d2be", "name": "The body is larger than any batch of 1000 addresses can be.", "originalRequest": { "url": { "path": [ "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ips\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "913b48f7-2ccf-440e-b30d-963d96cb263a", "name": "The rate limit refused the whole call. Always transient and always\nwith `Retry-After`; a spent allowance is reported per entry in a\n`200` instead.\n", "originalRequest": { "url": { "path": [ "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ips\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "(Required) Seconds to wait before retrying the call.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "api", "description": "", "item": [ { "name": "v1", "description": "", "item": [ { "name": "database", "description": "", "item": [ { "name": "list", "description": "", "item": [ { "id": "95c04b7c-315b-436f-a714-3145fa83dd61", "name": "List", "request": { "name": "List", "description": { "content": "Every database this organization may SEE, with where its license stands.\nNot just the ones you hold: a customer with one grant should be able to\ntell what else is published without asking. `standing` is the\ndifference - `licensed`, `expired`, or `unlicensed` for one never\nbought.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "database", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "apikey" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "query" } ] } }, "response": [ { "id": "273ff245-cf4b-4318-8211-3b087cfb8442", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "database", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"databases\": [\n {\n \"base\": \"\",\n \"name\": \"\",\n \"summary\": \"\",\n \"license_type\": \"redistribute\",\n \"starts\": \"\",\n \"expires\": \"\",\n \"renews_at\": \"\",\n \"notice_due_at\": \"\",\n \"in_term\": \"\",\n \"standing\": \"unlicensed\",\n \"versions\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"formats\": [\n {\n \"format\": \"mmdb\",\n \"bytes\": \"\"\n },\n {\n \"format\": \"mmdb\",\n \"bytes\": \"\"\n }\n ],\n \"summary\": \"\",\n \"sample_formats\": [\n \"csvgz\",\n \"mmdb\"\n ]\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"formats\": [\n {\n \"format\": \"mmdb\",\n \"bytes\": \"\"\n },\n {\n \"format\": \"csvgz\",\n \"bytes\": \"\"\n }\n ],\n \"summary\": \"\",\n \"sample_formats\": [\n \"csvgz\",\n \"mmdb\"\n ]\n }\n ]\n },\n {\n \"base\": \"\",\n \"name\": \"\",\n \"summary\": \"\",\n \"license_type\": null,\n \"starts\": \"\",\n \"expires\": \"\",\n \"renews_at\": \"\",\n \"notice_due_at\": \"\",\n \"in_term\": \"\",\n \"standing\": \"expired\",\n \"versions\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"formats\": [\n {\n \"format\": \"mmdb\",\n \"bytes\": \"\"\n },\n {\n \"format\": \"csvgz\",\n \"bytes\": \"\"\n }\n ],\n \"summary\": \"\",\n \"sample_formats\": [\n \"mmdb\",\n \"mmdb\"\n ]\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"formats\": [\n {\n \"format\": \"mmdb\",\n \"bytes\": \"\"\n },\n {\n \"format\": \"csvgz\",\n \"bytes\": \"\"\n }\n ],\n \"summary\": \"\",\n \"sample_formats\": [\n \"mmdb\",\n \"csvgz\"\n ]\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10b63519-23ff-42f9-9a8b-b5f4b5a9da00", "name": "Missing or invalid key, or the key lacks the db.download scope", "originalRequest": { "url": { "path": [ "api", "v1", "database", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "download", "description": "", "item": [ { "id": "03855e68-ff9e-4c40-ac88-677226b77008", "name": "Download", "request": { "name": "Download", "description": { "content": "Answers `302` with a time-limited URL pointing straight at object storage. Follow the redirect; the link authorizes the START of a transfer, so one already running is not interrupted when it lapses.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "database", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Dataset id, e.g. vpn_ip_extended_v1", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Not every database is built in every format. The `_provider`\ncatalogues are keyed by provider id rather than by IP range, so no\nMMDB exists for them.\n", "type": "text/plain" }, "key": "format", "value": "csvgz" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "apikey" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "query" } ] } }, "response": [ { "id": "642b87ca-e9a8-403b-9514-3476ef956f78", "name": "Follow the Location header to object storage", "originalRequest": { "url": { "path": [ "api", "v1", "database", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Dataset id, e.g. vpn_ip_extended_v1", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Not every database is built in every format. The `_provider`\ncatalogues are keyed by provider id rather than by IP range, so no\nMMDB exists for them.\n", "type": "text/plain" }, "key": "format", "value": "csvgz" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Found", "code": 302, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "" } ], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0e31a4f0-7168-4ac0-aad1-20cdba9b6353", "name": "The database is not built in the requested format", "originalRequest": { "url": { "path": [ "api", "v1", "database", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Dataset id, e.g. vpn_ip_extended_v1", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Not every database is built in every format. The `_provider`\ncatalogues are keyed by provider id rather than by IP range, so no\nMMDB exists for them.\n", "type": "text/plain" }, "key": "format", "value": "csvgz" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bf799ea-f814-4b6b-9464-676305d91e66", "name": "Missing or invalid key, or the key lacks the db.download scope", "originalRequest": { "url": { "path": [ "api", "v1", "database", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Dataset id, e.g. vpn_ip_extended_v1", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Not every database is built in every format. The `_provider`\ncatalogues are keyed by provider id rather than by IP range, so no\nMMDB exists for them.\n", "type": "text/plain" }, "key": "format", "value": "csvgz" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "282965fe-ddb9-4e63-90bb-581b39ec0c07", "name": "Your organization holds no license for this database, or its term has ended", "originalRequest": { "url": { "path": [ "api", "v1", "database", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Dataset id, e.g. vpn_ip_extended_v1", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Not every database is built in every format. The `_provider`\ncatalogues are keyed by provider id rather than by IP range, so no\nMMDB exists for them.\n", "type": "text/plain" }, "key": "format", "value": "csvgz" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4008d325-8045-488f-b023-db538bd823bd", "name": "No such database", "originalRequest": { "url": { "path": [ "api", "v1", "database", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Dataset id, e.g. vpn_ip_extended_v1", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Not every database is built in every format. The `_provider`\ncatalogues are keyed by provider id rather than by IP range, so no\nMMDB exists for them.\n", "type": "text/plain" }, "key": "format", "value": "csvgz" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1d1125d-b313-45ef-a96f-8dbb0cd27466", "name": "Licensed, but today's copy has not been published yet", "originalRequest": { "url": { "path": [ "api", "v1", "database", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Dataset id, e.g. vpn_ip_extended_v1", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Not every database is built in every format. The `_provider`\ncatalogues are keyed by provider id rather than by IP range, so no\nMMDB exists for them.\n", "type": "text/plain" }, "key": "format", "value": "csvgz" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "metadata", "description": "", "item": [ { "id": "9f89e5ba-b633-463b-bc63-0fe673835fa3", "name": "Metadata", "request": { "name": "Metadata", "description": { "content": "Poll this to decide whether today's build is worth fetching: it carries\n`updated` and `entries` without downloading anything.\n\nNo `format` parameter - one document describes every format the database\nis built in.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "database", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "apikey" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "query" } ] } }, "response": [ { "id": "0bd5fac9-991a-40a9-862a-83b5d52ff64d", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "database", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"updated\": \"\",\n \"entries\": \"\",\n \"schema\": {\n \"esse_c4\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"ex50\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"aliqua83\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ]\n },\n \"update_freq\": \"\",\n \"sample\": {},\n \"size\": {\n \"nulla_cf5\": \"\",\n \"dolore5cd\": \"\"\n },\n \"sample_size\": {\n \"deserunt_98\": \"\",\n \"dolore4\": \"\",\n \"deserunt1db\": \"\",\n \"ad21\": \"\"\n },\n \"sample_entries\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c83f1431-b087-4ede-97f4-3a495ce64bc1", "name": "Missing or invalid key, or the key lacks the db.download scope", "originalRequest": { "url": { "path": [ "api", "v1", "database", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6bef2fc-6fb6-4f5e-afc5-68da7f950621", "name": "Your organization holds no license for this database, or its term has ended", "originalRequest": { "url": { "path": [ "api", "v1", "database", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "702497f9-fe94-44a4-bb3e-f1f88d4377c3", "name": "No such database", "originalRequest": { "url": { "path": [ "api", "v1", "database", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "573e356d-181c-4161-9dfb-704da6ab72c7", "name": "Licensed, but today's copy has not been published yet", "originalRequest": { "url": { "path": [ "api", "v1", "database", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "checksum", "description": "", "item": [ { "id": "6b7912c6-3a18-433d-951e-0e5aec10bf85", "name": "Checksums", "request": { "name": "Checksums", "description": { "content": "Checksums for one published file, so a download can be verified after it lands.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "database", "checksum" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "format", "value": "csvgz" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "apikey" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "query" } ] } }, "response": [ { "id": "f8f6333b-9862-463e-a2b3-bc4bc461d242", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "database", "checksum" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "format", "value": "csvgz" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"format\": \"\",\n \"checksums\": {\n \"md5\": \"\",\n \"sha1\": \"\",\n \"sha256\": \"\",\n \"sha512\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "deba409b-9ac3-42e1-966b-57950568a1ed", "name": "The database is not built in the requested format", "originalRequest": { "url": { "path": [ "api", "v1", "database", "checksum" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "format", "value": "csvgz" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "496d9258-9d97-40ef-975d-c612771d4660", "name": "Missing or invalid key, or the key lacks the db.download scope", "originalRequest": { "url": { "path": [ "api", "v1", "database", "checksum" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "format", "value": "csvgz" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31430fd4-943a-433b-b1ed-7088e7f08955", "name": "Your organization holds no license for this database, or its term has ended", "originalRequest": { "url": { "path": [ "api", "v1", "database", "checksum" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "format", "value": "csvgz" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2dd4617-1554-4798-a5bd-4f7e7b8e7b29", "name": "No such database", "originalRequest": { "url": { "path": [ "api", "v1", "database", "checksum" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "format", "value": "csvgz" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12fbc1c2-70fa-4cfe-a3b8-e196c17b3098", "name": "Licensed, but today's copy has not been published yet", "originalRequest": { "url": { "path": [ "api", "v1", "database", "checksum" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "format", "value": "csvgz" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "downloads", "description": "", "item": [ { "id": "12b63d51-6b49-4efb-bf5d-51e6e32c997a", "name": "History", "request": { "name": "History", "description": { "content": "Recent download attempts for this organization, newest first. Refusals are listed too, so a failed transfer can be accounted for.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "database", "downloads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "How many attempts to return. Clamped to 1 through 200.", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "apikey" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "query" } ] } }, "response": [ { "id": "f541064a-f4e9-4d5e-97f5-7660f2d97406", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "database", "downloads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "How many attempts to return. Clamped to 1 through 200.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"downloads\": [\n {\n \"dataset_id\": \"\",\n \"format\": \"\",\n \"outcome\": \"denied\",\n \"sample\": \"\",\n \"bytes\": \"\",\n \"http_status\": \"\",\n \"apikey_id\": \"\",\n \"client_ip\": \"\",\n \"user_agent\": \"\",\n \"created\": \"\"\n },\n {\n \"dataset_id\": \"\",\n \"format\": \"\",\n \"outcome\": \"unavailable\",\n \"sample\": \"\",\n \"bytes\": \"\",\n \"http_status\": \"\",\n \"apikey_id\": \"\",\n \"client_ip\": \"\",\n \"user_agent\": \"\",\n \"created\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "151a713a-1cad-4c6a-b5c7-b31b485826cf", "name": "Missing or invalid key, or the key lacks the db.download scope", "originalRequest": { "url": { "path": [ "api", "v1", "database", "downloads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "How many attempts to return. Clamped to 1 through 200.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "entitlement", "description": "", "item": [ { "id": "b281d657-8fe8-4d02-9c45-55900e82037c", "name": "Plan and usage", "request": { "name": "Plan and usage", "description": { "content": "Answers what the presented key is, what plan is behind it, and what has\nbeen spent against that plan's allowance in the current window.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "entitlement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "apikey" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "query" } ] } }, "response": [ { "id": "a385c8b6-78e7-49c6-b3b8-f1cb3f74e5da", "name": "The key's entitlements and consumption.", "originalRequest": { "url": { "path": [ "api", "v1", "entitlement" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"org_id\": \"\",\n \"apikey\": {\n \"id\": \"\",\n \"expires\": \"\",\n \"allowed_cidrs\": [\n \"\",\n \"\"\n ]\n },\n \"plan\": {\n \"key\": \"\",\n \"tier\": \"max\"\n },\n \"usage\": {\n \"requests\": \"\",\n \"quota\": \"\",\n \"hard_limit\": \"\",\n \"window_start\": \"\",\n \"window_end\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b526566d-e4b0-423f-bb57-1c3e24f0b1ef", "name": "No key was presented, or it is unknown, revoked or expired.", "originalRequest": { "url": { "path": [ "api", "v1", "entitlement" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c55887b-2436-46fb-bd0d-8bfa2a5f589b", "name": "The key restricts which source addresses may use it, and this\nrequest did not come from one of them.\n", "originalRequest": { "url": { "path": [ "api", "v1", "entitlement" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac2ca2a3-2b74-47cb-818c-9b634160da25", "name": "The usage counters could not be read. Reported rather than guessed\nat: the whole answer is the number, and a confident zero would read\nas \"you have used nothing\".\n", "originalRequest": { "url": { "path": [ "api", "v1", "entitlement" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "apikey", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "iam", "description": "", "item": [ { "name": "identity", "description": "", "item": [ { "id": "c985b608-c868-48df-8074-a77758529ca6", "name": "Identity", "request": { "name": "Identity", "description": { "content": "The identity behind this credential: what it is, the organization it is\nscoped to, and the scopes it currently holds.\n\n`user` is present for an OAuth token and ABSENT for an API key, which\nhas an organization but no person behind it. `credential.kind` says\nwhich you are holding, so a client can branch without guessing from a\nmissing field.\n\nNarrower than what the console shows its own user on purpose: an\nintegration needs a name to display and an organization to address, not\na profile. The `scopes` array is what the credential may do RIGHT NOW,\nso a client can render its own capabilities rather than discovering\nthem from a 403.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "iam", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "77430a33-e530-47c2-b36e-eb323c83e7bc", "name": "The caller.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\",\n \"user\": {\n \"id\": \"\",\n \"fullname\": \"\",\n \"email\": \"\"\n },\n \"org\": {\n \"id\": \"\"\n },\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21956f02-60fb-4a81-8536-425edcdd83cc", "name": "No credential was presented, or it is not valid.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1dc7972-358d-4fb8-8047-ebc6ac731208", "name": "The credential does not hold the scope this endpoint requires. The\nmissing scope is deliberately not named.\n", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "org", "description": "", "item": [ { "id": "be32032b-c99e-465a-8bcf-20bf92d30c61", "name": "Organization", "request": { "name": "Organization", "description": { "content": "The organization this credential is scoped to.\n\nThere is no way to name a different one. A credential describes exactly\none organization, so an identifier in the path could only ever be your\nown or a refusal.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "iam", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a163ad65-b613-4610-9ceb-48e7262dbf4b", "name": "The organization.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\",\n \"org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45cbeb03-de31-4d70-b805-6c83549fe96d", "name": "No credential was presented, or it is not valid.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a7d95b8-1df3-47f5-9ce3-3d570caf28b0", "name": "The credential does not hold the scope this endpoint requires. The\nmissing scope is deliberately not named.\n", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "members", "description": "", "item": [ { "id": "a1885c7c-cd4f-4be6-ab7d-44892daebe6f", "name": "Members", "request": { "name": "Members", "description": { "content": "Read-only. Adding or removing a member is an invitation flow with email\nin the middle rather than a POST, and modelling it as one here would\npromise something this API does not do.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "iam", "org", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6cb1ca4c-4d33-4aa5-be8f-84902855f074", "name": "The members.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "org", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df89c0b7-5dcb-4b76-b6c6-bf5f2d681182", "name": "No credential was presented, or it is not valid.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "org", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b0801e5-2e8a-4f7d-bc7a-9e24a2a7c4f8", "name": "The credential does not hold the scope this endpoint requires. The\nmissing scope is deliberately not named.\n", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "org", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "apikeys", "description": "", "item": [ { "id": "f919e97b-af97-4b45-bb71-344563e6be24", "name": "List", "request": { "name": "List", "description": { "content": "Metadata only. A key's secret is never in a list - not here and not in\nthe console - because a list is the response that ends up in logs,\ncaches and support tickets.\n\n`retrievable` says whether the secret could still be read back at all.\nA key issued before this product stored secrets recoverably was never\nkept, so `reveal` will refuse it permanently; rotating produces one\nthat can be read.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "iam", "apikeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7f5a7c32-bff0-4c37-92d3-1958f5150253", "name": "The organization's keys, newest first.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\",\n \"keys\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"key_prefix\": \"\",\n \"created\": \"\",\n \"expires\": \"\",\n \"last_used_at\": \"\",\n \"revoked_at\": \"\",\n \"allowed_cidrs\": [\n \"\",\n \"\"\n ],\n \"allowed_scopes\": [\n \"\",\n \"\"\n ],\n \"retrievable\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"key_prefix\": \"\",\n \"created\": \"\",\n \"expires\": \"\",\n \"last_used_at\": \"\",\n \"revoked_at\": \"\",\n \"allowed_cidrs\": [\n \"\",\n \"\"\n ],\n \"allowed_scopes\": [\n \"\",\n \"\"\n ],\n \"retrievable\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9e66ce3-f570-48bd-8fab-96930c8907b1", "name": "No credential was presented, or it is not valid.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4c705e5-9ecb-4563-9f21-05721e3eb76e", "name": "The credential does not hold the scope this endpoint requires. The\nmissing scope is deliberately not named.\n", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "339ffec0-fc49-4b12-9539-489abe9c7ea7", "name": "Create", "request": { "name": "Create", "description": { "content": "Creates a key and returns its secret.\n\nThis is the ONLY response that ever carries the secret, and only\nbecause this is the moment it comes into existence. Store it now.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "iam", "apikeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"allowed_scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "184730cd-a18e-496a-ac94-9908f4fe26e0", "name": "The new key, including its secret.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"allowed_scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\",\n \"id\": \"\",\n \"key\": \"\",\n \"name\": \"\",\n \"key_prefix\": \"\",\n \"allowed_cidrs\": [\n \"\",\n \"\"\n ],\n \"allowed_scopes\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31cd79f7-d533-4d19-8767-882a3a41075b", "name": "The request body is missing a required field.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"allowed_scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5970350-6532-461a-abbc-89b8fce2b31c", "name": "No credential was presented, or it is not valid.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"allowed_scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dab715bb-7751-4b2d-9d90-b8f110c43f9b", "name": "The credential does not hold the scope this endpoint requires. The\nmissing scope is deliberately not named.\n", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"allowed_scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "name": "rotate", "description": "", "item": [ { "id": "4d1f4cf3-b6f4-4a11-a665-268a37e5d149", "name": "Rotate", "request": { "name": "Rotate", "description": { "content": "Replaces the secret behind a key, keeping its id, name and settings.\nThe previous secret stops working immediately.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) The key's id, as returned by the list endpoint. Never the key itself.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1f4cf272-57cb-4198-8891-f35fec2cac24", "name": "The key, with its new secret.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\",\n \"id\": \"\",\n \"key\": \"\",\n \"name\": \"\",\n \"key_prefix\": \"\",\n \"allowed_cidrs\": [\n \"\",\n \"\"\n ],\n \"allowed_scopes\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91b5c92e-a40c-44e3-ad59-ce050c974ba4", "name": "No credential was presented, or it is not valid.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "303e31e3-98bc-48a2-b23a-70995a4a4ca9", "name": "The credential does not hold the scope this endpoint requires. The\nmissing scope is deliberately not named.\n", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "243a40ae-9f83-4c3c-95ac-8c1112b6c5ab", "name": "No such key in this organization.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "revoke", "description": "", "item": [ { "id": "ab9b7608-c5c3-4502-9dca-c969de220b0a", "name": "Revoke", "request": { "name": "Revoke", "description": { "content": "Stops the key working. Revocation is soft: the key stays listed with a\n`revoked_at`, because the organization still owns whatever it did while\nit was alive.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) The key's id, as returned by the list endpoint. Never the key itself.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5993e757-c119-4c22-819a-6d0c0358162b", "name": "Revoked.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac5bda3f-c7df-4d34-93f0-265e0f868499", "name": "No credential was presented, or it is not valid.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3da2dbe9-94c3-4d6d-966e-63948aec0df4", "name": "The credential does not hold the scope this endpoint requires. The\nmissing scope is deliberately not named.\n", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d08ea4d-e7cd-4034-aebb-e74a7ccbc362", "name": "No such key in this organization.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "reveal", "description": "", "item": [ { "id": "ac1c2c6d-40ed-42c7-9ba5-8a4211785662", "name": "Reveal", "request": { "name": "Reveal", "description": { "content": "Returns an existing key's secret.\n\nIts own scope rather than part of `apikeys.manage`, because the two are\ndifferent acts: rotating replaces a secret you never see, while this\nhands one over.\n\nRefused with `NOT_RETRIEVABLE` for a key issued before this product\nstored secrets recoverably - that secret was never kept, so no retry\nwill ever produce it. Rotate the key instead.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "reveal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) The key's id, as returned by the list endpoint. Never the key itself.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a8310433-1e58-4f06-a9a6-1ae9b764aa99", "name": "The key's secret.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "reveal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\",\n \"key\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dba7704-919f-4821-8b2a-860a33d38314", "name": "No credential was presented, or it is not valid.", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "reveal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7185da8c-6764-40fd-8f86-2e0f0fb6db12", "name": "The credential does not hold the scope this endpoint requires. The\nmissing scope is deliberately not named.\n", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "reveal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05dd511a-d060-4bb0-9a63-a9082420acb8", "name": "No such key in this organization, or its secret was never stored\nrecoverably (`NOT_RETRIEVABLE`).\n", "originalRequest": { "url": { "path": [ "api", "v1", "iam", "apikeys", ":id", "reveal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rc\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] } ] }, { "name": ".well-known", "description": "", "item": [ { "name": "oauth-authorization-server", "description": "", "item": [ { "id": "b6851831-c829-4c0c-9099-c606046cb291", "name": "Discovery", "request": { "name": "Discovery", "description": { "content": "RFC 8414 authorization server metadata: the endpoints, the grant types\nand the scopes this server supports.\n\nRead this rather than hardcoding endpoints. It is also served at\n`/.well-known/openid-configuration`, identically, because several\nclients probe that path first.\n", "type": "text/plain" }, "url": { "path": [ ".well-known", "oauth-authorization-server" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "71431b10-e40c-44ce-abc8-e49a9c558c7d", "name": "The server's metadata.", "originalRequest": { "url": { "path": [ ".well-known", "oauth-authorization-server" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"issuer\": \"\",\n \"authorization_endpoint\": \"\",\n \"token_endpoint\": \"\",\n \"device_authorization_endpoint\": \"\",\n \"revocation_endpoint\": \"\",\n \"scopes_supported\": [\n \"\",\n \"\"\n ],\n \"response_types_supported\": [\n \"\",\n \"\"\n ],\n \"grant_types_supported\": [\n \"\",\n \"\"\n ],\n \"code_challenge_methods_supported\": [\n \"\",\n \"\"\n ],\n \"client_id_metadata_document_supported\": \"\",\n \"token_endpoint_auth_methods_supported\": [\n \"\",\n \"\"\n ],\n \"authorization_response_iss_parameter_supported\": \"\",\n \"service_documentation\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "oauth", "description": "", "item": [ { "name": "device_authorization", "description": "", "item": [ { "id": "b00a084b-adac-4078-bea1-53cf05efb2b2", "name": "Device authorization", "request": { "name": "Device authorization", "description": { "content": "Starts the device flow. Show the `user_code` to the person and send them\nto `verification_uri`; `verification_uri_complete` has the code already\nembedded, which is what to open if you can open a browser at all.\n\nThen poll `/oauth/token`, no faster than `interval` seconds.\n", "type": "text/plain" }, "url": { "path": [ "oauth", "device_authorization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Space-delimited. Anything your client is not registered for is dropped rather than refused.", "type": "text/plain" }, "key": "scope", "value": "" }, { "disabled": false, "description": { "content": "RFC 8707: what the token is for.", "type": "text/plain" }, "key": "resource", "value": "" } ] }, "auth": null }, "response": [ { "id": "897ac838-65a7-4570-88af-64c18d529f14", "name": "A pending device authorization.", "originalRequest": { "url": { "path": [ "oauth", "device_authorization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Space-delimited. Anything your client is not registered for is dropped rather than refused.", "type": "text/plain" }, "key": "scope", "value": "" }, { "disabled": false, "description": { "content": "RFC 8707: what the token is for.", "type": "text/plain" }, "key": "resource", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"device_code\": \"\",\n \"user_code\": \"\",\n \"verification_uri\": \"\",\n \"expires_in\": \"\",\n \"interval\": \"\",\n \"verification_uri_complete\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e98773d-f76c-4c43-9aa0-8354dd74307e", "name": "`invalid_request`, `unauthorized_client` when the client may not use\nthe device flow, or `slow_down` when this address has started too\nmany authorizations.\n", "originalRequest": { "url": { "path": [ "oauth", "device_authorization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Space-delimited. Anything your client is not registered for is dropped rather than refused.", "type": "text/plain" }, "key": "scope", "value": "" }, { "disabled": false, "description": { "content": "RFC 8707: what the token is for.", "type": "text/plain" }, "key": "resource", "value": "" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"error_description\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28145416-849e-45d7-8c15-25cfb25d8411", "name": "`invalid_client`: the `client_id` is not registered.", "originalRequest": { "url": { "path": [ "oauth", "device_authorization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Space-delimited. Anything your client is not registered for is dropped rather than refused.", "type": "text/plain" }, "key": "scope", "value": "" }, { "disabled": false, "description": { "content": "RFC 8707: what the token is for.", "type": "text/plain" }, "key": "resource", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"error_description\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "authorize", "description": "", "item": [ { "id": "d0b2b02e-ce77-41de-8f0c-92e5738a8411", "name": "Authorize", "request": { "name": "Authorize", "description": { "content": "The browser entry point for the authorization-code flow. This is a\nredirect target, not something to call from code.\n\nAny client may sign in without registering first by using a Client ID\nMetadata Document: make `client_id` an https URL that serves your\nclient's metadata as JSON, naming that same URL as its `client_id`,\nwith `token_endpoint_auth_method` `none` and your `redirect_uris`. An\nhttps redirect URI must be on the same origin as the `client_id`; a\nloopback one (`http://127.0.0.1`, `http://[::1]`, `http://localhost`)\nmatches on any port. Such a client is granted `apikeys.use` at most.\n\nAn unknown `client_id` or an unregistered `redirect_uri` is shown to the\nUSER and never redirected, because sending an error to an address we\nhave not verified belongs to you is how an open redirector works.\nEverything else comes back to your `redirect_uri` with `error`, your\n`state`, and `iss`.\n", "type": "text/plain" }, "url": { "path": [ "oauth", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "redirect_uri", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "response_type", "value": "code" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "code_challenge", "value": "" }, { "disabled": false, "description": { "content": "(Required) S256, named explicitly. `plain`, or no method at all, is refused rather than downgraded.", "type": "text/plain" }, "key": "code_challenge_method", "value": "S256" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "scope", "value": "" }, { "disabled": false, "description": { "content": "Returned unchanged. Use it to bind the response to your request.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "RFC 8707. What the token is FOR, so it cannot be replayed elsewhere:\nthis brand's MCP server, the only resource it issues tokens for.\nAnything else answers `invalid_target`. A client that names none is\ngiven that server.\n", "type": "text/plain" }, "key": "resource", "value": "" } ], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b75b956f-4cfa-413a-9b8a-b721c12555e8", "name": "A redirect to the consent screen, or back to your redirect_uri with an error.", "originalRequest": { "url": { "path": [ "oauth", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "redirect_uri", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "response_type", "value": "code" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "code_challenge", "value": "" }, { "disabled": false, "description": { "content": "(Required) S256, named explicitly. `plain`, or no method at all, is refused rather than downgraded.", "type": "text/plain" }, "key": "code_challenge_method", "value": "S256" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "scope", "value": "" }, { "disabled": false, "description": { "content": "Returned unchanged. Use it to bind the response to your request.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "RFC 8707. What the token is FOR, so it cannot be replayed elsewhere:\nthis brand's MCP server, the only resource it issues tokens for.\nAnything else answers `invalid_target`. A client that names none is\ngiven that server.\n", "type": "text/plain" }, "key": "resource", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Found", "code": 302, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbf141fe-2e9f-47a0-a050-d4f334b697e9", "name": "Shown to the user. An unverified redirect target is never sent an error.", "originalRequest": { "url": { "path": [ "oauth", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "redirect_uri", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "response_type", "value": "code" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "code_challenge", "value": "" }, { "disabled": false, "description": { "content": "(Required) S256, named explicitly. `plain`, or no method at all, is refused rather than downgraded.", "type": "text/plain" }, "key": "code_challenge_method", "value": "S256" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "scope", "value": "" }, { "disabled": false, "description": { "content": "Returned unchanged. Use it to bind the response to your request.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "RFC 8707. What the token is FOR, so it cannot be replayed elsewhere:\nthis brand's MCP server, the only resource it issues tokens for.\nAnything else answers `invalid_target`. A client that names none is\ngiven that server.\n", "type": "text/plain" }, "key": "resource", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d07a8cc7-9289-4a08-aeea-ce09430ff7c4", "name": "Shown to the user. Too many authorizations from one address.", "originalRequest": { "url": { "path": [ "oauth", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "redirect_uri", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "response_type", "value": "code" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "code_challenge", "value": "" }, { "disabled": false, "description": { "content": "(Required) S256, named explicitly. `plain`, or no method at all, is refused rather than downgraded.", "type": "text/plain" }, "key": "code_challenge_method", "value": "S256" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "scope", "value": "" }, { "disabled": false, "description": { "content": "Returned unchanged. Use it to bind the response to your request.", "type": "text/plain" }, "key": "state", "value": "" }, { "disabled": false, "description": { "content": "RFC 8707. What the token is FOR, so it cannot be replayed elsewhere:\nthis brand's MCP server, the only resource it issues tokens for.\nAnything else answers `invalid_target`. A client that names none is\ngiven that server.\n", "type": "text/plain" }, "key": "resource", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "token", "description": "", "item": [ { "id": "adc8bc33-0ed2-4417-ad26-2b25dad38ba0", "name": "Token", "request": { "name": "Token", "description": { "content": "Three grant types.\n\n`urn:ietf:params:oauth:grant-type:device_code` polls a device\nauthorization. Until the person approves it answers\n`authorization_pending`; poll faster than `interval` and it answers\n`slow_down`, which means widen your interval and keep it widened.\n\n`authorization_code` exchanges a code from `/oauth/authorize`, with the\n`code_verifier` matching the challenge you sent and the same\n`redirect_uri`. A code works once: presenting it again also revokes\nwhat the first exchange issued.\n\n`refresh_token` exchanges a refresh token. The presented token is\nconsumed whatever happens next, so store the new one before using it.\nPresenting a consumed refresh token again ends the whole authorization,\nsince it means the token was copied.\n", "type": "text/plain" }, "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) `urn:ietf:params:oauth:grant-type:device_code`, `authorization_code` or `refresh_token`.", "type": "text/plain" }, "key": "grant_type", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Required by the device code grant.", "type": "text/plain" }, "key": "device_code", "value": "" }, { "disabled": false, "description": { "content": "Required by the authorization code grant.", "type": "text/plain" }, "key": "code", "value": "" }, { "disabled": false, "description": { "content": "Required by the authorization code grant.", "type": "text/plain" }, "key": "code_verifier", "value": "" }, { "disabled": false, "description": { "content": "Required by the authorization code grant: the `redirect_uri` the code was issued against, exactly.", "type": "text/plain" }, "key": "redirect_uri", "value": "" }, { "disabled": false, "description": { "content": "Authorization code grant, optional: RFC 8707, and it must name what was authorized.", "type": "text/plain" }, "key": "resource", "value": "" }, { "disabled": false, "description": { "content": "Required by the refresh token grant.", "type": "text/plain" }, "key": "refresh_token", "value": "" } ] }, "auth": null }, "response": [ { "id": "6be601d5-3c92-459f-86d0-7e7129ed3d0a", "name": "Tokens.", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) `urn:ietf:params:oauth:grant-type:device_code`, `authorization_code` or `refresh_token`.", "type": "text/plain" }, "key": "grant_type", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Required by the device code grant.", "type": "text/plain" }, "key": "device_code", "value": "" }, { "disabled": false, "description": { "content": "Required by the authorization code grant.", "type": "text/plain" }, "key": "code", "value": "" }, { "disabled": false, "description": { "content": "Required by the authorization code grant.", "type": "text/plain" }, "key": "code_verifier", "value": "" }, { "disabled": false, "description": { "content": "Required by the authorization code grant: the `redirect_uri` the code was issued against, exactly.", "type": "text/plain" }, "key": "redirect_uri", "value": "" }, { "disabled": false, "description": { "content": "Authorization code grant, optional: RFC 8707, and it must name what was authorized.", "type": "text/plain" }, "key": "resource", "value": "" }, { "disabled": false, "description": { "content": "Required by the refresh token grant.", "type": "text/plain" }, "key": "refresh_token", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"\",\n \"token_type\": \"\",\n \"expires_in\": \"\",\n \"refresh_token\": \"\",\n \"scope\": \"\",\n \"mslm:apikey_id\": \"\",\n \"mslm:apikey\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82b20456-599b-4207-a0eb-a337771ae182", "name": "An RFC 6749 error. `authorization_pending` and `slow_down` are\nnormal answers while polling a device authorization, not failures.\n`access_denied` means the person refused, and `expired_token` that\nthe device code is no longer valid: it expired, or it was already\nexchanged or refused. `invalid_grant` means the code, device code or\nrefresh token is not valid for this `client_id`. `invalid_target`\nmeans `resource` names something other than what was authorized.\n`slow_down` also answers any grant when this address sends too many\nrequests.\n", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) `urn:ietf:params:oauth:grant-type:device_code`, `authorization_code` or `refresh_token`.", "type": "text/plain" }, "key": "grant_type", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Required by the device code grant.", "type": "text/plain" }, "key": "device_code", "value": "" }, { "disabled": false, "description": { "content": "Required by the authorization code grant.", "type": "text/plain" }, "key": "code", "value": "" }, { "disabled": false, "description": { "content": "Required by the authorization code grant.", "type": "text/plain" }, "key": "code_verifier", "value": "" }, { "disabled": false, "description": { "content": "Required by the authorization code grant: the `redirect_uri` the code was issued against, exactly.", "type": "text/plain" }, "key": "redirect_uri", "value": "" }, { "disabled": false, "description": { "content": "Authorization code grant, optional: RFC 8707, and it must name what was authorized.", "type": "text/plain" }, "key": "resource", "value": "" }, { "disabled": false, "description": { "content": "Required by the refresh token grant.", "type": "text/plain" }, "key": "refresh_token", "value": "" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"error_description\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77e6184f-4f76-47af-a564-b8da34d3ca00", "name": "`invalid_client`: the `client_id` is not registered.", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) `urn:ietf:params:oauth:grant-type:device_code`, `authorization_code` or `refresh_token`.", "type": "text/plain" }, "key": "grant_type", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Required by the device code grant.", "type": "text/plain" }, "key": "device_code", "value": "" }, { "disabled": false, "description": { "content": "Required by the authorization code grant.", "type": "text/plain" }, "key": "code", "value": "" }, { "disabled": false, "description": { "content": "Required by the authorization code grant.", "type": "text/plain" }, "key": "code_verifier", "value": "" }, { "disabled": false, "description": { "content": "Required by the authorization code grant: the `redirect_uri` the code was issued against, exactly.", "type": "text/plain" }, "key": "redirect_uri", "value": "" }, { "disabled": false, "description": { "content": "Authorization code grant, optional: RFC 8707, and it must name what was authorized.", "type": "text/plain" }, "key": "resource", "value": "" }, { "disabled": false, "description": { "content": "Required by the refresh token grant.", "type": "text/plain" }, "key": "refresh_token", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"error_description\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "revoke", "description": "", "item": [ { "id": "42df5c8d-55a2-4bd9-a1bc-40ae4f66e3ba", "name": "Revoke", "request": { "name": "Revoke", "description": { "content": "RFC 7009. Always answers 200, including for a token that was never\nvalid - an endpoint that distinguished the two would be a way to test\nwhether a stolen string is a live credential.\n\nRevoking a REFRESH token ends the whole authorization and takes its\naccess tokens with it. Revoking an access token affects only that token.\n", "type": "text/plain" }, "url": { "path": [ "oauth", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) An access token or a refresh token.", "type": "text/plain" }, "key": "token", "value": "" }, { "disabled": false, "description": { "content": "Accepted and not checked.", "type": "text/plain" }, "key": "client_id", "value": "" } ] }, "auth": null }, "response": [ { "id": "7cd0fd8b-a151-4237-aa51-8e561372c39e", "name": "Always, whatever was presented.", "originalRequest": { "url": { "path": [ "oauth", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) An access token or a refresh token.", "type": "text/plain" }, "key": "token", "value": "" }, { "disabled": false, "description": { "content": "Accepted and not checked.", "type": "text/plain" }, "key": "client_id", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.vpndetection.io" } ], "info": { "_postman_id": "7c0601f5-f14c-446a-bb06-21f3a97abf1e", "name": "VPNDetection API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The VPNDetection API: classify any IP address, and download the databases\nbehind the answers.\n\nSee https://docs.vpndetection.io for guides and https://github.com/vpndetection-io\nfor the official client libraries.\n\n\nContact Support:\n Name: VPNDetection Support\n Email: support@vpndetection.io", "type": "text/plain" } } }