Luna OpenAPI Reference

GET /acl

Get Access Control List

Returns the complete system data in CSV format. The exported file includes users, roles, assigned role to user, and other related attributes. Useful for administrative reporting or bulk data analysis. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PUT /acl

Update full Access Control List

'Sets all entries in the Rest API Access Control List. Any entries not present in the uploaded list will be removed from the ACL. This can only be done on changeable users and roles. Currently the non-changeable users and roles are admin, operator and monitor.' Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PATCH /acl

Update some part of Access Control List

GET /auth/certificate

Get Server's Certificate

Returns server public certificate. NOTE: The certificate is PEM format with no embedded newlines, with string \n instead of the newline character.' Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /auth/login/challenge

Generate Login Challenge

Generate a login challenge which is to be responded to by the client. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /auth/login/basic

Perform login using challenge response computed by the client. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /auth/session

Create Private Session

Create a private session for the user and return a session cookie. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /auth/session

Delete Private Session

Delete the private session used to access this resource. It also instructs the client browser to remove the session cookie from future requests. NOTE: The user must have a private session to access this resource. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /errors

Get list of Error Languages

Gets list of all error languages supported by the REST API. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /errors/{languageid}

Get List of errors based on language

A list of all errors for the specific language. Specifically, the list is unique error identifiers. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /errors/{languageid}/{errorid}

Get information about error in particular language

GET /roles

Get Appliance Roles

Get list of REST API roles. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `user role list`

POST /roles

Create Customer Appliance Role

This resource creates a REST API role. Can only contain alphanumeric characters. It will be available in LunaSH too. Only the "exit" command will be accessible in LunaSH through this resource. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `user role import`

GET /roles/{roleid}

Get information about specified Appliance role

Get information for a specific REST API role. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PUT /roles/{roleid}

Update full configurable details of custom Appliance role

Sets desired role configurations. This can be done on changeable roles only. Currently the non-changeable roles are admin, operator, audit and monitor. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PATCH /roles/{roleid}

Update information of custom Appliance role partially

DELETE /roles/{roleid}

Delete custom Appliance role

Delete a REST API role. This can only be done on changeable roles only. Currently the non-changeable roles are admin, operator, audit and monitor. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `user role delete`

GET /roles/{roleid}/resources

Get the role definition file

Download a list of resources available to a specific REST API role. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PUT /roles/{roleid}/resources

Update the complete role definition file Custom Appliance Role

Sets all role resources. Any resources not present in the uploaded list will be removed from the role's accessible resources. This can only be done on changeable roles only. Currently the non-changeable roles are admin, operator, audit and monitor. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PATCH /roles/{roleid}/resources

Update the partial role definition file Custom Appliance Role

Sets desired role resources. This can only be done on changeable roles only. Currently the non-changeable roles are admin, operator, audit and monitor. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /tasks

Get list of tasks

Gets all tasks created in current session with REST API. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /tasks

Delete all the tasks

Remove all records of tasked resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /tasks/{taskid}

Get information of specified task

Gets the information associated with a specific task. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /tasks/{taskid}

Delete the specified task

Removes the record of a tasked resource. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /tasks/{taskid}/actions

Get the list of actions supported by specified task

Gets all actions associated with the task. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /tasks/{taskid}/actions/{actionid}

Execute/Start the Waiting Task

Execute the task, which is currently in WAITING state. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /tasks/{taskid}/response

Get the specified task response

Gets the tasked resource response and removes a task record with state "Finished"; errors otherwise. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /users

Get the list of users

This resource allows you to display a list of users created on the Appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `user list`

POST /users

Create custom user

Custom user created through REST, will be available at LunaSH. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `user add`

GET /users/{userid}

Get information of specified user

This resource allows admin-level user or user itself to fetch the information like Fullname, email, and other account related information. It is important to note all the fields comes in the response will not be applicable or visible at LunaSH level. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `user list`

PUT /users/{userid}

Update complete information of specified user

Sets all user configurations. This can only be done on changeable users. Currently the non-changeable users are admin, operator and monitor. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PATCH /users/{userid}

Update partial information of specified user

Sets desired user configurations. This can only be done on changeable users. Currently the non-changeable users are admin, operator, audit, and monitor. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /users/{userid}

Delete specified user

Delete a REST API user. Deleted user will be removed from LunaSH, too. This can be done on changeable users only. Currently the non-changeable users are admin, operator, audit, and monitor. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `user delete`

GET /users/{userid}/certificates

Get the list of certificates added for specified user

Get list of certificates for a specific REST API user. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /users/{userid}/certificates

Add the certificate for specified user

Add a login certificate for a REST API user. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /users/{userid}/certificates

Delete all the certificates added for specified user

Delete all certificate for a given REST API user. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /users/{userid}/certificates/{certificateid}

Get the fingerprint details of specified certificate added for specified user

Get information for a specific user certificate. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /users/{userid}/certificates/{certificateid}

Delete specified certificate added for specified user

Delete a specific certificate for a given REST API user. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /users/{userid}/actions

Get the list of actions which can performed on specified user

This resource will display the list of actions available to perform on an user. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /users/{userid}/actions/enable

Enable the specified user

Gets list of all error languages supported by the REST API. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `user enable`

POST /users/{userid}/actions/disable

Disable specified user

Gets list of all error languages supported by the REST API. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `user disable`

POST /users/{userid}/actions/roleClear

Clear the role information of specified user

Gets list of all error languages supported by the REST API. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `user role clear`

POST /users/{userid}/actions/changePassword

Change password for specified user

An admin user or a user with the admin role can change the password of their own or for the other users using action 'changePassword'. Non-admin level users can only change their own password using 'changePassword'. Previously, the resource would change current password when user wants to change it. From RESTAPI V12 onwards,this resource can be used in following instances: **>** User whose password was just reset by an admin level user or is a new user who is forced to change password on first login. **>** When an admin level user is changing password for own or for other user. **>** When non-admin level user is changing password for own. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `user password and my password set`

GET /users/{userid}/files

Get the list of files stored in specified user's directory

This resource will list the files owned by the currently logged in user. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `my file list`

POST /users/{userid}/files

Upload a file in the specified user's directory

Upload the file to the appliance by the currently logged in user. You may change the value of maxFileSize of webserver to this resource. See webServer Configuration Uploading of file will take less time when performed in good network. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /users/{userid}/files/{fileid}

Get the information about the file stored in specified user's directory

This resource will show the information of the file owned by the currently logged in user. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `my file list`

DELETE /users/{userid}/files/{fileid}

Delete the specified file stored in the specified user's directory

This resource will delete the file owned by the currently logged in user. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `my file delete`

GET /users/{userid}/files/{fileid}/download

Download the specified file from the specified user's directory

Download the file owned by the currently logged in user in the archive format. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa

Get the appliance information

Gets information associated with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `status sysstat show and sysconf forceSOLogin show`

PUT /api/lunasa

Enable/disable force SO Login

Changes the state of forceSoLogin flag. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf forceSOLogin`

PATCH /api/lunasa

Enable/disable force SO Login

Changes the state of forceSoLogin flag. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf forceSOLogin`

GET /api/lunasa/actions

Get all Appliance actions

This resource list all the actions which can be performed on the Luna Appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/actions/reboot

Reboot Appliance

This resource allows to reboot the Luna Appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf appliance reboot`

POST /api/lunasa/actions/regenerateCertificate

Regenerates server certificate

This resource allows to Regenerate Luna Appliance Certificate. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf regenCert`

POST /api/lunasa/actions/powerOff

Power Off Appliance

This resource allows to power off the Luna Appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf appliance powerOff`

GET /api/lunasa/time

Get Appliance Time

This resource returns the values of the appliance time, date and time zone information. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `status date`

PUT /api/lunasa/time

Put Appliance Time

This resource configures time, date and time zone on the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf time and sysconf timezone`

PATCH /api/lunasa/time

Patch Appliance Time

GET /api/lunasa/cluster

List of Cluster Resources

Gets list of Cluster Resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/cluster/caCert

Get Cluster Certificate Info

This resource gets information about cluster's CA certificate. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `cluster show`

GET /api/lunasa/cpu

Get List of CPU Resources

This resource contains the list of CPU resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `status cpu`

GET /api/lunasa/cpu/process

CPU processes status

This resource contains information about CPU processes status. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/cpu/process/processes

Get List of Running Processes

This resource will display the list of running processes. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/cpu/process/processes/{processid}

Get CPU Process Info

This resource will display the information about the specific process. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/disk

Get List of Disk Resources

This resource contains disk information and resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/disk/partitions

Get List of Disk Partitions

This resource contains the list of partitions resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/disk/partitions/partitionid

Get Disk Partition Info

This resource contains information associated with the disk partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/disk/smart

Get List of Smart Resources

This resource contains SMART information and resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/disk/smart/attributes

Get List of Disk Smart Attributes

This resource contains the list of disk SMART attributes. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/disk/smart/attributes/attributeid

Get Disk Smart Attribute Info

This resource contains information associated with the disk SMART attribute. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/memory

Get Appliance Memory Info

This resource provides information about physical and swap memory. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `status mem`

GET /api/lunasa/network

Get List of Network Resources

Gets the network information associated with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `network show`

PUT /api/lunasa/network

Put Network Configuration

Sets all base network configurations associated with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network hostname`

PATCH /api/lunasa/network

Patch Network Configuration

Sets the network information associated with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network hostname`

GET /api/lunasa/network/actions

Get List of Network Actions

Gets all network actions. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/network/actions/ping

Network Ping

Tests network connectivity to the specified host. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** ` network ping`

GET /api/lunasa/network/devices

Get Network Interfaces List

Gets all network devices. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `network show and status interface`

POST /api/lunasa/network/devices

Create Network Bonding Interface

GET /api/lunasa/network/devices/{deviceid}

Get Network Interface Information

Gets information about a network device. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `network show and status mac`

DELETE /api/lunasa/network/devices/{deviceid}

Disables the Network Interface

Disables a Network device. **Note:** It is strongly recommended to perform this operation through a serial connection to the appliance in order to avoid any loss of connection with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network interface delete`

GET /api/lunasa/network/devices/{deviceid}/actions

Get List of Network Interface Actions

Gets all bond device actions. The actions available are "enable" and "disable". Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/network/devices/{deviceid}/actions/enable

Enable Network Interface Bonding

Enables Bonding Interface. **Note:** It is strongly recommended to perform these actions through the serial connection to the appliance in order to avoid any loss of connection with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network interface bonding enable`

POST /api/lunasa/network/devices/{deviceid}/actions/disable

Disable Network Interface Bonding

Disables Bonding Interface. **Note:** It is strongly recommended to perform these actions through the serial connection to the appliance in order to avoid any loss of connection with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network interface bonding disable`

GET /api/lunasa/network/devices/{deviceid}/classes

List of Configured Classes

This resource allows to list all the ctc classes associated under an network interface/device. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf ctc class show`

POST /api/lunasa/network/devices/{deviceid}/classes

Define a CTC Class

This resource allows to create a ctc class under an network interface/device. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ctc class define`

GET /api/lunasa/network/devices/{deviceid}/classes/{classid}

Get Network Device Class Information

This resource lists all the resources and information related to a class. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf ctc class show`

PUT /api/lunasa/network/devices/{deviceid}/classes/{classid}

Put Network Device Class

This resource allows to modify an already created class for traffic management. But if it doesn't exists it creates one with the provided 'classid' in the url. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ctc class define`

DELETE /api/lunasa/network/devices/{deviceid}/classes/{classid}

Delete Network Device Class

This resource allows to delete a network ctc class. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ctc class delete`

GET /api/lunasa/network/devices/{deviceid}/classes/{classid}/clients

List Network Interface Class Clients

This resource allows to list all the clients assigned under a class. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf ctc client show`

PATCH /api/lunasa/network/devices/{deviceid}/classes/{classid}/clients

Assign Client to Network Interface Class

This resource enables to assign a user/client to a class using his IP address. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ctc class assign`

DELETE /api/lunasa/network/devices/{deviceid}/classes/{classid}/clients/{clientid}

Revoke Client from Network Interface Class

This resource allows to revoke a user/client from a class. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ctc class revoke`

GET /api/lunasa/network/devices/{deviceid}/measurementStats

Get Network Interface Measurement Statistics

This resource allows to list the measurement statistics according to the duration entered in the query. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf ctc measurement show`

GET /api/lunasa/network/devices/{deviceid}/stats

Get Network Interface Stats

Gets packet information about a network device. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/network/devices/{deviceid}/ip4

Get Network Interface IPv4 Configuration

Gets ip4 information from a network device. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `network show and status mac`

PUT /api/lunasa/network/devices/{deviceid}/ip4

Put Network Interface IPv4 Configuration

Sets all ip4 configurations for a specific device. **Note:** It is strongly recommended to perform this operation through the serial connection to the appliance in order to avoid any loss of connection with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network interface dhcp and network interface static`

PATCH /api/lunasa/network/devices/{deviceid}/ip4

Patch Network Interface IPv4 Configuration

Sets ip4 configurations for a specific device. **Note:** It is strongly recommended to perform this operation through the serial connection to the appliance in order to avoid any loss of connection with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network interface dhcp and network interface static`

GET /api/lunasa/network/devices/{deviceid}/ip6

Get Network Interface IPv6 Configuration

Gets ip6 information from a network device. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `network show and status mac`

PUT /api/lunasa/network/devices/{deviceid}/ip6

Put Network Interface IPv6 Configuration

Sets all ip6 configurations for a specific device. **Note:** It is strongly recommended to perform this operation through the serial connection to the appliance in order to avoid any loss of connection with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network interface slaac`

PATCH /api/lunasa/network/devices/{deviceid}/ip6

Patch Network Interface IPv6 Configuration

Sets ip6 configurations for a specific device. **Note:** It is strongly recommended to perform this operation through the serial connection to the appliance in order to avoid any loss of connection with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network interface slaac`

GET /api/lunasa/network/devices/{deviceid}/routes

Get Network Interface Routes

Gets all routes for a specific network device. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `network route show and network show`

POST /api/lunasa/network/devices/{deviceid}/routes

Create Network Interface Route

Creates a route on specified network device. **Note:** It is strongly recommended to perform this operation through the serial connection to the appliance in order to avoid any loss of connection with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network route add`

PUT /api/lunasa/network/devices/{deviceid}/routes

Put Network Interface Routes Metric

Sets the route metric information for all routes associated to device. **Note:** It is strongly recommended to perform this operation through the serial connection to the appliance in order to avoid any loss of connection with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network route metric`

DELETE /api/lunasa/network/devices/{deviceid}/routes

Delete Network Interface Routes

Removes all routes that have been set. **Note:** It is strongly recommended to perform this operation through a serial connection to the appliance in order to avoid any loss of connection with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network route clear`

GET /api/lunasa/network/devices/{deviceid}/routes/{routeid}

Get Network Interface Route Information

Gets information about a network device route. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `network route show and network show`

DELETE /api/lunasa/network/devices/{deviceid}/routes/{routeid}

Delete Network Interface Route

Removes a specific route. **Note:** It is strongly recommended to perform this operation through a serial connection to the appliance in order to avoid any loss of connection with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network delete`

GET /api/lunasa/network/measurement/actions

List Network Interface Measurement Actions

Gets actions related to the network measurement. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/network/measurement/actions/enable

Enable the Measurement Service

Enable the ctc measurement service. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ctc measurement enable`

POST /api/lunasa/network/measurement/actions/disable

Disable the Measurement Service

Disable the ctc measurement service. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ctc measurement disable`

GET /api/lunasa/network/netstat

Get Network Netstat Information

Gets the network netstat information associated with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `status netstat`

GET /api/lunasa/network/netstat/{socketid}

Get Network Netstat Socket Information

Gets the network netstat information associated with the socket. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `status netstat`

GET /api/lunasa/network/devices/{deviceid}/dns

List Network Interface DNS Resources

Returns the location of the different DNS resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/network/devices/{deviceid}/dns/nameServers

List Network Device DNS Name Servers

Returns a list of name servers currently registered on the device. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `network show`

POST /api/lunasa/network/devices/{deviceid}/dns/nameServers

Add Network Device DNS Name Server

Creates a new name server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network dns add nameserver`

GET /api/lunasa/network/devices/{deviceid}/dns/nameServers/{serverid}

Get Network Device DNS Name Server Information

This resource returns information about a particular name server registered on the device. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `network show`

DELETE /api/lunasa/network/devices/{deviceid}/dns/nameServers/{serverid}

Delete Network Device DNS Name Server

Deletes a name server entry. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network dns delete nameserver`

GET /api/lunasa/network/devices/{deviceid}/dns/nameServers/searchDomains

List Network Device DNS Search Domains

Returns a list of search domains currently registered on the device. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `network show`

POST /api/lunasa/network/devices/{deviceid}/dns/nameServers/searchDomains

Add Network Device DNS Search Domains

Creates a new search domain. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network dns add searchdomain`

GET /api/lunasa/network/devices/{deviceid}/dns/nameServers/searchDomains/{searchDomainid}

Get Network Device DNS Search Domain

Returns information about a particular search domain registered on the device. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `network show`

DELETE /api/lunasa/network/devices/{deviceid}/dns/nameServers/searchDomains/{searchDomainid}

Delete Network Device DNS Search Domain

Deletes a search domain entry. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `network dns delete searchdomain`

GET /api/lunasa/ntls

Get NTLS Server configuration

Returns the current configuration settings of the NTLS server, including system parameters, enabled features, and environment details. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `ntls ipcheck show and ntls timer show`

PUT /api/lunasa/ntls

Replace current NTLS server configuration

Replaces the entire current NTLS server configuration with the values provided in the request body. Use this method for a complete configuration update. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `ntls ipcheck enable and ntls ipcheck disable and ntls timer set`

PATCH /api/lunasa/ntls

Partially update current NTLS server configuration

Updates one or more configuration fields without replacing the entire configuration. Only the fields provided in the request body will be changed. Use this method for incremental updates. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `ntls ipcheck enable and ntls ipcheck disable and ntls timer set`

GET /api/lunasa/ntls/actions

List of NTLS Actions

List of Actions which can be performed on NTLS Server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/ntls/actions/reset

Resets NTLS Counters

Reset the NTLS counters. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `ntls information reset`

POST /api/lunasa/ntls/actions/setDefaultCipherList

Set NTLS Server cipher list to default

Resets the server’s configured cipher list to the system default set of ciphers. This operation removes any custom cipher configuration and restores the default secure cipher suite recommended by the server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf tls ciphers reset`

POST /api/lunasa/ntls/actions/setDefaultGroupList

Set NTLS Server PQC groups to default

Resets the server’s configured Post-Quantum Cryptography (PQC) groups to the system default set. This operation removes any custom PQC group configuration and restores the default secure groups recommended by the server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf tls groups reset`

GET /api/lunasa/ntls/certificate

Fetch NTLS Server Certificate

Gets the server-side certificate used by NTLS to establish connections with clients. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `ntls certificate show`

PUT /api/lunasa/ntls/certificate

Regenerates the NTLS certificate

Regenerates the NTLS Server certificate with the values provided in the request body and replace with current certificate. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf regenCert`

PATCH /api/lunasa/ntls/certificate

Regenerates the NTLS certificate with partial parameters.

Regenerates the NTLS Server certificate with only the values provided in the request body and replace with current certificate. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf regenCert`

POST /api/lunasa/ntls/csr

Generate a Certificate Signing Request (CSR) for NTLS Server.

Generates a new Certificate Signing Request (CSR) based on the provided subject details and key parameters. The CSR can be submitted to a Certificate Authority (CA) to obtain a signed certificate. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf regenCert -csr`

GET /api/lunasa/ntls/clients

List NTLS Clients

Gets the list of all clients registered with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `client list`

POST /api/lunasa/ntls/clients

Registers a client with the appliance. The resource works in three different ways to register client: **>** User can provide the certificate content to register. **>** User can upload the certificate through POST /users/{userid}/files and can only provide ip/hostname that matches the file name uploaded. **>** User can register a client without providing a certificate and later add a certificate through PUT /api/lunasa/ntls/clients/{clientid}. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `client register`

DELETE /api/lunasa/ntls/clients

Delete NTLS Clients

Removes all clients registered on the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/ntls/clients/{clientid}

Get NTLS Client Information

Gets the information associated with a specific client. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `client show`

PUT /api/lunasa/ntls/clients/{clientid}

Add/Replace NTLS Client Certificate

Add/Replace the client certificate of an already registered client with or without certificate. The certificate could be self-signed or CA signed. In the case of a CA-signed certificate, a CA certificate should be added. The resource works in three different ways to update client's certificate: **>** User can provide the certificate content to update. **>** User can upload and update client's certificate using this single resource. **>** User can upload the certificate through POST /users/{userid}/files and can only provide file name of file uploaded. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `client update`

DELETE /api/lunasa/ntls/clients/{clientid}

Deletes NTLS Client

Removes a client from the list of those registered on the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `client delete`

GET /api/lunasa/ntls/clients/{clientid}/dn

Get Client Distinguished Name Information

This resource shows the client's distinguished name filter. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `client dn show`

PUT /api/lunasa/ntls/clients/{clientid}/dn

Assign Client's Distinguished Name Filter

This resource assigns a distinguished name filter to a client. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `client dn assign`

DELETE /api/lunasa/ntls/clients/{clientid}/dn

Deletes Client's Distinguished Name Filter

This resource deletes the client's distinguished name filter. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `client dn delete`

GET /api/lunasa/ntls/clients/{clientid}/links

Get List of Assign Partition

Gets a list of all partition links assigned to a client. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `client show`

POST /api/lunasa/ntls/clients/{clientid}/links

Assign Partition to Client

Registers a link to a partition with a client. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `client assignPartition`

GET /api/lunasa/ntls/clients/{clientid}/links/{linkid}

Get Information about Assigned Partition

Gets a specified link Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `client show`

DELETE /api/lunasa/ntls/clients/{clientid}/links/{linkid}

Revoke Partition from Client

Deletes a link from a client. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `client revokePartition`

GET /api/lunasa/ntls/clients/{clientid}/actions

List of Actions Supported by NTLS Client

Gets all actions associated with the ntls client. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/ntls/clients/{clientid}/actions/map

Map IP to NTLS Client Hostname

Maps IP to NTLS Client Hostname. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `client hostip map`

POST /api/lunasa/ntls/clients/{clientid}/actions/unmap

Un-map IP from NTLS Client Hostname

Un-maps IP from NTLS Client Hostname. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `client hostip unmap`

GET /api/lunasa/ntls/clientsCA

List CA from Trust Store

This resource will provide the list of all CAs available in the truststore. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `client listCAs`

POST /api/lunasa/ntls/clientsCA

Add CA to Trust Store

Adds a Certificate Authority(CA) certificate to the truststore. The resource works in two different ways to add clientCA: **>** User can provide the certificate content to add clientCA. **>** User can also provide the name of certificate file that should be already uploaded in user's home directory. The certificate can be uploaded through POST /users/{userid}/files. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `client AddCA`

GET /api/lunasa/ntls/clientsCA/{caid}

Get CA Information

This resource will provide the information about issuer and subject for specific CA Cert. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `client listCAs`

DELETE /api/lunasa/ntls/clientsCA/{caid}

Deletes CA from Trust Store

Deletes a Certificate Authority(CA) certificate from the truststore. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `client deleteCA`

GET /api/lunasa/ntls/bind

Get NTLS Server Bind Configuration

This resource will provide the interface bound to ntls, and whether it is active. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `ntls show`

PUT /api/lunasa/ntls/bind

Put NTLS Server Bind Interface

Sets the interface for NTLS. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `ntls bind`

PATCH /api/lunasa/ntls/bind

Patch NTLS Server Bind Interface

Sets the interface for NTLS. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `ntls bind`

GET /api/lunasa/ntls/tcpKeepAlive

Get NTLS TCP Keep Alive Configuration

This resource displays the TCP KeepAlive information for NTLS. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `ntls tcp_keepalive show`

PUT /api/lunasa/ntls/tcpKeepAlive

Put NTLS TCP Keep Alive Configuration

Sets the specific TCP KeepAlive information for NTLS. **Note:** The NTLS service should be restarted for new settings to take effect. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `ntls tcp_keepalive set`

PATCH /api/lunasa/ntls/tcpKeepAlive

Patch NTLS TCP Keep Alive Configuration

GET /api/lunasa/ntls/threads

Get NTLS Threads Configuration

This resource will give the NTLS worker threads settings. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `ntls threads show`

PUT /api/lunasa/ntls/threads

Put NTLS Threads Configuration

This resource will configure specific NTLS worker threads settings. **Note:** The NTLS service should be restarted for new settings to take effect. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `ntls threads set`

PATCH /api/lunasa/ntls/threads

Patch NTLS Threads Configuration

GET /api/lunasa/ntp

Get NTP Configuration

This resource contains NTP configuration information. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf ntp show`

GET /api/lunasa/ntp/status

Get NTP Status

This resource returns information of NTP time, max error, estimated error and offset. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/ntp/servers

Get NTP Server List

This resource contains the list of server resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf ntp listservers`

POST /api/lunasa/ntp/servers

Adds NTP Server

This resource adds an NTP server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ntp addserver`

DELETE /api/lunasa/ntp/servers

Delete NTP Servers

Deletes all ntp server entries. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ntp clearservers`

GET /api/lunasa/ntp/servers/{serverid}

Get NTP Server Information

This resource contains information about a specific server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf ntp listservers`

PUT /api/lunasa/ntp/servers/{serverid}

Put NTP Server Configuration

This resource allows changing settings for a specific server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ntp listservers`

PATCH /api/lunasa/ntp/servers/{serverid}

Patch NTP Server Configuration

DELETE /api/lunasa/ntp/servers/{serverid}

Delete NTP Server

This resource deletes an NTP server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ntp deleteserver`

GET /api/lunasa/ntp/actions

Get NTP Supported Actions List

This resource returns a list of actions of NTP. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/ntp/actions/synchronize

Synchronize NTP Server

Synchronize NTP Server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ntp ntpdate`

GET /api/lunasa/package

List Installed Package

This resource contains the list of installed packages. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `package list`

POST /api/lunasa/packageFiles

Package Verify and Update

Verify or Update a secure package on appliances. If user does not use OpenSSL EVP, you need HSM SO authentication. Package Update or Verify operation can be controlled using query parameters: **>** VerifyOnly=true; will verify the package. **>** VerifyOnly=false; will verify the package and apply it on the appliance. The resource works in two different ways: **>** User can upload the package and update/verify using this single resource. Package operation from this method will take less time when performed in good network. **>** User can also provide the name of package file that has already been uploaded in user's home directory. The package can be uploaded through POST /users/{userid}/files. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `package verify and package update`

GET /api/lunasa/sensors

Get Sensors List

This resource contains the list of sensor resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `status sensors`

GET /api/lunasa/sensors/{sensorid}

Get Sensor Information

This resource contains information about a specific sensor. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `status sensors`

GET /api/lunasa/services

Get Services List

Gets all services associated with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `service list`

GET /api/lunasa/services/{serviceid}

Get Service Information

Gets specific information about the service. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `service status`

PUT /api/lunasa/services/{serviceid}

Put Service

Modifies the service attributes. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PATCH /api/lunasa/services/{serviceid}

Patch Service

GET /api/lunasa/services/{serviceid}/actions

List Actions Supported by Service

Gets all actions associated with the service. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/services/{serviceid}/actions/start

Start Service

This resource will start the service. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `service start`

POST /api/lunasa/services/{serviceid}/actions/restart

Restart Service

This resource will restart the service. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `service restart`

POST /api/lunasa/services/{serviceid}/actions/stop

Stop Service

This resource will stop the service. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `service stop`

GET /api/lunasa/snmp

Get SNMP Resources and Configuration

This resource contains SNMP configuration information. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/snmp/traps

List SNMP Traps

This resource retrieves all SNMP trap agents and other trap resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf snmp trap show`

POST /api/lunasa/snmp/traps

Create SNMP Trap

This resource creates a new SNMP trap agent. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf snmp trap set`

DELETE /api/lunasa/snmp/traps

Clear SNMP Traps

This resource clears all the SNMP trap agents. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf snmp trap clear`

GET /api/lunasa/snmp/traps/actions

List SNMP Traps Supported Actions

This resource retrieves all available SNMP trap actions. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/snmp/traps/test

Test SNMP Trap

Submits a test payload to allow administrator to create test logs to initiate trap notifications. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf snmp trap test`

GET /api/lunasa/snmp/traps/{trapid}

Get SNMP Trap Information

This resource retrieves details of a specific SNMP trap agent. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf snmp trap show`

DELETE /api/lunasa/snmp/traps/{trapid}

Delete SNMP Trap Agent

This resource deletes a specific SNMP trap agent. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf snmp trap delete`

GET /api/lunasa/snmp/users

List SNMP Users

This resource contains a list of snmp users. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf snmp user list`

POST /api/lunasa/snmp/users

Create SNMP User

This resource creates an SNMP user. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf snmp user add`

DELETE /api/lunasa/snmp/users

Delete SNMP Users

This resource deletes all the SNMP users. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf snmp user clear`

GET /api/lunasa/snmp/users/{userid}

Get SNMP User Information

This resource gets configured information of the specified user. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /api/lunasa/snmp/users/{userid}

Delete SNMP User

This resource deletes a specific user. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf snmp user delete`

GET /api/lunasa/snmp/users/{userid}/notifications

List SNMP User Notifications

This resource contains a list of snmp notifications for a specific user. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf snmp notification list`

POST /api/lunasa/snmp/users/{userid}/notifications

Create SNMP User Notification

This resource creates an SNMP user notification. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf snmp notification add`

DELETE /api/lunasa/snmp/users/{userid}/notifications

Delete SNMP User Notifications

This resource deletes all user notifications. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf snmp notification clear`

GET /api/lunasa/snmp/users/{userid}/notifications/{notificationid}

Get SNMP User Notification Information

This resource gets configuration information for an snmp notification. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PUT /api/lunasa/snmp/users/{userid}/notifications/{notificationid}

Put SNMP User Notification

This resource is used to update all the information of an snmp notification. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PATCH /api/lunasa/snmp/users/{userid}/notifications/{notificationid}

Patch SNMP User Notification

This resource is used to partially update the information of an snmp notification. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /api/lunasa/snmp/users/{userid}/notifications/{notificationid}

Delete SNMP User Notification

This resource deletes an SNMP notification. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf snmp notification delete`

GET /api/lunasa/ssh

Get SSH Configuration

This resource contains configuration and link urls for the SSH resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf ssh show and sysconf ssh ciphers show`

PUT /api/lunasa/ssh

Put SSH Configuration

This resource updates SSH server configuration. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ssh device and sysconf ssh ciphers set and sysconf ssh port and sysconf ssh publickey and sysconf ssh password`

PATCH /api/lunasa/ssh

Patch SSH Configuration

GET /api/lunasa/ssh/actions

List Actions Supported by SSH

POST /api/lunasa/ssh/actions/resetCiphers

Reset SSH Ciphers to Default

Resets SSH Ciphers to default. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ssh ciphers reset`

POST /api/lunasa/ssh/actions/keyRegenerate

Regenerate SSH Key

Regenerates SSH Key. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `sysconf ssh regenKeyPair`

GET /api/lunasa/config/backups

List System Configuration Backups

This resource provides the list of configuration backup files stored in the local file system. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `sysconf config list`

POST /api/lunasa/config/backups

Generate System Configuration

This resource will create back up of the appliance configuration data, and save it to the appliance file system. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf config backup`

GET /api/lunasa/config/backups/actions

Get Actions Supported by System Backups

This resource provides the list of actions that can be performed on the local file system (on all the backup files). Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/config/backups/actions/clear

Clear System Configuration Backup Files

Deletes all the configuration backup files. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf config clear`

POST /api/lunasa/config/factoryReset

Factory Reset System Configuration

This resource will reset the appliance to the settings created at the factory. **Note:** Resetting services to factory defaults can affect connectivity and the operation of the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf config factoryReset`

GET /api/lunasa/config/backups/{backupid}

Get System Backup Configuration Information

This resource provides the information about a specific configuration backup file stored in the local file system. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** monitor **LunaSH command:** `sysconf config show`

DELETE /api/lunasa/config/backups/{backupid}

Delete System Configuration Backup File

This resource will delete specific configuration backup file stored in the local file system. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf config delete`

GET /api/lunasa/config/backups/{backupid}/actions

List Actions Supported on System Configuration Backup File

This resource provide the list of actions, which can be performed on a backup file stored in local file system. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/config/backups/{backupid}/actions/restore

Restore System Configuration from Backup File

This resource contains information about a specific server. **>** Restores the configuration of the selected service(s) from a backup file. **>** The service(s) must be stopped before restoring their configuration. **>** It does NOT restore the HSM and Partition configurations. **>** You must reboot the appliance for the changes to take effect. **>** Please check the new configurations BEFORE rebooting or restarting the services. **>** It automatically creates a backup file of the current configurations before restoring a previous configuration. You can restore the previous configurations if the new settings are not acceptable. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf config restore`

GET /api/lunasa/syslog

Get Syslog Configuration

This resource contains config and link urls for the syslog resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `syslog show`

PUT /api/lunasa/syslog

Put Syslog Configuration

This resource contains information about a specific server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `syslog period and syslog rotations`

PATCH /api/lunasa/syslog

Patch Syslog Configuration

GET /api/lunasa/syslog/actions

List Actions Supported by Syslog

Gets all syslog actions. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/syslog/actions/cleanup

Cleanup Syslog

This resource contains information about a specific server. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `syslog cleanup`

POST /api/lunasa/syslog/actions/rotate

Rotate Syslog

This resource contains information about a specific server. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `syslog rotate`

GET /api/lunasa/syslog/logs

Get List of Logs

Gets the list of syslog logs. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `syslog show`

GET /api/lunasa/syslog/logs/{logid}

Get Log Information

Gets information about the log. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `syslog show and syslog tail`

PUT /api/lunasa/syslog/logs/{logid}

Put Log Attributes

Sets all log configurations. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `syslog severity set`

PATCH /api/lunasa/syslog/logs/{logid}

Patch Log Attributes

Sets given log configurations. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `syslog severity set`

GET /api/lunasa/syslog/logs/{logid}/tar

Generate Log Compressed File

Gets the backup of all information about the log exist in HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/syslog/backups

List Syslog Backups

This resource returns the list of stored syslog backups. This resource has been disabled for Rest API version equivalent to or greater than 12. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/syslog/backups

Create Syslog Backup

This resource creates a syslog backup. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `syslog tarlogs`

GET /api/lunasa/syslog/backups/{backupid}

Get Syslog Backup Information

This resource retrieves a syslog backup and deletes it afterwards. This resource has been disabled for Rest API version equivalent to or greater than 12. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /api/lunasa/syslog/backups/{backupid}

Delete Syslog Backup File

This resource deletes a specific syslog backup. This resource has been disabled for Rest API version equivalent to or greater than 12. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/syslog/remotehosts

Get List of Syslog Remotehosts

This resources returns a list of configured remote hosts. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `syslog remotehost list`

POST /api/lunasa/syslog/remotehosts

Creates a remote host entry. The identity of a remote host is determined by its address, port and protocol. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `syslog remotehost add`

DELETE /api/lunasa/syslog/remotehosts

Clear Syslog Remotehosts

Deletes all remote hosts entries. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `syslog remotehost clear`

GET /api/lunasa/syslog/remotehosts/{remotehostid}

Get Information of Syslog Remotehost

Gets the information about a specific remote host. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /api/lunasa/syslog/remotehosts/{remotehostid}

Delete Syslog Remotehost

Deletes a specific remote host. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `syslog remotehost delete`

POST /api/lunasa/syslog/remoteHosts/ca

Add Syslog RemoteHost CA

Adds a Certificate Authority(CA) certificate to the truststore. The resource works in two different ways to add CA: **>** User can provide the certificate content to add ca. **>** User can also provide the name of certificate file that should be already uploaded in user's home directory. The certificate can be uploaded through POST /users/{userid}/files. **Note:** - User can have only one CA at a time. - The syslog service needs to be (re)started before a secure connection can be established. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `syslog remotehost cert installCA`

DELETE /api/lunasa/syslog/remoteHosts/ca

Delete Syslog RemoteHost CA

POST /api/lunasa/syslog/remoteHosts/csr

Generate Syslog RemoteHost Certificate Signing Request

Generates a certificate signing request for client certificate. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `syslog remotehost cert gen -csr`

PUT /api/lunasa/syslog/remoteHosts/certificate

Generate/Install HSM Certificate

Generates a private key and self-signed HSM OR Install the HSM certificate. The resource works in three different ways to Generate/install certificate: **>** User can generate self-signed certificate using attributes, provide in the payload. **>** User can upload and install the CA signed certificate using this single resource. **>** User can also provide the name of CA signed certificate file that has already been uploaded in user's home directory. The certificate can be uploaded through POST /users/{userid}/files. **Note:** The syslog service needs to be (re)started before a secure connection can be established. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `syslog remotehost cert gen and syslog remotehost cert install`

PATCH /api/lunasa/syslog/remoteHosts/certificate

Generate Self-Signed HSM Certificate

Generates a private key and self-signed HSM certificate. **Note:** The syslog service needs to be (re)started before a secure connection can be established. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `syslog remotehost cert gen`

DELETE /api/lunasa/syslog/remoteHosts/certificate

Delete HSM Certificate

Deletes the HSM certificate from the truststore. **Note:** The syslog service needs to be (re)started after the deletion of HSM certificate. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `syslog remotehost cert delete`

GET /api/lunasa/upgrades

Get List of Available License

This resource returns a list of upgrades applied on appliances. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/upgrades

Apply Upgrade LNH Capability License

This resource is for applying an upgrade file on appliances. This resource requires HSM SO authentication. The resource works in two different ways: **>** User can upload and apply the license using this single resource. **>** User can also provide the name of license file that has already been uploaded in user's home directory. The license can be uploaded through POST /users/{userid}/files. Only ".lic" file can be accepted as license name. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/upgrades/{upgradeid}

Get Information about License

This resource returns properties of a specific upgrade. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /api/lunasa/upgrades/{upgradeid}

Remove Capability Upgrade License

This resource revokes a specific upgrade on appliances. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/user

Provides access to sub-resources or fields of appliance user

Returns information about user, including links or references to related sub-endpoints or specific fields available under this resource. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/user/config

Get Appliance User Config Resources

Get user configuration related endpoints. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/user/config/password

Get Appliance User Password Configuration

Get user password configuration related information and endpoints. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf user show`

PUT /api/lunasa/user/config/password

Put Appliance User Password Configuration

Update user password related configuration. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf user password`

PATCH /api/lunasa/user/config/password

Patch Appliance User Password Configuration

Update user password related configuration. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf user password`

GET /api/lunasa/user/config/password/actions

List Actions Supported for Appliance User Password Configuration

Get user password configuration related actions. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/user/config/password/actions/enable

Enable Appliance User Password Configuration

Enforce Appliance User password Configuration with default value of minLength, history and Expiry of the password. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/user/config/password/actions/disable

Disable Appliance User Password Configuration

Disables Appliance User password Configuration, which will allow to set or use any password. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/user/config/login

Get Appliance User Login Configuration

Get user login configuration related information and endpoints. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf user show`

PUT /api/lunasa/user/config/login

Put Appliance User Login Configuration

Update user login related configuration. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf user login`

PATCH /api/lunasa/user/config/login

Patch Appliance User Login Configuration

Update user login related configuration. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf user login`

GET /api/lunasa/user/config/login/actions

List Actions Supported on Appliance User Login Configuration

Get user login configuration related actions. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/user/config/login/actions/enable

Enable Appliance User Login Configuration

Enforce Appliance User Login restrictions with default values of FailedLoginAttempts, Detection Window and Release window. It will monitor their bad password login activity. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf user login`

POST /api/lunasa/user/config/login/actions/disable

Disable Appliance User Login Configuration

Disables Appliance User Login configuration, which allow Users to work without any login restrictions. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `sysconf user login -disable`

GET /api/lunasa/webServer

Get Current Webserver Configuration

Gets the configuration of the webserver providing the REST API. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `webserver show`

PUT /api/lunasa/webServer

Put Webserver Configuration

Sets the configuration of the web server providing the REST API. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PATCH /api/lunasa/webServer

Patch Webserver Configuration

Changes the configuration of the web server providing the REST API. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/webServer/actions

List Webserver Supported Actions

Gets all actions that an administrator can perform on the webserver. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/webServer/actions/setDefaultCipherList

Set Default Cipher List

Resets the cipher list to the system default. Service restart is required and will be performed automatically; changes take effect immediately. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/webServer/actions/setDefaultGroupList

Set Default Group List

Resets the group list to the system default. Service restart is required and will be performed automatically; changes take effect immediately. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/webServer/certificate

Get Webserver Certificate

Retrieves the webserver certificate attributes. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PUT /api/lunasa/webServer/certificate

Replace/Update Webserver Certificate

Regenerates the Webserver Certificate. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PATCH /api/lunasa/webServer/certificate

Regenerate Webserver Certificate Partial Attributes

Regenerates the webserver certificate with the given amount of fields. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/webServer/csr

Generate Webserver Certificate Signing Request

Generates a certificate signing request for the webserver's certificate. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/webServer/blocklist

Get Webserver Blocklist Configuration

Gets the web server blocklist configuration. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PUT /api/lunasa/webServer/blocklist

Put Webserver Blocklist Configuration

Modifies the web server blocklist configuration. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PATCH /api/lunasa/webServer/blocklist

Patch Webserver Blocklist Configuration

Modifies the given web server blocklist configuration entries. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/webServer/blocklist/actions

List Webserver Blocklist Supported Actions

Gets the list of web server blocklist actions. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/webServer/blocklist/actions/reset

Reset Webserver Blocklist

Reset the Webserver blocklist and clear all client IP entries. Once reset, clients that were previously blocklisted, will be able to communicate with Webserver Service again. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms

List of HSMs

Gets all HSMs associated with the appliance. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}

Get information about HSM

Gets the information associated with a specific HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm show`

PUT /api/lunasa/hsms/{hsmid}

Initialize HSM

Initializes a specific HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `hsm init`

GET /api/lunasa/hsms/{hsmid}/actions

List of action performed on HSM

Gets all actions that can perform on the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/actions/zeroize

Zeroize the HSM

Zeroize the HSM **>** All partitions and data will be erased. **>** HSM level policies will not be changed. **>** All current NTLS and/or STC sessions will be terminated. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `hsm zeroize`

POST /api/lunasa/hsms/{hsmid}/actions/factoryReset

Factory Reset the HSM

Factory Reset the HSM **>** All partitions and data will be erased. **>** Partition policies will be reverted to factory settings. **>** HSM level policies will be reverted to factory settings. **>** Remote PED vector will be erased. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `hsm factoryReset`

POST /api/lunasa/hsms/{hsmid}/actions/selfTest

Self-Test the HSM

Test the HSM Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm selfTest`

POST /api/lunasa/hsms/{hsmid}/actions/stmTransport

Enter Secure Transport Mode

Enables secure transport mode Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm stm transport`

POST /api/lunasa/hsms/{hsmid}/actions/stmRecover

Exit Secure Transport Mode

Disables secure transport mode Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm stm recover`

POST /api/lunasa/hsms/{hsmid}/actions/timeSync

Synchronize HSM Time to Host Time

Synchronize HSM Time to Host Time Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `hsm time sync`

POST /api/lunasa/hsms/{hsmid}/login

Perform HSM SO Login

Login as the HSM Admin (SO). Login can be performed using one of the following methods: **>** **Direct Login:** Authentication using a password. **>** **Indirect Login:** Authentication using a Base64-encoded response generated by the indirect login process. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm login`

POST /api/lunasa/hsms/{hsmid}/logout

Perform HSM SO Logout

Logout the HSM Admin (SO). Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm logout`

GET /api/lunasa/hsms/{hsmid}/certificate

Generate TWC4 Certificate

Generate the token wrapping certificate needed for indirect login. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/certificate/{certificateid}

Get TWC4 Certificate

Gets the token wrapping certificate needed for indirect login. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/capabilities

Get list of HSM capabilities

Gets all capabilities associated with the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm showPolicies`

GET /api/lunasa/hsms/{hsmid}/capabilities/{capabilityid}

Get information of specified HSM capability

Gets the information associated with a specific capability. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm showPolicies`

GET /api/lunasa/hsms/{hsmid}/counter

Get information of HSM counters

Gets all counter information associated with the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm information show`

GET /api/lunasa/hsms/{hsmid}/counter/actions

List of actions performed on HSM counter

Gets all actions that can be performed on the counter of the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/counter/actions/clear

Perform specified action on HSM counter

Perform action on the counter of the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm information reset`

GET /api/lunasa/hsms/{hsmid}/firmware

Get HSM Firmware information

Gets firmware version genealogy for the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm firmware show`

GET /api/lunasa/hsms/{hsmid}/firmware/actions

Get supported firmware actions

Gets all actions that can be performed on the firmware of the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/firmware/actions/upgrade

HSM Firmware Upgrade

Upgrade HSM Firmware Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm firmware upgrade`

POST /api/lunasa/hsms/{hsmid}/firmware/actions/rollback

HSM Firmware Rollback

Rollback HSM Firmware Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm firmware rollback`

GET /api/lunasa/hsms/{hsmid}/indirect/key

Generate indirect login public key or PKC

Gets indirect login public key or PKC(Public Key Confirmation) Chain from administration partition of the adminHSM, based on the value of type. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/indirect/key

Initialize Indirect Login

Loads the indirect login public key or PKC(Public Key Confirmation) Chain onto the service HSM in the administration partition, based on the type. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /api/lunasa/hsms/{hsmid}/indirect/key

Uninitialize Indirect Login

Uninitialize the indirect login from the administration partition of the service HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/indirect/challenges

Generate indirect login challenge

Generate the indirect login challenge from the administration partition of the admin HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/indirect/challenge/{challengeid}

Gets indirect login challenge

Gets the indirect login challenge from the administration partition of the admin HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/indirect/key/responses

Generate Indirect Login Response

Generate the indirect login response needed for the service HSM from the administration partition on the admin HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/indirect/key/responses/{responseid}

Gets Indirect Login Response

Gets from the administration partition of the admin HSM the response necessary for indirect login. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/licenses

Gets all licenses

Gets all licenses associated with the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm displayLicenses`

GET /api/lunasa/hsms/{hsmid}/licenses/{licenseid}

Get license Information

Gets the information associated with a specific license. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/metrics

Gets all utilization metrics

Gets all utilization metrics information associated with partitions of the HSM. This resource requires SO authentication and policy 49 which allows partition utilization metrics needs to be changed to 1. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm qos metrics show`

GET /api/lunasa/hsms/{hsmid}/metrics/actions

List of supported metrics actions

Gets all actions that can perform on the HSM Metrics. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/metrics/actions/reset

Resets Utilization Metrics

Resets Partition Utilization Metrics counters to 0. This resource requires SO authentication and policy 49 which allows partition utilization metrics needs to be changed to 1. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm qos metrics reset`

GET /api/lunasa/hsms/{hsmid}/partitions

List all partitions on HSM

Gets all partitions associated with the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `partition list`

POST /api/lunasa/hsms/{hsmid}/partitions

Create Application Partition

Creates a partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `partition create`

DELETE /api/lunasa/hsms/{hsmid}/partitions

Delete Application Partitions

Removes all partitions from the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/ped

Gets all HSM PED resources

Gets all HSM PED resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/ped/peds

Gets all PED associated with the HSM

Gets all PIN-entry devices associated with the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm ped show`

GET /api/lunasa/hsms/{hsmid}/ped/peds/{pedid}

Gets the information associated with a specific PED

Gets the information associated with a specific PED. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm ped show`

PUT /api/lunasa/hsms/{hsmid}/ped/peds/{pedid}

Selects a registered PED server

Selects a registered PED server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm ped select`

PATCH /api/lunasa/hsms/{hsmid}/ped/peds/{pedid}

Patch a registered PED server

Selects a registered PED server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm ped select`

GET /api/lunasa/hsms/{hsmid}/ped/peds/{pedid}/actions

List of supported ped actions

Gets all actions that can perform on the HSM PED. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/ped/peds/{pedid}/actions/connect

Connect a remote PED connection

Connect a remote PED connection. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm ped connect`

POST /api/lunasa/hsms/{hsmid}/ped/peds/{pedid}/actions/disconnect

Disconnect a remote PED connection

Disconnect a remote PED connection. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm ped disconnect`

POST /api/lunasa/hsms/{hsmid}/ped/peds/{pedid}/actions/vectorInitialize

Initialize remote PED vector

Initialize remote PED vector. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `hsm ped vector init`

POST /api/lunasa/hsms/{hsmid}/ped/peds/{pedid}/actions/vectorErase

Erase remote PED vector

Erase remote PED vector. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `hsm ped vector erase`

GET /api/lunasa/hsms/{hsmid}/ped/servers

List registered remote PED servers

List all registered PED servers. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm ped server list`

POST /api/lunasa/hsms/{hsmid}/ped/servers

Registers a PED server to the HSM. The resource works in two different ways to register ped server: **>** User can provide the certificate content to register. **>** User can also provide the name of certificate file that should be already uploaded in user's home directory. The certificate can be uploaded through POST /users/{userid}/files. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `hsm ped server register`

DELETE /api/lunasa/hsms/{hsmid}/ped/servers

Removes all registered PED servers

Removes all registered PED servers. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/ped/servers/{serverid}

Gets the information associated with a specific registered PED server

Gets the information associated with a specific registered PED server. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /api/lunasa/hsms/{hsmid}/ped/servers/{serverid}

Delete a remote PED server registration

Removes a specific registered PED server. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `hsm ped server delete`

GET /api/lunasa/hsms/{hsmid}/policies

Get List of HSM Policies

Gets all policies associated with the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm showPolicies`

POST /api/lunasa/hsms/{hsmid}/policies

Generate HSM policy template

Export HSM Policy Template. It will overwrite the content of file if the specified file is already exist. Policy template file will be created/updated in user's directory Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm showPolicies -exportTemplate`

GET /api/lunasa/hsms/{hsmid}/policies/{policyid}

Get HSM Policy Information

Gets the information associated with a specific HSM policy. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PUT /api/lunasa/hsms/{hsmid}/policies/{policyid}

Set HSM Policy Value

Configure HSM Policy. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm changePolicy`

PATCH /api/lunasa/hsms/{hsmid}/policies/{policyid}

PATCH HSM Policy Value

Configure HSM Policy. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm changePolicy`

GET /api/lunasa/hsms/{hsmid}/roles

Gets all roles associated with the HSM

Gets all roles associated with the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/roles/{roleid}

Gets the information HSM Role

Gets the information associated with a specific HSM role. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PUT /api/lunasa/hsms/{hsmid}/roles/{roleid}

Initializes the HSM role

Initializes the HSM role. This resource is forbidden on the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PATCH /api/lunasa/hsms/{hsmid}/roles/{roleid}

Changes the password for an HSM role

Changes the password for an HSM role. This resource is forbidden on the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/roles/{roleid}/actions

List Actions Supported by HSM Role

Gets all role-related actions associated with the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/roles/{roleid}/reset

Reset Password of HSM Role

Resets Password of specified HSM Role. The new challenge for a password-based HSM. Pass an empty string for a PED-based HSM. This resource is forbidden on the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/roles/{roleid}/createChallenge

Create Challenge for HSM Role

Create Challenge of specified HSM Role. The new challenge for a PED-based HSM. Pass True to have the challenge set to the default value; pass False to have the challenge set to a random value. This resource is forbidden on the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/roles/{roleid}/deactivate

Deactivate HSM Role

Deactivate of specified HSM Role. This resource is forbidden on the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/storageSpace

Gets the storage information associated with the HSM

Gets the storage information associated with the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm show`

GET /api/lunasa/hsms/{hsmid}/supportInfo

Generate and Download SupportInfo

Gets hsm supportInfo.txt file in the archive form. This supportInfo.txt file includes detailed information about the state and settings of the HSM, as well as other important appliance information, such as the network settings and negotiated link status. This resource has been disabled for Rest API version equivalent to or greater than 12. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm supportInfo`

POST /api/lunasa/hsms/{hsmid}/supportInfo

Generate SupportInfo

Generates a supportInfo.txt file.The supportInfo.txt file includes detailed information about the state and settings of the HSM, as well as other important appliance information, such as the network settings and negotiated link status. This can later be downloaded in the archive form. **Note:** The file or the response will be available in a compressed (.tgz) format. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm supportInfo`

GET /api/lunasa/hsms/{hsmid}/tamper

Display the HSM Tamper state

Gets the information regarding detected tampers. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm tamper show`

GET /api/lunasa/hsms/{hsmid}/tamper/actions

List Actions Supported by HSM Tamper

Gets all actions applicable to tampers. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/tamper/actions/clear

Clear HSM Tamper State

Clear HSM Tamper State Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `hsm tamper clear`

GET /api/lunasa/hsms/{hsmid}/tokens

List All Backup Tokens.

List All Backup Tokens. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `token backup list`

GET /api/lunasa/hsms/{hsmid}/tokens/{tokenid}

Get Backup Token Information

Get Backup Token Information. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `token backup show`

PUT /api/lunasa/hsms/{hsmid}/tokens/{tokenid}

Initialize Backup Token

Initialize Backup Token. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `token backup init`

POST /api/lunasa/hsms/{hsmid}/tokens/{tokenid}/login

Login Backup Token Admin. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `token backup login`

POST /api/lunasa/hsms/{hsmid}/tokens/{tokenid}/logout

Logout Backup Token Admin

Logout Backup Token Admin. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `token backup logout`

GET /api/lunasa/hsms/{hsmid}/tokens/{tokenid}/rped/actions

List Actions Supported by Token for RPED

List Actions Supported by Token for RPED. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/tokens/{tokenid}/rped/actions/connect

Connect Backup Token to Remote PED

Connect Backup Token to Remote PED connection. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm ped connect`

POST /api/lunasa/hsms/{hsmid}/tokens/{tokenid}/rped/actions/disconnect

Disconnect Backup Token to Remote PED

Disconnect Backup Token to Remote PED connection. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm ped disconnect`

POST /api/lunasa/hsms/{hsmid}/tokens/{tokenid}/rped/actions/vectorInitialize

Init Remote PED vector for backup Token

Init Remote PED vector for backup Token. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `hsm ped vector init`

POST /api/lunasa/hsms/{hsmid}/tokens/{tokenid}/rped/actions/vectorErase

Erase Remote PED vector for backup Token

Erase Remote PED vector for backup Token. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `hsm ped vector erase`

GET /api/lunasa/hsms/{hsmid}/updates

Show Available HSM Updates

Gets all updates associated with the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `hsm update show`

POST /api/lunasa/hsms/{hsmid}/updates/{updateid}

Update HSM Capability

Applies a specific HSM update. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `hsm update capability`

GET /api/lunasa/hsms/{hsmid}/utilization

Gets all HSM utilization resources

Gets all HSM utilization resources, reset time, and actions. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/utilization/bins

Gets all HSM utilization binaries

Gets all HSM utilization binaries. The expand parameter can be set to obtain further data. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/utilization/bins/{binid}

Gets an HSM utilization binary

Gets an HSM utilization binary. The expand parameter can be set to obtain further data. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/utilization/bins/{binid}/counters

Gets the counters for an HSM utilization binary

Gets the counters for an HSM utilization binary. The expand parameter can be set to obtain further data. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/utilization/bins/{binid}/counters/{counterid}

Gets the count for an HSM utilization binary counter

Gets the count for an HSM utilization binary counter. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}

Gets partition information

Gets the information associated with a specific partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `partition show` **LunaCM command:** `partition showinfo`

PUT /api/lunasa/hsms/{hsmid}/partitions/{partitionid}

Initializes PPSO application partition

This resource allows to initialize the partition. Initialization of the partition will init the PSO role. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `partition init` **LunaCM command:** `partition init`

PATCH /api/lunasa/hsms/{hsmid}/partitions/{partitionid}

Rename/Resize Partition

This resource allows to change the size of the partition or rename the partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `partition resize and partition rename`

DELETE /api/lunasa/hsms/{hsmid}/partitions/{partitionid}

Delete Application Partition

This resource allows to delete the partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `partition delete`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/login

Partition Role Login

Logs in to the partition. Login can be performed using one of the following methods: **>** **Direct Login:** Authentication using a password. **>** **Indirect Login:** Authentication using a Base64-encoded response generated by the indirect login process. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.` **LunaCM command:** `role login`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/logout

Partition Role Logout

Logs out of the partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.` **LunaCM command:** `role logout`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/certificate

Generate TWC4 Certificate

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/certificate/{certificateid}

Get TWC4 Certificate

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/capabilities

Get list of Partition capabilities

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/capabilities/{capabilityid}

Get information of specified HSM capability

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/domains

List cloning domains

Display a list of the domains configured for the partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.` **LunaCM command:** `partition domainlist`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/domains

Add a cloning domain

Add a cloning domain to the partition. Partitions are assigned their own domain when initialized, and in that default state, they can perform cloning/HA operations only with other partitions sharing that single domain. The resource is used to add a domain so that partitions can clone objects with the partitions that have same domains. **Note:** **>** This extended domain management requires REST API version 13. **>** A maximum of three domains can be added to a partition. **>** Domains can be either Password-authenticated or PED-authenticated. **>** Partition policy 44(Allow Extended Domain Management) must be enabled. **>** Partition PO authentication is required to add domain. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.` **LunaCM command:** `partition domainadd`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/domains/{domainid}

Get cloning domain Info

Get specified cloning domain Information. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.` **LunaCM command:** `partition domainlist`

PATCH /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/domains/{domainid}

Change cloning domain label

Changes the domain label of an existing domain. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.` **LunaCM command:** `partition domainchangelabel`

DELETE /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/domains/{domainid}

Delete cloning domain

Deletes an existing domain from the partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin **LunaSH command:** `This endpoint does not have an associated LunaSH command.` **LunaCM command:** `partition domaindelete`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/indirect/challenges/{challengeid}

Gets indirect login challenge

Gets the indirect login challenge from the application partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/indirect/challenges

Generate indirect login challenge

Generate the indirect login challenge from the application partition of the admin HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/indirect/key

Generate indirect login public key or PKC

Gets indirect login public key or PKC(Public Key Confirmation) Chain from application partition of the HSM, based on the value of type. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/indirect/key

Initialize Indirect Login

Loads the indirect login public key or PKC(Public Key Confirmation) Chain onto the service HSM in the application partition, based on the type. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/indirect/key

Uninitialize Indirect Login

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/indirect/key/responses/{responseid}

Gets Indirect Login Response

Gets from the application partition of the admin HSM the response necessary for indirect login. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/indirect/key/responses

Generate Indirect Login Response

Generate the indirect login response needed for the service HSM from the application partition on the admin HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/object

List Resources for Partition Object

Gets all partition object resources. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/object/objects

List Partition Objects

Gets all objects in the partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `partition showContents` **LunaCM command:** `partition contents`

DELETE /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/object/objects

Delete All Partition Objects

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/object/objects/{objectid}

Gets Partition Object Information

Gets the information associated with a specific partition object. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

DELETE /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/object/objects/{objectid}

Delete Specified Partition Object

Removes an object from a partition on the HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/object/actions

List Actions Supported on Partition Object

Gets all actions applicable to partition objects. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/object/actions/backup

Backup Partition

Backs up partition to backup token. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `partition backup`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/object/actions/restore

Restore Partition

Restores partition from backup token. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `partition restore`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/policies

Get List of Partition Policies

Gets all policies associated with the Partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `partition showPolicies` **LunaCM command:** `partition showPolicies`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/policies

Generate Partition Policy Template

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/policies/{policyid}

Get HSM Policy Information

Gets the information associated with a specific Partition policy. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

PUT /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/policies/{policyid}

Set Partition Policy Value

Configure Partition Policy. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `partition changePolicy` **LunaCM command:** `partition changePolicy`

PATCH /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/policies/{policyid}

PATCH Partition Policy Value

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/roles

Gets all roles associated with the Partition

Gets all roles associated with the Partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.` **LunaCM command:** `role list`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/roles/{roleid}

Gets the information Partition Role

Gets the information associated with a specific Partition role. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.` **LunaCM command:** `role show`

PUT /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/roles/{roleid}

Initializes the Partition role

Initializes the Partition role. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `partition init` **LunaCM command:** `role init`

PATCH /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/roles/{roleid}

Changes the password for a Partition role

Changes the password for a Partition role. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `partition changePw` **LunaCM command:** `role changePw`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/roles/{roleid}/actions

List Actions Supported by Partition Role

Gets all role-related actions associated with the Partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/roles/{roleid}/reset

Reset Password of Partition Role

Resets Password of specified Partition Role. The new challenge for a password-based HSM. Pass an empty string for a PED-based HSM. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `This endpoint does not have an associated LunaSH command.` **LunaCM command:** `role resetPW`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/roles/{roleid}/createChallenge

Create Challenge for Partition Role

Create Challenge of specified Partition Role. The new challenge for a PED-based HSM. Pass True to have the challenge set to the default value; pass False to have the challenge set to a random value. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `partition createChallenge` **LunaSH command:** `role createChallenge`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/roles/{roleid}/deactivate

Deactivate Partition Role

Deactivate of specified Partition Role. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator **LunaSH command:** `partition deactivate` **LunaCM command:** `role deactivate`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/smk

Gets all the SMK Keys

Gets all the SMK Keys. The expand parameter can be set to obtain further data. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `partition show`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/smk/{smkid}

Gets the SMS Key state.

Gets the SMS Key state. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `partition show`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/smk/{smkid}/actions

List Supported Actions by SMK

Gets a list of actions permitted on a SMK keys. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/smk/{smkid}/actions/start

Start Rollover

Start SMK rollover, moving the pre-existing SMK to the Rollover space, and creating a new SMK in the Primary SMK space. **Note:** Action start is only supported by key smk-fw7-rollover. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.` **LunaCM command:** `partition smkrollover -start`

POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/smk/{smkid}/actions/end

End Rollover

End SMK rollover and delete the Rollover SMK. **Note:** Action end is only supported by key smk-fw7-rollover. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.` **LunaCM command:** `partition smkrollover -end`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/stc

Export the partition identity

Export the partition identity from the specified partition. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `partition stcIdentity export`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/utilization

Gets Partition Utilization Resources and Reset Time

Gets all partition utilization resources, reset time, and actions. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/utilization/bins

Gets All Partition Utilization Binaries

Gets all partition utilization binaries. The expand parameter can be set to obtain further data. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/utilization/bins/{binid}

Gets Partition Utilization Binary

Gets a partition utilization binary. The expand parameter can be set to obtain further data. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/utilization/bins/{binid}/counters

Gets Counters for Partition Utilization Binary

Gets the counters for a partition utilization binary. The expand parameter can be set to obtain further data. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/utilization/bins/{binid}/counters/{counterid}

Gets Count for Partition Utilization Binary Counter

Gets the count for a partition utilization binary counter. Only users assigned the following roles are authorized to access this endpoint: **>** admin
**>** operator
**>** monitor **LunaSH command:** `This endpoint does not have an associated LunaSH command.`



	SUPPORT	LEGAL
Luna Network HSM 7 Documentation © Copyright 2001-2026, Thales Group Last Updated: 2026-06-26 09:55:10 GMT-04:00	Customer Release Notes Customer Support Portal Support Contacts	End User License Agreement Third Party Software Licenses Document Information