Admins

List Admins

GET /admin

List all Admins

Response 200: A list of Admins

Field	Type	Description
created_at	object
created_at.iso_8601	string	IS0 8601-formatted Date
created_at.unix	integer	Seconds since Unix epoch (Unix Timestamp)
email	string
id	integer	VirtlixCP-specific unique identifier used for URLs, etc.
name	string
receive_copies	boolean
username	string

Create Admin

POST /admin

Create a new Admin

Request body

Field	Type	Required	Description
email	string	yes
password	string	yes
receive_copies	boolean
username	string

Response 200: An Admin

Field	Type	Description
created_at	object
created_at.iso_8601	string	IS0 8601-formatted Date
created_at.unix	integer	Seconds since Unix epoch (Unix Timestamp)
email	string
id	integer	VirtlixCP-specific unique identifier used for URLs, etc.
name	string
receive_copies	boolean
username	string

Request body

Field	Type	Required	Description
email	string	yes
password	string	yes
receive_copies	boolean
username	string

Response 422: Unprocessable Entity

Delete Admin

DELETE /admin/{admin_id}

Delete an admin

Response 200: Admin deleted successfully

Response 404: Item not Found

View Admin

GET /admin/{admin_id}

View a specific admin

Response 200: An Admin

Field	Type	Description
created_at	object
created_at.iso_8601	string	IS0 8601-formatted Date
created_at.unix	integer	Seconds since Unix epoch (Unix Timestamp)
email	string
id	integer	VirtlixCP-specific unique identifier used for URLs, etc.
name	string
receive_copies	boolean
username	string

Edit Admin

PATCH /admin/{admin_id}

Edit a specific admin with new information

Request body

Field	Type	Required	Description
email	string
password	string
receive_copies	boolean
username	string

Response 200: An Admin

Field	Type	Description
created_at	object
created_at.iso_8601	string	IS0 8601-formatted Date
created_at.unix	integer	Seconds since Unix epoch (Unix Timestamp)
email	string
id	integer	VirtlixCP-specific unique identifier used for URLs, etc.
name	string
receive_copies	boolean
username	string

Request body

Field	Type	Required	Description
email	string
password	string
receive_copies	boolean
username	string

Response 422: Unprocessable Entity

View Admin Permissions

GET /admin/{admin_id}/permission

View a specific admin’s permissions

Response 200: An Admin’s Permissions

Field	Type	Description
network	object
network.entities	object
network.forward	object
network.groups	object
network.switches	object
pxe	object
pxe.installs	object
pxe.settings	object
server	object
server.in_inventory	object
server.in_use	object
server.settings	object
system	object
system.emails	object
system.integrations	object
system.logs	object
system.settings	object
system.theme	object
users	object
users.admins	object
users.clients	object