API Queries

Here are the graphql queries for interacting with your LxRoot control panel through code.

Access & Authentication

access(id: Int!
token: String!
): AccessRole
# Get AccessRole by id

auth(username: String!
apikey: String!
): Auth
# Get Auth info

Accounts & Billing

account(token: String!
id: String!
): Account
# Get Account by id

item(token: String!
id: Int!
): Item
# Get item by id

itemCategory(id: Int!
token: String!
): ItemCategory
# Get itemCategory by id

Domain & DNS

domain(token: String!
name: String!
): Domain
# Get Domain info

dnsRecordBy(name: String
type: String
token: String!
domain: String!
): [Records]
# Get DNS Info

dnssec(token: String!
domain: String!
): DNSSEC
# Get DNSSEC Info

checkDnsError(token: String!
domain: String!
): [DnsZoneError]
# Get DnsZoneError Info

Database Management

database(token: String!
id: String!
): Database
# Get Database by id

databaseUser(id: String!
token: String!
): DatabaseUser
# Get DatabaseUser by id

databaseUserByDatabaseId(token: String!
database_id: String!
): [DatabaseUser]
# Get DatabaseUser list by databaseID

Linux System & Users

linuxUser(token: String!
name: String!
): LinuxUser
# Get linux user info by name

linuxUserList(token: String!): [LinuxUser]
# Get Linux User Details Info

linuxUserGroups(username: String!
token: String!
): [LinuxUserGroup]
# Get Linux user group list

linuxGroup(name: String!
token: String!
): LinuxUserGroup
# Get linux user group info by name

linuxGroupList(token: String!): [LinuxUserGroup]
# Get Linux Group List

linuxGroupUsers(token: String!
groupname: String!
): [LinuxUser]
# Get Linux group user list

findProcess(token: String!
type: String!
value: String!
): [Process]
# Get linux process list

FTP Management

ftpuser(token: String!
id: String!
): FtpUser
# Get FTPuser by id

ftpuserByDomain(token: String!
domain: String!
): [FtpUser]
# Get FTPuser list

Access & Authentication

listAccess(token: String!): [AccessRole]
# Get Access list

tokenClaim(token: String!): Claim
# Get Token info

listLogin(token: String!): [Login]
# Get Login list

listLoginByAccount(token: String!
account_id: String!
): [Login]
# Get Login list by account id

loginById(token: String!
id: String!
): Login
# Get login info by id

loginByUsername(username: String!
token: String!
): Login
# Get login info by username

Accounts & Subscriptions

listAccount(token: String!): [Account]
# Get my client list

listSubscription(token: String!): [Subscription]
# Get Subscription list

subscription(token: String!
id: String!
): Subscription
# Get Subscription by id

Inventory & Packages

listCategory(token: String!): [ItemCategory]
# Get itemCategory list

listItem(token: String!): [Item]
# Get item list

listPackage(token: String!): [Package]
# Get Package list

package(id: String!
token: String!
): Package
# Get package by id

Databases

listDatabase(token: String!): [Database]
# Get Database list

listDtabaseByDomain(domain: String!
token: String!
): [Database]
# Get Database list

listDatabaseUser(token: String!): [DatabaseUser]
# Get DatabaseUser list

listDatabaseUserByDomain(token: String!
domain: String!
): [DatabaseUser]
# Get DatabaseUser list

Domain & DNS

listDomain(token: String!): [Domain]
# Get Domain list

soa(token: String!
domain: String!
): SOARecord
# Get SOA record

System & Services

listCronjob(token: String!): [Cronjob]
# Get CronJob list

listNetworkService(token: String!): [NetworkService]
# Get network service list

listProcess(token: String!): [Process]
# Get linux process list

process(token: String!
name: String!
): BasicInfo
# Get linux process info

Mail & FTP

listMailbox(token: String!): [Mailbox]
# Get Mailbox list

listMailboxByDomain(token: String!
domain: String!
): [Mailbox]
# Get Mailbox list

mailbox(id: String!
token: String!
): Mailbox
# Get Mailbox by id

listFtpuser(token: String!): [FtpUser]
# Get FtpUser list

Support Tickets

listTicket(token: String!): [Ticket]
# Get Ticket list

listTicketByType(token: String!
type: String!
): [Ticket]
# Get Ticket list

ticket(token: String!
id: String!
): Ticket
# Get Ticket by id