API Mutations

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

Security & Authentication

allowIP(token: String!
ip_address: String!
remarks: String!
): Ipwhitelist
# Whitelist an IP address

changePassword(password: String!
token: String!
username: String!
code: String!
): ChangePassword
# Password change request by username

createLogin(domain: String!
status: Int
token: String!
username: String!
access_name: String!
passwd: String!
email: String
mobile: String
): Login
# Create new login info

Access & Account Management

createAccess(status: Int!
token: String!
name: String!
): AccessRole
# Create new AccessRole

deleteAccess(token: String!
id: Int!
): AccessRole
# Delete AccessRole by id

createAccount(token: String!
profile: ProfileInfo!
address: AddressInfo!
login: LoginInfo!
): Account
# Create new account

deleteAccount(token: String!
id: String!
): Account
# Delete Account by id

Subscriptions & Packages

createSubscription(token: String!
account_id: String!
exec_name: String
forward_destination: String
port: Int
status: Int
service_type: String!
domain: String!
remarks: String
package_id: String!
parent_domain: String
name: String!
app_version: String!
notify_expiration: Int
): Subscription
# Create a service subscription

deleteSubscription(id: String!
backup: Int!
token: String!
): Subscription
# Delete Subscription by id

createPackage(disk_space: Int
domains: Int
mailbox_size: Int
ndatabase: Int
token: String!
item_id: Int!
name: String!
mailboxes: Int
traffic: Int
sub_domains: Int
mail_limit_per_hour: Int
validity: Int
status: Int
owneracc: String
ftp_accounts: Int
): Package
# Create new package

deletePackage(token: String!
id: String!
): Package
# Delete package by id

Databases & FTP

createDatabase(token: String!
domain: String!
name: String!
type: String!
connection_type: String!
selected_ips: String
status: Int
): Database
# Create a Database

deleteDatabase(token: String!
name: String!
): Database
# Delete Database by name

createDatabaseUser(dbpass: String!
host: String
privileges: String
token: String!
database_id: String!
dbuser: String!
): DatabaseUser
# Create Database User

deleteDatabaseUser(token: String!
id: String!
): DatabaseUser
# Delete DatabaseUser by id

createFtpuser(name: String!
protocol: String
dirname: String
permissions: String
token: String!
domain: String!
passwd: String!
sshkey: String
status: Int
): FtpUser
# Create a SFTP user account

deleteFtpuser(id: String!
token: String!
): FtpUser
# Delete FtpUser by id

Mail & Cronjobs

createMailbox(token: String!
domain: String!
mailname: String!
mailpass: String!
mailsize: Int
): Mailbox
# Create a Mail user

deleteMailbox(id: String!
token: String!
): Mailbox
# Delete Mailbox by id

createCronjob(month: String!
command: String!
domain: String!
mailto: String
day: String!
weekday: String!
token: String!
minute: String!
hour: String!
): Cronjob
# Create Cronjob

deleteCronjob(token: String!
id: String!
): Cronjob
# Delete Cronjob

Inventory & Tickets

createItem(item_category_id: Int!
item_type: String!
name: String!
description: String
uom: String
status: Int!
token: String!
): Item
# Create new item

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

createItemCategory(status: Int!
token: String!
name: String!
description: String
): ItemCategory
# Create new itemCategory

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

createTicket(token: String!
type: String!
domain: String!
message: String!
ticket_priority: String
status: Int
): Ticket
# Create a Ticket

deleteTicket(token: String!
id: String!
): Ticket
# Delete Ticket by id

createTicketResponse(status: Int
token: String!
id: String
ticket_id: String!
respond_by: String!
message: String!
): TicketResponse
# Create a TicketResponse

deleteTicketResponse(token: String!
id: String!
): TicketResponse
# Delete TicketResponse by id

Security & Installation

enableDNSSEC(token: String!
domain: String!
): DNSSEC
# Enable DNSSEC by creating a dns zone

disableDNSSEC(token: String!
domain: String!
): DNSSEC
# Deactivate all keys and unset PRESIGNED in ZONE

installLetsencrypt(token: String!
domain: String!
): TLSCert
# Install TLS Certificates

renewLetsencrypt(token: String!
domain: String!
): TLSCert
# Renew TLS Certificates

uninstallLetsencrypt(token: String!
domain: String!
): TLSCert
# Uninstall Letsencrypt Certificates

installWordpress(database_id: String!
title: String!
password: String!
email: String!
subdirectory: String
token: String!
domain: String!
public: String
table_prefix: String!
username: String!
): WordPress
# Wordpress setup info

uninstallWordpress(token: String!
domain: String!
): WordPress
# Wordpress uninstall

Account & Access Updates

forgetPassword(token: String!
username: String!
): ForgetPassword
# Password change request by username

updateLogin(username: String
passwd: String
status: Int
domain: String
token: String!
id: String!
access_name: String
email: String
mobile: String
): Login
# Update login info by id

updateAccess(token: String!
id: Int!
name: String!
status: Int
): AccessRole
# Update AccessRole by id

removeIP(ip_address: String!
token: String!
): Ipwhitelist
# Remove an IP address

Subscription & Service Control

restartService(domain: String!
token: String!
): Subscription
# Restart subscribed service by domain

suspendSubscription(domain: String!
token: String!
): Subscription
# Suspend a service by domain

unsuspendSubscription(token: String!
domain: String!
): Subscription
# Unsuspend a service by domain

updateSubscription(token: String!
package_id: String
exec_name: String
app_version: String
port: Int
remarks: String
domain: String!
name: String
forward_destination: String
notify_expiration: Int
): Subscription
# Update Subscription by domain

updatePackage(item_id: Int
traffic: Int
ndatabase: Int
validity: Int
status: Int
token: String!
disk_space: Int
sub_domains: Int
mailboxes: Int
ftp_accounts: Int
name: String!
domains: Int
id: String!
mailbox_size: Int
mail_limit_per_hour: Int
): Package
# Update package by id

Domain & Configuration

updateDocroot(token: String!
domain: String!
docroot: String!
): Docroot
# Update Docroot by domain

updateSOA(token: String!
domain: String!
pns: String!
email: String!
serial: Int
): SOARecord
# Update SOA record by domain

updateCronjob(mailto: String
hour: String
command: String
token: String!
id: String!
minute: String
day: String
month: String
weekday: String
): Cronjob
# Update Cronjob

Resource & Content Updates

updateDatabase(id: String!
connection_type: String
selected_ips: String
token: String!
): Database
# Update Database info by id

updateDatabaseUser(token: String!
id: String!
dbpass: String
host: String
privileges: String
): DatabaseUser
# Update DatabaseUser info by id

updateFtpuser(token: String!
id: String!
passwd: String
sshkey: String
permissions: String
): FtpUser
# Update FTPuser info by id

updateMailbox(mailpass: String
mailsize: Int
token: String!
id: String!
): Mailbox
# Update Mailbox info by id

updateItem(description: String
uom: String
status: Int
token: String!
id: Int!
item_category_id: Int!
item_type: String!
name: String!
): Item
# Update item by id

updateItemCategory(token: String!
id: Int!
name: String!
description: String
status: Int
): ItemCategory
# Update itemCategory by id

updateTicket(ticket_priority: String
ticket_status: String
status: Int
token: String!
id: String!
type: String
subject: String
support_by: String
): Ticket
# Update Ticket by id