Skip to content

access / roles ​

5 operations.

GET /access/roles ​

ts
proxmox.access.roles.$get()

Role index.

Returns an array of object.

POST /access/roles ​

ts
proxmox.access.roles.$post()

Create new role.

Returns nothing.

ParameterTypeRequiredNotes
privsstringformat pve-priv-list
roleidstringyesformat pve-roleid

GET /access/roles/{roleid} ​

ts
proxmox.access.roles.$(roleid).$get()

Get role configuration.

Returns object.

ParameterTypeRequiredNotes
roleidstringyesformat pve-roleid

PUT /access/roles/{roleid} ​

ts
proxmox.access.roles.$(roleid).$put()

Update an existing role.

Returns nothing.

ParameterTypeRequiredNotes
appendboolean
privsstringformat pve-priv-list
roleidstringyesformat pve-roleid

DELETE /access/roles/{roleid} ​

ts
proxmox.access.roles.$(roleid).$delete()

Delete role.

Returns nothing.

ParameterTypeRequiredNotes
roleidstringyesformat pve-roleid