{"id":26538683,"url":"https://github.com/jdcoding01/qs-fivem-api","last_synced_at":"2026-05-11T16:09:27.388Z","repository":{"id":281707286,"uuid":"946158053","full_name":"jdcoding01/qs-fivem-api","owner":"jdcoding01","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-10T17:57:39.000Z","size":2,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-10T18:49:50.348Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jdcoding01.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-10T17:45:26.000Z","updated_at":"2025-03-10T17:57:42.000Z","dependencies_parsed_at":"2025-03-10T18:49:52.931Z","dependency_job_id":"113e3373-dceb-45f0-b9ff-94b073564271","html_url":"https://github.com/jdcoding01/qs-fivem-api","commit_stats":null,"previous_names":["jdcoding01/qs-fivem-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdcoding01%2Fqs-fivem-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdcoding01%2Fqs-fivem-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdcoding01%2Fqs-fivem-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdcoding01%2Fqs-fivem-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jdcoding01","download_url":"https://codeload.github.com/jdcoding01/qs-fivem-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244882028,"owners_count":20525784,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-21T23:25:05.532Z","updated_at":"2026-05-11T16:09:27.348Z","avatar_url":"https://github.com/jdcoding01.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e # qs-fivem-api\n\u003e NOTE: This API is primarily intended for usage with `qs-adminmenu` and `qs-admin-discord` packages, but can be modified to work with anything else.\n\n ## Usage\n\n`API_SECRET`: Set `Config.API_SECRET` to a unique \"password\", this has to be sent to the API as `secret` within the JSON payload to ensure request integrity.\n\n`Handle Behavior`: You can modify the \"routes\" and their respective actions, such as using external script exports, added logic within `qs-fivem-api` and more.  \n\n\n```lua\nConfig.Router = {\n    ['kick'] = {\n        label = \"Kick Player\",\n        action = function() \n            exports['qs-adminmenu']:KickPlayer()\n        end\n    },\n    ['ban'] = {\n        label = \"Ban Player\",\n        action = function() \n            exports['qs-adminmenu']:BanPlayer()\n        end\n    },\n    ['loadPlayers'] = {\n        label = \"Load Players\",\n        action = function() \n            exports['qs-adminmenu']:LoadPlayers()\n        end\n    }\n}\n```\n\n## *Each of the entries in `Config.Router` requires the corresponding parameter `action` to be sent, such as*:\n\n```json\n{\n    \"action\": \"kick\", // or ban, loadPlayers\n    \"secret\": \"your secret here\"\n}\n```\n\n### After customizing the actions (or using script defaults) make sure to `ensure qs-fivem-api` in your `server.cfg`, afterwards you can directly `POST` your API at: `https://\u003cYOUR FIVEM SERVER IP\u003e/qs-fivem-api`\n\n\u003e Note: if using localhost or have not set up SSL, use `http` instead of `https`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjdcoding01%2Fqs-fivem-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjdcoding01%2Fqs-fivem-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjdcoding01%2Fqs-fivem-api/lists"}