{"_id":"24fire-full-api","_rev":"1-8b456cd7e4e882010cbbae1ebd7e336e","name":"24fire-full-api","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"24fire-full-api","version":"1.0.0","description":"The Full 24Fire Server API.","main":"src/index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/KenleyundLeon/24Fire-Full-API.git"},"keywords":["24fire","API","SERVER-API"],"author":{"name":"Kenley M."},"license":"ISC","bugs":{"url":"https://github.com/KenleyundLeon/24Fire-Full-API/issues"},"homepage":"https://github.com/KenleyundLeon/24Fire-Full-API#readme","_id":"24fire-full-api@1.0.0","gitHead":"8e72312e31cadf05615f904add9c91abfd4394b2","_nodeVersion":"18.17.1","_npmVersion":"10.2.5","dist":{"integrity":"sha512-tm4FpLM3YSat+69QZxDJKPuzs1APO13zlkOygQ0qN/RUqJ47qQEhC6B5vh5n+K3oHqD7RV0aYq0zshKsf26/uA==","shasum":"564e0ed178c94dc760453f68b80427308636173f","tarball":"https://registry.npmjs.org/24fire-full-api/-/24fire-full-api-1.0.0.tgz","fileCount":7,"unpackedSize":2701,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIF9gp1RizZV04PZqPWZEPTvCjioYF9vyo0YNmfRkDj13AiAC0yz25hTslh6++n90khZ3/xjXUwM5eLkSeGDY3jiTgg=="}]},"_npmUser":{"name":"kenley_dev","email":"muthkenley6@gmail.com"},"directories":{},"maintainers":[{"name":"kenley_dev","email":"muthkenley6@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/24fire-full-api_1.0.0_1705504384748_0.7346278063985552"},"_hasShrinkwrap":false},"1.0.1":{"name":"24fire-full-api","version":"1.0.1","description":"The Full 24Fire Server API.","main":"src/index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/KenleyundLeon/24Fire-Full-API.git"},"keywords":["24fire","API","SERVER-API"],"author":{"name":"Kenley M."},"license":"ISC","bugs":{"url":"https://github.com/KenleyundLeon/24Fire-Full-API/issues"},"homepage":"https://github.com/KenleyundLeon/24Fire-Full-API#readme","_id":"24fire-full-api@1.0.1","gitHead":"90cf4b0dbb2dec3cfb62e3bae350fa7e7bd9954c","_nodeVersion":"18.17.1","_npmVersion":"10.2.5","dist":{"integrity":"sha512-84jzmLjH6m+w9y/D07wx+TsY0861Oeb1uO7e0BPEcHDQ5/LKIi9uX9ZJ9W9P/DnKjLYhN/BNCwbLKU761pbU3Q==","shasum":"92660a13854acfb9902fbdbfc06b82294aab74f0","tarball":"https://registry.npmjs.org/24fire-full-api/-/24fire-full-api-1.0.1.tgz","fileCount":8,"unpackedSize":5340,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDUTGzUev49e/Gr9l36dunCcRKjHdq6VWvbAvFT6fXqbAIhAOQN5B9ay/fg0FG9wG5d29gvkSlsc1g4AnOQ9xdUtMNk"}]},"_npmUser":{"name":"kenley_dev","email":"muthkenley6@gmail.com"},"directories":{},"maintainers":[{"name":"kenley_dev","email":"muthkenley6@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/24fire-full-api_1.0.1_1705507170862_0.4350764689154547"},"_hasShrinkwrap":false}},"time":{"created":"2024-01-17T15:13:04.747Z","1.0.0":"2024-01-17T15:13:04.875Z","modified":"2024-01-17T15:59:31.187Z","1.0.1":"2024-01-17T15:59:31.013Z"},"maintainers":[{"name":"kenley_dev","email":"muthkenley6@gmail.com"}],"description":"The Full 24Fire Server API.","homepage":"https://github.com/KenleyundLeon/24Fire-Full-API#readme","keywords":["24fire","API","SERVER-API"],"repository":{"type":"git","url":"git+https://github.com/KenleyundLeon/24Fire-Full-API.git"},"author":{"name":"Kenley M."},"bugs":{"url":"https://github.com/KenleyundLeon/24Fire-Full-API/issues"},"license":"ISC","readme":"# The Full 24Fire API for NodeJS.\r\n\r\n### First you need your Server API Key:\r\n![image](https://github.com/KenleyundLeon/24fire-API/assets/92249212/c3aa2e93-c6c5-4783-a425-cab027a1dca4)\r\n\r\n### Then you can use it like this:\r\n\r\nExample\r\n```js\r\nconst { config, status, start, stop, restart} = require('24fire-full-api');\r\n\r\n(async() => {\r\n\r\nconst Data = await config('YOUR_SERVER_API_KEY');\r\n\r\nconsole.log(Data);\r\n\r\n})();\r\n```\r\n\r\nit should return:\r\n```json\r\n{\r\n  \"status\": \"success\",\r\n  \"requestID\": \"9a220700-00c4-42f7-bc8c-9487f09ec72c\",\r\n  \"message\": \"VM config retrieved successfully\",\r\n  \"data\": {\r\n    \"hostsystem\": {\r\n      \"datacenter\": {\r\n        \"name\": \"SkyLink Data Center BV\",\r\n        \"country\": \"Niederlande\",\r\n        \"city\": \"Eygelshoven\"\r\n      },\r\n      \"name\": \"nl_xeon\",\r\n      \"node\": \"XEON 04\",\r\n      \"processor\": \"Intel(R) Xeon(R) CPU E5-2690 v2 @ 3.00GHz\",\r\n      \"memory\": \"DDR3 Synchronous Registered (Buffered) 1600 MHz\",\r\n      \"nvme_hard_drives\": \"Samsung SSD PM9A1\"\r\n    },\r\n    \"config\": {\r\n      \"cores\": 5,\r\n      \"mem\": 41984,\r\n      \"disk\": 70,\r\n      \"os\": {\r\n        \"name\": \"debian_11\",\r\n        \"displayname\": \"Debian 11\"\r\n      },\r\n      \"username\": \"root\",\r\n      \"password\": \"xxxxxxxxxx\",\r\n      \"hostname\": \"KVM\",\r\n      \"network_speed\": 2000,\r\n      \"backup_slots\": 2,\r\n      \"ipv4\": [\r\n        {\r\n          \"ip_address\": \"88.151.xxx.xxx\",\r\n          \"ip_gateway\": \"88.151.xxx.xxx\",\r\n          \"ddos_protection\": \"arbor\",\r\n          \"rdns\": \"24fire.de\"\r\n        }\r\n      ],\r\n      \"ipv6\": [\r\n        {\r\n          \"ip_address\": \"2a12:8641:xxxx:xxxx::\",\r\n          \"ip_gateway\": \"2a12:8641:xxxx::xxxx\",\r\n          \"requires_restart\": false\r\n        }\r\n      ]\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n### If you need 1 Value you can do it like this:\r\n\r\n```js\r\nconst { config, status, start, stop, restart} = require('24fire-full-api');\r\n\r\n(async() => {\r\n\r\nconst Data = await config('YOUR_SERVER_API_KEY');\r\n\r\nconsole.log(Data.data.config.cores);\r\n\r\n})();\r\n```\r\n\r\nThis will return the Cores Your Server has!\r\n\r\n```json\r\n10\r\n```\r\n\r\n### To start, stop or restart your server you just need to use the wrapper like this:\r\n\r\n```js\r\nconst { config, status, start, stop, restart} = require('24fire-full-api');\r\n\r\n(async() => {\r\n\r\nconst Data = await start('YOUR_SERVER_API_KEY');\r\n\r\nconsole.log(Data);\r\n\r\n})();\r\n```\r\n\r\nThe Console Log is Optional it will return:\r\n\r\n```json\r\n{\r\n  \"status\": \"success\",\r\n  \"requestID\": \"6220a191-fe11-4d56-a67d-2686b5020505\",\r\n  \"message\": \"VM power command sent\",\r\n  \"data\": []\r\n}\r\n```\r\n\r\n### If you have any Errors or Questions. Just ask me via dc: m_kenley or open an Issue report on github!","readmeFilename":"README.md"}