NAV
bash javascript

Info

Welcome to the generated API reference. Get Postman Collection

xinfo

xinfo is very smart artificial intelligence bot, which manages the whole xShellz API. Check xinfo page for more info.

Sayonirc

This method allows you to sayonirc.

Example request:

curl "https://www.xshellz.com/api/xinfo/sayonirc" \
-H "Accept: application/json" \
    -d "msg"="in" \
    -d "channel"="in" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/sayonirc",
    "method": "POST",
    "data": {
        "msg": "in",
        "channel": "in"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/xinfo/sayonirc

Parameters

Parameter Type Status Description
msg string required Minimum: 3 Maximum: 5000
channel string required Minimum: 1 Maximum: 5000

Userban

This method allows you to ban user account, but make sure that all services are banned first, before running this userban method.

Example request:

curl "https://www.xshellz.com/api/xinfo/userban" \
-H "Accept: application/json" \
    -d "username"="aut" \
    -d "banreason"="aut" \
    -d "banned_where"="aut" \
    -d "banned_by_username"="aut" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/userban",
    "method": "POST",
    "data": {
        "username": "aut",
        "banreason": "aut",
        "banned_where": "aut",
        "banned_by_username": "aut"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/xinfo/userban

Parameters

Parameter Type Status Description
username string required Minimum: 3 Maximum: 255
banreason string required Minimum: 1 Maximum: 5000
banned_where string required Minimum: 1 Maximum: 5000
banned_by_username string required Minimum: 1 Maximum: 5000

Userunban

This method allows you to unban user account, however his services may still be banned.

Example request:

curl "https://www.xshellz.com/api/xinfo/userunban" \
-H "Accept: application/json" \
    -d "username"="sunt" \
    -d "unbanned_where"="sunt" \
    -d "unbanned_by_username"="sunt" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/userunban",
    "method": "POST",
    "data": {
        "username": "sunt",
        "unbanned_where": "sunt",
        "unbanned_by_username": "sunt"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/xinfo/userunban

Parameters

Parameter Type Status Description
username string required Minimum: 3 Maximum: 255
unbanned_where string required Minimum: 1 Maximum: 5000
unbanned_by_username string required Minimum: 1 Maximum: 5000

Approve shell

This method allows you to approve free shell account with the same name of the user account.

Example request:

curl "https://www.xshellz.com/api/xinfo/approve" \
-H "Accept: application/json" \
    -d "username"="ut" \
    -d "approved_where"="ut" \
    -d "approved_by_username"="ut" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/approve",
    "method": "POST",
    "data": {
        "username": "ut",
        "approved_where": "ut",
        "approved_by_username": "ut"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/xinfo/approve

Parameters

Parameter Type Status Description
username string required Minimum: 3 Maximum: 255
approved_where string required Minimum: 1 Maximum: 5000
approved_by_username string required Minimum: 1 Maximum: 5000

Disapprove shell

This method allows you to disapprove shell.

Example request:

curl "https://www.xshellz.com/api/xinfo/disapprove" \
-H "Accept: application/json" \
    -d "username"="rerum" \
    -d "disapproved_where"="rerum" \
    -d "disapproved_by_username"="rerum" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/disapprove",
    "method": "DELETE",
    "data": {
        "username": "rerum",
        "disapproved_where": "rerum",
        "disapproved_by_username": "rerum"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE api/xinfo/disapprove

Parameters

Parameter Type Status Description
username string required Minimum: 3 Maximum: 255
disapproved_where string required Minimum: 1 Maximum: 5000
disapproved_by_username string required Minimum: 1 Maximum: 5000

Info about shell

This method allows you to show some shell info.

Example request:

curl "https://www.xshellz.com/api/xinfo/info/{username}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/info/{username}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/xinfo/info/{username}

Info about banned shell

This method allows you to show some banned shell info.

Example request:

curl "https://www.xshellz.com/api/xinfo/banned/{username}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/banned/{username}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/xinfo/banned/{username}

Ban shell

This method allows you to ban shell account, which first disapproves it and then turns it to state banned.

Example request:

curl "https://www.xshellz.com/api/xinfo/ban" \
-H "Accept: application/json" \
    -d "username"="aut" \
    -d "banreason"="aut" \
    -d "banned_where"="aut" \
    -d "banned_by_username"="aut" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/ban",
    "method": "DELETE",
    "data": {
        "username": "aut",
        "banreason": "aut",
        "banned_where": "aut",
        "banned_by_username": "aut"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE api/xinfo/ban

Parameters

Parameter Type Status Description
username string required Minimum: 3 Maximum: 255
banreason string required Minimum: 1 Maximum: 5000
banned_where string required Minimum: 1 Maximum: 5000
banned_by_username string required Minimum: 1 Maximum: 5000

Unban shell

This method allows you to unban shell account, which first unbans it and then turns it to state approved.

Example request:

curl "https://www.xshellz.com/api/xinfo/unban" \
-H "Accept: application/json" \
    -d "username"="est" \
    -d "unbanned_where"="est" \
    -d "unbanned_by_username"="est" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/unban",
    "method": "POST",
    "data": {
        "username": "est",
        "unbanned_where": "est",
        "unbanned_by_username": "est"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/xinfo/unban

Parameters

Parameter Type Status Description
username string required Minimum: 3 Maximum: 255
unbanned_where string required Minimum: 1 Maximum: 5000
unbanned_by_username string required Minimum: 1 Maximum: 5000

Keep shell

This method allows you to keep free shell account..

Example request:

curl "https://www.xshellz.com/api/xinfo/keep/{username}" \
-H "Accept: application/json" \
    -d "keeped_where"="et" \
    -d "keeped_by_username"="et" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/keep/{username}",
    "method": "POST",
    "data": {
        "keeped_where": "et",
        "keeped_by_username": "et"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/xinfo/keep/{username}

Parameters

Parameter Type Status Description
keeped_where string required Minimum: 1 Maximum: 5000
keeped_by_username string required Minimum: 1 Maximum: 5000

Shell description

This method allows you to show shell account description.

Example request:

curl "https://www.xshellz.com/api/xinfo/shelldesc/{username}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/shelldesc/{username}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/xinfo/shelldesc/{username}

Number of tickets

This method allows you to show ticket stats.

Example request:

curl "https://www.xshellz.com/api/xinfo/tickets" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/tickets",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/xinfo/tickets

IP2Country

This method allows you to turn IP to country.

Example request:

curl "https://www.xshellz.com/api/xinfo/ip2country/{ip}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/ip2country/{ip}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/xinfo/ip2country/{ip}

Signed

This method allows you to see how many members signed up in the last hours.

Example request:

curl "https://www.xshellz.com/api/xinfo/signed/{hours}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/signed/{hours}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/xinfo/signed/{hours}

Run build

This method allows you to run build for xShellz version X and all X tests.

Example request:

curl "https://www.xshellz.com/api/xinfo/build" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/build",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/xinfo/build

Get last build

This method allows you to get build info for xShellz version X and all X tests.

Example request:

curl "https://www.xshellz.com/api/xinfo/lastbuild" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/lastbuild",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/xinfo/lastbuild

Get State for id

This method allows you to get all the info about state for a id.

Example request:

curl "https://www.xshellz.com/api/xinfo/state/{id}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/state/{id}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/xinfo/state/{id}

api/xinfo/clearjobsqueue

Example request:

curl "https://www.xshellz.com/api/xinfo/clearjobsqueue" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/clearjobsqueue",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/xinfo/clearjobsqueue

Get manage log for id

This method allows you to get maange log for a id.

Example request:

curl "https://www.xshellz.com/api/xinfo/managelog/{id}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/managelog/{id}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/xinfo/managelog/{id}

Get manage log for id

This method allows you to update maange log for a id.

Example request:

curl "https://www.xshellz.com/api/xinfo/updatemanagelog/{id}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/updatemanagelog/{id}",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/xinfo/updatemanagelog/{id}

Insert Manage Log

This method allows you to insert manage logs.

Example request:

curl "https://www.xshellz.com/api/xinfo/insertmanagelog" \
-H "Accept: application/json" \
    -d "service_id"="voluptatem" \
    -d "action"="voluptatem" \
    -d "type"="voluptatem" \
    -d "server"="voluptatem" \
    -d "username"="voluptatem" \
    -d "password"="voluptatem" \
    -d "instantsetup"="voluptatem" \
    -d "ircd"="voluptatem" \
    -d "path"="voluptatem" \
    -d "services"="voluptatem" \
    -d "ip"="voluptatem" \
    -d "servername"="voluptatem" \
    -d "hostname"="voluptatem" \
    -d "operusername"="voluptatem" \
    -d "operpassword"="voluptatem" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://www.xshellz.com/api/xinfo/insertmanagelog",
    "method": "POST",
    "data": {
        "service_id": "voluptatem",
        "action": "voluptatem",
        "type": "voluptatem",
        "server": "voluptatem",
        "username": "voluptatem",
        "password": "voluptatem",
        "instantsetup": "voluptatem",
        "ircd": "voluptatem",
        "path": "voluptatem",
        "services": "voluptatem",
        "ip": "voluptatem",
        "servername": "voluptatem",
        "hostname": "voluptatem",
        "operusername": "voluptatem",
        "operpassword": "voluptatem"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/xinfo/insertmanagelog

Parameters

Parameter Type Status Description
service_id string required Minimum: 1 Maximum: 255
action string required Minimum: 1 Maximum: 5000
type string required Minimum: 1 Maximum: 5000
server string required Minimum: 1 Maximum: 255
username string required Minimum: 1 Maximum: 5000
password string required Minimum: 1 Maximum: 5000
instantsetup string required Minimum: 1 Maximum: 255
ircd string required Minimum: 1 Maximum: 5000
path string required Minimum: 1 Maximum: 5000
services string required Minimum: 1 Maximum: 255
ip string required Minimum: 1 Maximum: 5000
servername string required Minimum: 1 Maximum: 5000
hostname string required Minimum: 1 Maximum: 5000
operusername string required Minimum: 1 Maximum: 5000
operpassword string required Minimum: 1 Maximum: 5000