### Get Services List - HTTP Example Source: https://doc.nitrado.net/index This example demonstrates how to retrieve a list of services using an HTTP GET request. It requires an Authorization header with an access token. The response includes detailed information about each service, such as its ID, status, type, and associated game details. ```http GET /services HTTP/1.1 Host: api.nitrado.net Authorization: Bearer YOUR_ACCESS_TOKEN ``` -------------------------------- ### Get Game Server List (HTTP Example) Source: https://doc.nitrado.net/index This snippet demonstrates a successful HTTP request to retrieve a list of available game servers. It includes the expected JSON response structure, detailing server information such as installed status, slots, and game details. Authentication is typically handled via an 'Authorization' header. ```http HTTP/1.1 200 OK, Content-Type: application/json { "status":"success", "data":{ "installed_currently":1, "installed_maximum":5, "hide_other_mode_games":false, "steam_id":"76561197982083342", "games":[ { "id": 322, "steam_id": 251570, "has_steam_game": "unknown", "name": "7 Days To Die", "minecraft_mode": false, "publicserver_only": false, "portlist_short": "sevendtd", "folder_short": "7daystodie", "minimum_slots": 0, "slot_multiplier": null, "maximum_recommended_slots": null, "allow_outscaling": true, "modpacks": [], "icons": { "x256": "https://assets.nitrado.net/gameicons/256/7daystodie.jpg", "x120": "https://assets.nitrado.net/gameicons/120/7daystodie.jpg", "x64": "https://assets.nitrado.net/gameicons/64/7daystodie.jpg", "x32": "https://assets.nitrado.net/gameicons/32/7daystodie.jpg", "x16": "https://assets.nitrado.net/gameicons/16/7daystodie.jpg" }, "tags": [ "show_in_uwp_app" ], "preorder_locations": [], "is_xcross": false, "locations": [ 2, 3, 7, 8, 12, 14, 18 ], "visible": true, "installed": false, "active": false, "enough_slots": true, "too_many_slots": false, "allow_game_switching": true, "preorder": false, "preorder_fulfill_start_datetime": null, "preorder_fulfill_end_datetime": null }, { "id": 300, "steam_id": 107410, "has_steam_game": "unknown", "name": "Arma 3", "minecraft_mode": false, "publicserver_only": false, "portlist_short": "arma3", "folder_short": "arma3", "minimum_slots": 0, "slot_multiplier": null, "maximum_recommended_slots": null, "allow_outscaling": false, "modpacks": [ { "id": 94, "name": "SealDrop Altis Life", "modpack_version": "3.1.4.8-extDB", "modpack_file": "AltisLife-3.1.4.8-extDB-0.zip", "visible": true }, { "id": 95, "name": "(Vanilla)", "modpack_version": "1", "modpack_file": "Vanilla-1-0.zip", "visible": true } ], "icons": { "x256": "https://assets.nitrado.net/gameicons/256/arma3.jpg", "x120": "https://assets.nitrado.net/gameicons/120/arma3.jpg", "x64": "https://assets.nitrado.net/gameicons/64/arma3.jpg", "x32": "https://assets.nitrado.net/gameicons/32/arma3.jpg", "x16": "https://assets.nitrado.net/gameicons/16/arma3.jpg" }, "tags": [ "show_in_uwp_app" ], "preorder_locations": [], "is_xcross": false, "locations": [ 2, 3, 6, 7, 8, 12, 14 ], "visible": true, "installed": false, "active": false, "enough_slots": true, "too_many_slots": false, "allow_game_switching": true, "preorder": false, "preorder_fulfill_start_datetime": null, "preorder_fulfill_end_datetime": null } ] } } ``` -------------------------------- ### Example Success Response - Read Settings Source: https://doc.nitrado.net/index An example of a successful response when reading game server settings. ```JSON { "status":"success", "data":{ "settings":{ "config":{ "mysetting":"false" } } } } ``` -------------------------------- ### Example Success Response - Reset Settings Source: https://doc.nitrado.net/index An example of a successful response after resetting game server settings. ```JSON { "status":"success", "message":"Settings has been deleted." } ``` -------------------------------- ### Example Success Response - Update Settings Source: https://doc.nitrado.net/index An example of a successful response after updating game server settings. ```JSON { "status":"success", "data":{ "settings":{ "config":{ "mysetting":"true" } } } } ``` -------------------------------- ### Order Game Server (POST Request Example) Source: https://doc.nitrado.net/index This snippet outlines the parameters required to order a game server via the Nitrado API. It includes essential fields like server type, slot amount, game selection, location, and rental time. Optional parameters for promotions, preventing first start, and service switching/extending are also detailed. ```http POST https://api.nitrado.net/order/order/gameserver Authorization: Bearer YOUR_ACCESS_TOKEN Content-Type: application/json { "dimensions": { "type": "gameserver", "slot": 16, "upgrade": 8 }, "additionals": { "game": "conanexiles" }, "location": 1, "rental_time": 720, "price": 8.00 } ``` -------------------------------- ### Gameserver - Game - Install Source: https://doc.nitrado.net/index Installs a specified game onto a game server. Requires the service to be active and appropriate permissions. ```APIDOC ## POST /services/:id/gameservers/games/install ### Description Installs a specified game onto a game server. Requires the service to be active and appropriate permissions. ### Method POST ### Endpoint https://api.nitrado.net/services/:id/gameservers/games/install ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the service. #### Query Parameters None #### Request Body - **game** (string) - Required - The Folder Short of the specific game to install. - **modpack** (string) - Optional - The file name of the Modpack to install with the game. ### Request Example ```json { "game": "arma3", "modpack": "example_modpack.zip" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. - **message** (string) - A message confirming the game installation process has started. #### Response Example ```json { "status": "success", "message": "The game arma3 will be installed now" } ``` ## Error 4xx - **401** - The provided access token is not valid (anymore). - **429** - The rate limit has been exceeded. Please contact our support if you have a legit reason get a higher rate limit. - **503** - Maintenance. API is currently not available. Please come back in a few minutes and try it again. ``` -------------------------------- ### Gameserver - Game - Start Source: https://doc.nitrado.net/index Starts a specific game on a game server. Requires a valid authorization token and specifies the game to start. ```APIDOC ## POST /services/:id/gameservers/games/start ### Description Starts a specific game on a game server. ### Method POST ### Endpoint /services/:id/gameservers/games/start ### Parameters #### Header Parameters - **Authorization** (String) - Optional - Provide your access token here, alternatively you can pass it as GET Parameter. Default value: `Bearer NTFmNTQ5M2VjYjVkMzVkNWNkYjViYzIx........` - **Content-Type** (String) - Required - Media type matching content-type of request body. Possible media types: application/json, application/x-www-form-urlencoded or multipart/form-data #### Query Parameters - **game** (String) - Required - Provide the Folder Short of the specific game. ### Response #### Success Response (200) - **status** (String) - Description: Indicates the status of the operation. - **message** (String) - Description: A message confirming the game will be started. #### Response Example ```json { "status":"success", "message":"Game will be started now." } ``` ### Error Handling - **401**: The provided access token is not valid (anymore). - **429**: The rate limit has been exceeded. Please contact our support if you have a legit reason get a higher rate limit. - **503**: Maintenance. API is currently not available. Please come back in a few minutes and try it again. ``` -------------------------------- ### Start Game Server - API Request Source: https://doc.nitrado.net/index Initiates the process of starting a specific game on a game server. Requires an Authorization header and specifies the game to be started. ```HTTP POST https://api.nitrado.net/services/:id/gameservers/games/start ## Header Field | Type | Description ---|---|--- Authorization optional | String | Provide your access token here, alternatively you can pass it as GET Parameter. Default value: `Bearer NTFmNTQ5M2VjYjVkMzVkNWNkYjViYzIx........` Content-Type | String | Media type matching content-type of request body. Possible media types: application/json, application/x-www-form-urlencoded or multipart/form-data ## Parameter Field | Type | Description ---|---|--- game | String | Provide the Folder Short of the specific game. * Success-Response ``` HTTP/1.1 200 OK, Content-Type: application/json { "status":"success", "message":"Game will be started now." } ``` ## Error 4xx Name | Description ---|--- 401 | The provided access token is not valid (anymore). 429 | The rate limit has been exceeded. Please contact our support if you have a legit reason get a higher rate limit. 503 | Maintenance. API is currently not available. Please come back in a few minutes and try it again. ``` -------------------------------- ### Install Minecraft Version Source: https://doc.nitrado.net/index Installs a specific Minecraft version on the game server using its MD5 hash. ```APIDOC ## POST /services/:id/gameservers/games/minecraft/install ### Description Installs the Minecraft Version with the provided MD5 hash. ### Method POST ### Endpoint `/services/:id/gameservers/games/minecraft/install` ### Parameters #### Query Parameters - **md5** (String) - Required - Install the Minecraft Version with this MD5 hash. ### Request Example ```json { "md5": "bd1e162378c019cf3ee69ce8b6680b92" } ``` ### Response #### Success Response (200) - **status** (String) - Indicates the success of the operation. - **message** (String) - A message confirming the installation. #### Response Example ```json { "status": "success", "message": "The version \"bd1e162378c019cf3ee69ce8b6680b92\" has been installed." } ``` ## Error 4xx - **401**: The provided access token is not valid (anymore). - **429**: The rate limit has been exceeded. Please contact our support if you have a legit reason get a higher rate limit. - **503**: Maintenance. API is currently not available. Please come back in a few minutes and try it again. ``` -------------------------------- ### Example Success Response for Pricing Source: https://doc.nitrado.net/index An example of a successful JSON response when requesting pricing information, detailing available parts, rental times, and prices. ```JSON HTTP/1.1 200 OK, Content-Type: application/json { "status": "success", "data": { "prices": { "advice": 0, "rental_times": [ 720, 8760 ], "parts": [ { "type": "slot", "min_count": 4, "max_count": 6, "optional": false, "steps": [ 4, 5, 6 ], "step_names": null, "rental_times": [ { "hours": 720, "prices": [ { "count": 4, "price": 120 }, { "count": 5, "price": 150 }, { "count": 6, "price": 180 } ] }, { "hours": 8760, "prices": [ { "count": 4, "price": 1440 }, { "count": 5, "price": 1800 }, { "count": 6, "price": 2160 } ] } ] } ] } } } ``` -------------------------------- ### Service Details - HTTP Example Source: https://doc.nitrado.net/index This example shows how to fetch detailed information for a specific service using its ID. The request is a GET request to the /services/:id endpoint. The 'Required service status' indicates that all service statuses are relevant for this endpoint. ```http GET https://api.nitrado.net/services/:id ``` -------------------------------- ### GET / Source: https://doc.nitrado.net/index Provides a welcome message and a link to the API documentation. ```APIDOC ## GET / ### Description Provides a welcome message and a link to the API documentation. ### Method GET ### Endpoint https://api.nitrado.net/ ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **status** (string) - Indicates the status of the request, e.g., "success". - **message** (string) - A welcome message. - **data** (object) - Contains additional data. - **docs** (string) - URL to the API documentation. #### Response Example ```json { "status": "success", "message": "Welcome to the Nitrado API", "data": { "docs": "https://doc.nitrado.net" } } ``` ``` -------------------------------- ### Install Minecraft Version via MD5 Hash Source: https://doc.nitrado.net/index Installs a specific Minecraft version using its MD5 hash. Requires an Authorization header and specifies the Content-Type. Returns a success or error status. ```http POST https://api.nitrado.net/services/:id/gameservers/games/minecraft/install Header: Authorization: Bearer YOUR_ACCESS_TOKEN Content-Type: application/json Body: { "md5": "bd1e162378c019cf3ee69ce8b6680b92" } Success-Response: HTTP/1.1 200 OK Content-Type: application/json { "status":"success", "message":"The version \"bd1e162378c019cf3ee69ce8b6680b92\" has been installed." } ``` -------------------------------- ### Start Game Server (API Endpoint) Source: https://doc.nitrado.net/index This section details the API endpoint for starting a game server. It requires the service ID and specific permissions (ROLE_GAMESERVER_CHANGE_GAME). The service must also be in an active state (SERVICE_STATUS_ACTIVE). ```http POST https://api.nitrado.net/services/:id/gameservers/games/start ``` -------------------------------- ### Example Success Response for Promo Code Usage Source: https://doc.nitrado.net/index An example of a successful JSON response when checking promo code usage, indicating whether the service has used the code. ```JSON HTTP/1.1 200 OK, Content-Type: application/json { "data": { "has_used": false }, "status": "success" } ``` -------------------------------- ### Install Game on Gameserver (API) Source: https://doc.nitrado.net/index Installs a specified game onto a Nitrado game server. Requires a valid access token and the service must be active. The 'game' parameter is mandatory, and 'modpack' is optional. ```http POST https://api.nitrado.net/services/:id/gameservers/games/install --- Header: Authorization: Bearer Content-Type: application/json Parameter: { "game": "arma3", "modpack": "example_modpack" } ``` ```json { "status":"success", "message":"The game arma3 will be installed now" } ``` -------------------------------- ### Get Gameserver File Bookmarks (GET) Source: https://doc.nitrado.net/index Retrieves a list of bookmarked file paths for a game server. Requires authentication and the service to be active. The response contains a list of bookmark strings. ```HTTP GET https://api.nitrado.net/services/:id/gameservers/file_server/bookmarks Authorization: Bearer ``` -------------------------------- ### Success Response Example for Single Game Pricing Source: https://doc.nitrado.net/index Example of a successful HTTP 200 OK response when requesting pricing for a single game. Includes game title, short identifier, minimum price, minimum slots, and currency. ```JSON { "status": "success", "data": { "gameinfo": { "title": "Minecraft (Vanilla)", "short": "minecraft", "price_min": 130, "slots_min": 4, "currency": "USD" } } } ``` -------------------------------- ### Success Response Example for Multiple Games Pricing Source: https://doc.nitrado.net/index Example of a successful HTTP 200 OK response when requesting pricing for multiple games. Returns an array of game information objects, each with title, short identifier, minimum price, minimum slots, and currency. ```JSON { "status": "success", "data": { "gameinfos": [ { "title": "Minecraft (Vanilla)", "short": "minecraft", "price_min": 130, "slots_min": 4, "currency": "USD" }, { "title": "DayZ", "short": "dayz", "price_min": 130, "slots_min": 4, "currency": "USD" } ] } } ``` -------------------------------- ### GET /offer_pages Source: https://doc.nitrado.net/index Returns the list of offer pages. ```APIDOC ## GET /offer_pages ### Description Returns the list of offer pages. ### Method GET ### Endpoint https://api.nitrado.net/offer_pages ``` -------------------------------- ### API Authentication Example Source: https://doc.nitrado.net/index This snippet demonstrates how to authenticate with the Nitrado API. Authorization can be provided as an 'Authorization' header with a Bearer token or as a GET parameter. The default token is provided as an example. ```HTTP GET /api/games HTTP/1.1 Host: api.nitrado.net Authorization: Bearer NTFmNTQ5M2VjYjVkMzVkNWNkYjViYzIx........ ``` -------------------------------- ### Get Notifications - HTTP Example Source: https://doc.nitrado.net/index This snippet demonstrates the structure of a successful response when retrieving notifications from the Nitrado API. It includes details about host systems, games, locations, product types, and the notification message. The Authorization header is required. ```http HTTP/1.1 200 OK, Content-Type: application/json { "status": "success", "data": { "notifications": [ { "hostsystems": [], "games": [], "locations": [ "Buenos Aires" ], "domain_tlds": [ "com", "net" ], "level": "INFO", "product_types": [ "domain" ], "message": "There is currently a problem with our DNS servers. We will do everything we can to get your domain back up and running as soon as possible. Thank you for your patience and understanding." }, { "hostsystems": [ "host234" ], "games": [ "DayZ (PS4)", "DayZ (Xbox One)" ], "locations": [ "Los Angeles", "Frankfurt am Main" ], "domain_tlds": [], "level": "SEVERE", "product_types": [ "gameserver" ], "message": "Unfortunately there is problem with the hostsystem 'host234'. We are currently investigating the issue and locating the reason." }, { "hostsystems": [ "host181", "host257" ], "games": [ "Conan Exiles" ], "locations": [ "Los Angeles" ], "domain_tlds": [], "level": "WARNING", "product_types": [ "gameserver" ], "message": "Due to the last update, which was rolled out on 12.05.2019 , there are unfortunately difficulties with the modifications at Conan Exiles. Currently the Conan Exiles game servers only run without modifications. We are currently investigating the issue and locating the reason." }, { "hostsystems": [], "games": [], "locations": [ "Frankfurt am Main" ], "domain_tlds": [], "level": "SEVERE", "product_types": [ "gameserver", "domain" ], "message": "Unfortunately all services of the location 'Frankfurt am Main' are affected by a downtime. We are currently investigating the issue and locating the reason." } { "hostsystems": [ "host1892", "host37", "host9875" ], "games": [ "DayZ (PS4)", "DayZ (Xbox One)" ], "locations": [ "Frankfurt am Main" ], "domain_tlds": [], "level": "SUCCESS", "product_types": [ "gameserver" ], "message": "The Dayz servers at Frankfurt am Main were successfully rebooted." } ] } } ``` -------------------------------- ### POST /services/:id/gameservers/games/minecraft/overviewmap_render Source: https://doc.nitrado.net/index Starts the rendering process for the Minecraft overview map. Requires active service status and appropriate permissions. ```APIDOC ## POST /services/:id/gameservers/games/minecraft/overviewmap_render ### Description Starts the rendering process for the Minecraft overview map. This endpoint requires the service to be active and the user to have the `ROLE_WEBINTERFACE_GENERAL_CONTROL` permission. ### Method POST ### Endpoint `https://api.nitrado.net/services/:id/gameservers/games/minecraft/overviewmap_render` ### Parameters #### Header Parameters - **Authorization** (String) - Optional - Provide your access token here. Default value: `Bearer NTFmNTQ5M2VjYjVkMzVkNWNkYjViYzIx........` ### Request Example (No request body is specified for this endpoint) ### Response #### Success Response (200) - **status** (String) - Indicates the success of the operation. - **message** (String) - A message confirming that the overview map rendering has been started. #### Response Example ```json { "status":"success", "message":"The overview map rendering has been started" } ``` ### Error Handling - **401**: The provided access token is not valid (anymore). - **429**: The rate limit has been exceeded. - **503**: Maintenance. API is currently not available. ``` -------------------------------- ### Get User Details - Success Response Source: https://doc.nitrado.net/index This is an example of a successful response when fetching user details from the Nitrado API. It includes user ID, username, activation status, contact information, credit balance, registration date, and profile details. ```JSON { "status":"success", "data":{ "user":{ "user_id":1337, "username":"Marty", "activated":true, "timezone":"America/Los_Angeles", "email":"marty.mcfly@biffco.com", "credit":1955, "currency":"EUR", "registered":"1985-25-10T01:15:00.000+00:00", "language":"eng", "avatar":"https://server.nitrado.net/users.nitrado/1337.jpg", "donations":true, "two_factor":[ "u2f", "google" ], "profile":{ "name":"Marty McFly", "street":"DeLorean Street 12", "postcode":"2209", "city":"Hill Valley", "country":"US", "state":"CA", "country_and_state_verified":true, "newsletter":true }, "permissions": [ "TWITCH_WHITELISTING" ], "employee":false, "partner_id": 139, "can_update_username": false, "newsletter_campaigns": [ { "id": 1, "offer_page_id": 467, "loca_key": "nlc_squad", "name": "Newsletter Campaign für Squad", "game_name": "squad" } ], "allowed_to_spend_credits": true, "has_rootserver": false } } } ``` -------------------------------- ### Get Minecraft Server Status (HTTP) Source: https://doc.nitrado.net/index This snippet demonstrates how to retrieve the current status and configuration of a Minecraft server using the Nitrado API. It requires an Authorization header with an access token. The response includes details about running tasks, worlds, backups, and installed versions. ```http GET /services/:id/gameservers/games/minecraft HTTP/1.1 Host: api.nitrado.net Authorization: Bearer YOUR_ACCESS_TOKEN ``` -------------------------------- ### Get Service Notifications (JSON Example) Source: https://doc.nitrado.net/index Retrieves an array of active notifications for a given service. The response includes details such as notification ID, service ID, type, level, message, and creation timestamp. It handles various error codes like 401 (invalid token), 429 (rate limit exceeded), and 503 (maintenance). ```json HTTP/1.1 200 OK, Content-Type: application/json { "status": "success", "data": { "notifications": { "23640": [ { "id": 50, "service_id": 23640, "type": "default", "level": "SEVERE", "error_id": false, "dismissed": false, "message": "fsdfg dfg fg dfg dfg adf", "message_bbcode": "fsdfg dfg fg dfg dfg adf", "message_long": "", "message_long_bbcode": "", "actions": [], "data": {}, "created_at": "2021-12-03T17:31:14", "created_at_timestamp": 1638545474, "lifetime": false } ] } } } ``` ```json HTTP/1.1 200 OK, Content-Type: application/json { "status":"success", "data":{ "notifications": [{ "id" => 1, // The notification's id "service_id" => 42, // The service's id "type" => "cloud_server_network_disabled", // Type that allows for special handling of specific message types "level" => "SEVERE", // One of SEVERE, WARNING, INFO, SUCCESS, DEBUG "error_id" => false, // An error id if the message is the result of an error "dismissed" => false, // True if the message has been dismissed by the user "message" => "Hello world!", // The localized notification message "data" => { // Additional data specific to the notification type "some_type_specific_key" : "some_type_specific_value" }, "created_at" => "2017-07-07T16:27:39", // Creation time in the user's time zone "created_at_timestamp" => 1499437701, // Creation time as UNIX time stamp "lifetime" => false // If set, lifetime (in seconds) of the notification }] } } ``` -------------------------------- ### POST /services/:id/gameservers/games/start Source: https://doc.nitrado.net/index Starts a game server for a specific service ID. Requires the 'ROLE_GAMESERVER_CHANGE_GAME' permission and the service must be in the 'SERVICE_STATUS_ACTIVE' state. ```APIDOC ## POST /services/:id/gameservers/games/start ### Description Starts a game server for a given service ID. This action requires specific permissions and service status. ### Method POST ### Endpoint /services/:id/gameservers/games/start ### Parameters #### Path Parameters - **id** (String) - Required - The unique identifier of the service. #### Query Parameters (None) #### Request Body (None specified in the provided text) ### Request Example (No request body example provided) ### Response #### Success Response (200) (Success response details not provided in the input text) #### Error Responses - **401** - Unauthorized: The provided access token is not valid (anymore). - **429** - Too Many Requests: The rate limit has been exceeded. - **503** - Service Unavailable: Maintenance. API is currently not available. ``` -------------------------------- ### POST /services/:id/gameservers/packages/install Source: https://doc.nitrado.net/index Triggers the installation of a specified package on a Nitrado gameserver. The gameserver must be in an active state for this operation to succeed. ```APIDOC ## POST /services/:id/gameservers/packages/install ### Description Triggers a package installation for a specific gameserver. ### Method POST ### Endpoint https://api.nitrado.net/services/:id/gameservers/packages/install ### Parameters #### Path Parameters - **id** (String) - Required - The unique identifier of the service. #### Query Parameters None #### Request Body - **package** (String) - Required - The name of the package to install. - **version** (String) - Optional - The specific version of the package to install. Defaults to the latest version if not provided. ### Request Example ```json { "package": "my_game_server_package", "version": "1.2.3" } ``` ### Response #### Success Response (200) - **status** (String) - Indicates the success of the operation. - **message** (String) - A message confirming the package installation request. #### Response Example ```json { "status": "success", "message": "Package installation triggered successfully." } ``` ### Error Handling - **SERVICE_STATUS_INACTIVE**: The gameserver is not in an active state. - **INVALID_PACKAGE**: The specified package does not exist. - **INVALID_VERSION**: The specified version is not available for the package. ``` -------------------------------- ### GET /company/trustpilot Source: https://doc.nitrado.net/index Get the Trustpilot rating for the company. ```APIDOC ## GET /company/trustpilot ### Description Get the Trustpilot rating for the company. ### Method GET ### Endpoint https://api.nitrado.net/company/trustpilot ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. - **data** (object) - Contains Trustpilot rating information. - **amount** (integer) - The number of reviews. - **rating** (number) - The average rating. #### Response Example ```json { "status": "success", "data": { "amount": 4500, "rating": 4.5 } } ``` ``` -------------------------------- ### GET /services/:id/webinterface_login Source: https://doc.nitrado.net/index Get a login URL for the web interface of a specific game service. ```APIDOC ## GET /services/:id/webinterface_login ### Description Get a login URL for the web interface of a specific game service. ### Method GET ### Endpoint https://api.nitrado.net/services/:id/webinterface_login ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the service. #### Header Parameters - **Authorization** (string) - Optional - Provide your access token here. Default value: `Bearer NTFmNTQ5M2VjYjVkMzVkNWNkYjViYzIx........` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. - **data** (object) - Contains the web interface login details. - **url** (string) - The URL to access the web interface. - **expires_at** (integer) - The timestamp when the login URL expires. #### Response Example ```json { "status": "success", "data": { "url": "https://webinterface.nitrado.net/?access_token=abcdefghijklmnop&service_id=1&lable=ni", "expires_at": 1662794992 } } ``` ### Error Handling - **401**: Unauthorized - The provided access token is not valid. - **429**: Too Many Requests - The rate limit has been exceeded. - **503**: Service Unavailable - Maintenance. API is currently not available. ``` -------------------------------- ### Rootserver - Power on Source: https://doc.nitrado.net/index Initiate a power on command for a root server's IPMI interface. ```APIDOC ## POST /rootservers/:id/ipmi/power_on ### Description Initiates a power on command for the IPMI interface of a specific root server. ### Method POST ### Endpoint /rootservers/:id/ipmi/power_on ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the root server. #### Query Parameters This endpoint does not have query parameters. #### Request Body This endpoint does not require a request body. ### Request Example (No request body needed for POST request) ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. #### Response Example ```json { "status": "success" } ``` ### Error Handling - **401**: The provided access token is not valid (anymore). - **429**: The rate limit has been exceeded. Please contact our support if you have a legit reason to get a higher rate limit. - **503**: Maintenance. API is currently not available. Please come back in a few minutes and try again. ``` -------------------------------- ### Create Gameserver Directory (POST) Source: https://doc.nitrado.net/index Creates a new directory within the game server's file system. Requires read and write permissions and the service to be active. Specify the path for the new directory. ```HTTP POST https://api.nitrado.net/services/:id/gameservers/file_server/mkdir Authorization: Bearer Content-Type: application/json { "path": "/path/to/new_directory" } ``` -------------------------------- ### GET /websites/doc_nitrado_net Source: https://doc.nitrado.net/index Retrieves active notification campaigns for the current user. An authorization token can be provided in the header or as a GET parameter. ```APIDOC ## GET /websites/doc_nitrado_net ### Description Retrieves a list of active notification campaigns for the current user. The Authorization header can be used to provide an access token. ### Method GET ### Endpoint /websites/doc_nitrado_net ### Parameters #### Header Parameters - **Authorization** (String) - Optional - Provide your access token here, alternatively you can pass it as GET Parameter. Default value: `Bearer NTFmNTQ5M2VjYjVkMzVkNWNkYjViYzIx........` ### Response #### Success Response (200) - **status** (String) - Indicates the success of the operation. - **data** (Object) - Contains the notification campaign data. - **campaigns** (Array) - A list of notification campaigns. - **key** (String) - The unique identifier for the campaign. - **hidable** (Boolean) - Indicates if the campaign can be hidden by the user. #### Response Example ```json { "status": "success", "data": { "campaigns": [ { "key": "notification165", "hidable": true }, { "key": "testcampaign5612", "hidable": false } ] } } ``` ## Error 4xx - **401** - The provided access token is not valid (anymore). - **429** - The rate limit has been exceeded. Please contact our support if you have a legit reason get a higher rate limit. - **503** - Maintenance. API is currently not available. Please come back in a few minutes and try it again. ``` -------------------------------- ### List Files and Directories - HTTP Request Source: https://doc.nitrado.net/index This snippet demonstrates how to list files and directories within a specified directory on the gameserver. Optional parameters allow filtering and summarizing folder sizes. The response includes details about each entry. ```http GET https://api.nitrado.net/services/:id/gameservers/file_server/list HTTP/1.1 200 OK, Content-Type: application/json { "status":"success", "data":{ "entries":[ { "type":"file", "path":"/games/ni1_1/ftproot/restart.log", "name":"restart.log", "size":7242, "owner":"ni1_1", "group":"ni1_1", "chmod":"100660", "created_at":1430319118, "modified_at":1430319118, "accessed_at":1430298175 }, { "type":"dir", "path":"/games/ni1_1/ftproot/minecraft", "name":"minecraft", "owner":"ni1_1", "group":"ni1_1", "chmod":"40775", "created_at":1430306359, "modified_at":1430306359 } ] } } ``` -------------------------------- ### GET /websites/doc_nitrado_net Source: https://doc.nitrado.net/index Retrieves a list of services associated with the authenticated user. The Authorization header is required, or the token can be passed as a GET parameter. ```APIDOC ## GET /websites/doc_nitrado_net ### Description Retrieves a list of services associated with the authenticated user. The Authorization header is required, or the token can be passed as a GET parameter. ### Method GET ### Endpoint /websites/doc_nitrado_net ### Parameters #### Query Parameters - **Authorization** (String) - Optional - Provide your access token here, alternatively you can pass it as GET Parameter. Default value: `Bearer NTFmNTQ5M2VjYjVkMzVkNWNkYjViYzIx........` ### Response #### Success Response (200) - **status** (String) - Indicates the success of the operation. - **data** (Object) - Contains the list of services. - **services** (Array) - A list of service objects. - **id** (Integer) - The unique identifier for the service. - **location_id** (Integer) - The identifier for the service's location. - **status** (String) - The current status of the service (e.g., "active"). - **websocket_token** (String) - A token for WebSocket communication. - **user_id** (Integer) - The identifier of the user who owns the service. - **comment** (String) - A user-defined comment for the service. - **auto_extension** (Boolean) - Indicates if auto-extension is enabled. - **auto_extension_duration** (null) - Duration for auto-extension (if applicable). - **auto_extension_external** (Boolean) - Indicates if external auto-extension is enabled. - **type** (String) - The type of service (e.g., "gameserver"). - **sub_type** (String) - The sub-type of the service (e.g., "public"). - **type_human** (String) - A human-readable description of the service type. - **managedroot_id** (Integer/null) - The ID of the managed root server, if applicable. - **details** (Object) - Specific details about the service. - **address** (String) - The network address of the service. - **name** (String) - The name of the service. - **game** (String) - The game associated with the service. - **portlist_short** (String) - Short identifier for the port list. - **folder_short** (String) - Short identifier for the game folder. - **slots** (Integer) - The number of slots available for the service. - **start_date** (String) - The date when the service started. - **suspend_date** (String) - The date when the service was suspended. - **delete_date** (String) - The date when the service was scheduled for deletion. - **username** (String) - The username associated with the service. - **roles** (Array) - A list of roles assigned to the user for this service. #### Response Example ```json { "status": "success", "data": { "services": [ { "id": 3, "location_id": 2, "status": "active", "websocket_token": "b05ac3d5d71a8858fca3011a8c179f1d9ec5ab41", "user_id": 2, "comment": "This is my special Battlefield Server.", "auto_extension": false, "auto_extension_duration": null, "auto_extension_external": false, "type": "gameserver", "sub_type": "public", "type_human": "Gameserver 16 Slots", "managedroot_id": null, "details": { "address": "10.10.0.6:27015", "name": "Nitrado.net Battlefield 4 Server", "game": "Battlefield 4", "portlist_short": "bf4", "folder_short": "bf4", "slots": 16 }, "start_date": "2015-08-11T13:01:01", "suspend_date": "2017-02-09T22:26:46", "delete_date": "2017-02-19T22:26:46", "username": "ni2_1", "roles": [ "ROLE_OWNER" ] } ] } } ``` ### Error Handling - **401**: The provided access token is not valid (anymore). - **429**: The rate limit has been exceeded. Please contact our support if you have a legit reason get a higher rate limit. - **503**: Maintenance. API is currently not available. Please come back in a few minutes and try it again. ``` -------------------------------- ### GET /services/:id/gameservers/games/minecraft Source: https://doc.nitrado.net/index Retrieves details for the Minecraft game server. This endpoint is used to get general information about the Minecraft server instance. ```APIDOC ## GET /services/:id/gameservers/games/minecraft ### Description Retrieves details for the Minecraft game server. This endpoint is used to get general information about the Minecraft server instance. ### Method GET ### Endpoint `/services/:id/gameservers/games/minecraft` ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the game server service. #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) (Response structure not provided in the input text, but would typically include server status, configuration, etc.) #### Response Example (Example response not provided in the input text.) ## Error 4xx - **401** - The provided access token is not valid (anymore). - **429** - The rate limit has been exceeded. Please contact our support if you have a legit reason get a higher rate limit. - **503** - Maintenance. API is currently not available. Please come back in a few minutes and try it again. ```