REST API  17
REST API for Luna Network HSMs
Validation Schema

Appliance Role

Parameter: role
Description: The role associated with the user.
Type: String
Required In:

Min Length: 1
Max Length: 64
Example: "restRole"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), and underscore (_)
Regex: ^[a-zA-Z0-9_]{1,64}$
Disallowed Characters: !#$%^&*()<>?:;"'{}[]|.- </code><br> **Special Constraints**:N/A`
Used In:

Appliance User Fullname

Parameter: fullName
Description: The full name of the user.
Type: String
Required In:

Min Length: 1
Max Length: 32
Example: "Rest User"
Default: ""
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), hyphen (-), underscore (_), and space
Regex: ^[a-zA-Z][a-zA-Z0-9_ -]{0,31}$
Disallowed Characters: !#$%^&*()<>?.:;"'`{}[]|
Special Constraints:

  • Must start with a letter (a-z, A-Z)
  • Cannot start with numbers or special characters.
  • Spaces are allowed.

Used In:

Appliance User Name

Parameter: userId, userid
Description: The user ID of the user.
Type: String
Required: Yes
Min Length: 1
Max Length: 32
Example: "restUser"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), dot (.), hyphen (-), and underscore (_)
Regex: ^[a-zA-Z_][a-zA-Z0-9_.-]{0,31}$
Disallowed Characters: !#$%^&*()<>?:;"'{}[]`|
Special Constraints:

  • Must start with a letter (a-z, A-Z) or underscore (_)
  • Cannot start with numbers or special characters.
  • Spaces are not allowed.

Used In:

Appliance User Password

Parameter: password OR currentPassword
Description: The password associated with the user.
Type: String
Required: Yes
Min Length: 8
Max Length: 255
Example: "restUserP@ssword123"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), space, and special characters: _ $ ( ) * + . / ^ [ ] { } ! # % , : = @ ~ \ ' & | < > ? ‘ ; " - <br> **Regex**: ^[a-zA-Z0-9_ $()*+./^[]{}!#%,:=&rsquo;&|<>?`;"'-]{8,255}$
Disallowed Characters: none
Special Constraints:

  • The password must contain at least one character from Uppercase (A-Z), Lowercase (a-z), Numbers (0-9) and Special characters.

Used In:

Base64 Encoded Data used with Indirect Login

Parameter: challenge, certificate, exponent, modulus, pkcChain, response
Description: A Base64-encoded string.
Type: String
Required In:

Min Length: 4
Max Length: 10240
Example: "SGVsbG8gV29ybGQh"
Default: N/A
Allowed Characters: Uppercase and lowercase letters (A-Z, a-z), digits (0-9), plus (+), forward slash (/), and padding character equals (=)
Regex: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)$
Disallowed Characters: Any characters outside the Base64 alphabet including whitespace, newlines, and other symbols.
Special Constraints:

  • String length must be between 4 and 10240 characters.
  • Must conform to Base64 encoding rules, including correct padding with =.
  • Padding characters (=) can appear only at the end, and either one or two may be present depending on input length.

Used In:

Cert Common Name

Parameter: cn
Description: The Common Name is a field in the Subject of a certificate that identifies the entity the certificate is issued to.
Type: String
Required In:

Min Length: 1
Max Length: 64
Example: "SampleCN"
Default: The default value is device's hostname.
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Dot (.), Hyphen (-).
Regex: ^[a-zA-Z0-9][a-zA-Z0-9.-]{0,62}[a-zA-Z0-9]?$
Disallowed Characters: Spaces, special characters outside allowed set, starting or ending with dot or hyphen.
Special Constraints:

  • Must start and end with an alphanumeric character.
  • Length must be between 1 and 64 characters.

Used In:

Cert Country

Parameter: country
Description: The ISO 3166-1 alpha-2 country code.
Type: String
Required In:

Min Length: 2
Max Length: 2
Example: "US"
Default: N/A
Allowed Characters: Uppercase English letters (A–Z)
Regex: ^[A-Z]{2,2}$
Disallowed Characters: Lowercase letters, digits, whitespace, and all special characters including: @, !, #, $, %, ^, &, *, ', ", (, ), -, _, =, +, {, }, [, ], :, ;, <, >, ., ,, ?, /, \, |, `
Special Constraints:

  • Must be exactly 2 characters long.
  • Only uppercase alphabetic characters are allowed.
  • No digits, spaces, or symbols permitted.

Used In:

Cert Location

Parameter: location
Description: A location identifier string starting with a letter and followed by alphanumeric characters, underscores, dots, or hyphens.
Type: String
Required In:

Min Length: 1
Max Length: 64
Example: "New_York.123-45"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), underscore (_), dot (.), and hyphen (-)
Regex: ^[a-zA-Z][a-zA-Z0-9_.-]{0,63}$
Disallowed Characters: Any character not listed above, including spaces, special symbols like @, #, $, %, &, *, parentheses, and starting with digits or special characters.
Special Constraints:

  • Must start with an English letter (a-z or A-Z).
  • Can contain letters, digits, underscores, dots, and hyphens after the first character.
  • Cannot start with digits or special characters.

Used In:

Cert Organization Unit

Parameter: orgUnit
Description: An organizational unit identifier starting with a letter and followed by alphanumeric characters or underscores.
Type: String
Required In:

Min Length: 1
Max Length: 64
Example: "Finance_Dept1"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9) and underscore (_)
Regex: ^[a-zA-Z][a-zA-Z0-9_]{0,63}$
Disallowed Characters: Spaces, hyphens, dots, special characters, and starting with digits or underscores.
Special Constraints:

  • Must start with an English letter (a-z or A-Z).
  • Subsequent characters may be letters, digits, or underscores.
  • Cannot start with a digit or underscore.

Used In:

Cert Organization

Parameter: organization
Description: An organization identifier string that starts with a letter and may be followed by alphanumeric characters or underscores.
Type: String
Required In:

Min Length: 1
Max Length: 64
Example: "Org_123"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9) and underscore (_)
Regex: ^[a-zA-Z][a-zA-Z0-9_]{0,63}$
Disallowed Characters: Any characters other than letters, digits, or underscore, including spaces, hyphens, dots, and special symbols.
Special Constraints:

  • Must start with an English letter (a-z or A-Z).
  • Subsequent characters can be letters, digits, or underscores.
  • Cannot start with a digit or underscore.

Used In:

Cert State

Parameter: state
Description: A state identifier string starting with a letter and followed by alphanumeric characters or underscores.
Type: String
Required In:

Min Length: 1
Max Length: 64
Example: "California_123"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9) and underscore (_)
Regex: ^[a-zA-Z][a-zA-Z0-9_]{0,63}$
Disallowed Characters: Any character not listed above, including: space ( ), hyphen (-), dot (.), special symbols (@, #, $, %, &, *, etc.), and starting with a digit or underscore Special Constraints:

  • Must start with an English letter (a-z or A-Z).
  • Can contain only letters, digits, and underscores.
  • Cannot start with a digit or underscore.

Used In:

Certificate Curve Name

Parameter: curveName
Description: The name of the elliptic curve used for cryptographic operations.
Type: String
Required In:

Min Length: 9
Max Length: 10
Example: "secp256k1"
Default: N/A
Allowed Values: secp256k1, secp384r1, secp521r1, prime256v1
Regex: ^(secp256k1|secp384r1|secp521r1|prime256v1)$
Disallowed Characters: Any string other than the four allowed curve names above.
Special Constraints:

  • Must exactly match one of the predefined curve names.
  • Length must be between 9 and 10 characters, matching one of the options.

Used In:

CTC Class

Parameter: ctcClassName
Description: Name of the CTC class consisting of alphanumeric characters and select special characters :=@_.
Type: String
Required: Yes
Min Length: 1
Max Length: 32
Example: "CTC_Class1:=@"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Special characters: colon (:), equals (=), at symbol (@), underscore (_).
Regex: ^[a-zA-Z0-9:=@_]{1,32}$
Disallowed Characters: Any characters outside the allowed set, including spaces and other special symbols.
Special Constraints:

  • Length must be between 1 and 32 characters.
  • No spaces allowed.

Used In:

Date

Parameter: date
Description: A date string in YYYY-MM-DD format.
Type: String
Required In:

Min Length: 10
Max Length: 10
Example: "2025-06-17"
Default: N/A
Allowed Characters: Digits (0–9) and hyphen (-)
Regex: ^[0-9]{4}-[0-1]{1}[0-9]{1}-[0-3]{1}[0-9]{1}$
Disallowed Characters: Any character other than digits and hyphen, including: letters (a-z, A-Z), spaces, slashes (/, ), dots (.), underscores (_), or symbols like @, #, etc.
Special Constraints:

  • Must be exactly 10 characters long, following the YYYY-MM-DD format.
  • Year must be 4 digits.
  • Month must be 2 digits (00–19 accepted by pattern; may need further validation).
  • Day must be 2 digits (00–39 accepted by pattern; may need further validation).
  • This regex checks structure but does not validate actual calendar correctness (e.g., 2025-13-40 would match the pattern but is not a real date).

Used In:

Email for user and Key & Cert

Parameter: email
Description: A valid email address.
Type: String
Required In:

Min Length: 3
Max Length: 128
Example: "user.name+tag@example-domain.com"
Default: N/A
Allowed Characters:

  • Local part: alphanumeric (a-z, A-Z, 0-9), underscore (_), dot (.), percent (%), plus (+), hyphen (-)
  • Domain part: alphanumeric, dot (.), hyphen (-)
  • Top-level domain: letters only (a-z, A-Z), minimum 2 characters

Regex: ^[a-zA-Z0-9_.%+-]+@[a-zA-Z0-9.-]+.[a-zA-Z]{2,}$
Disallowed Characters: Spaces, special characters outside those listed above, multiple consecutive dots in local or domain parts, and invalid TLDs shorter than 2 letters.
Special Constraints:

  • Must contain a single @ symbol separating local and domain parts.
  • Local part allows a-z, A-Z, 0-9, _, ., %, +, -.
  • Domain part allows a-z, A-Z, 0-9, ., and -.
  • Top-level domain must be at least 2 alphabetic characters.
  • Length must be between 3 and 128 characters inclusive.

Used In:

Filename With Extension

Parameter: fileid
Description: A filename including extension. The name can contain alphanumeric characters, underscores, dots, hyphens, and spaces, but cannot start or end with a space.
Type: String
Required: Yes
Min Length: 1
Max Length: 64
Example: "report_final-2025.txt"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), dot (.), hyphen (-), and space ( ).
Regex: ^([a-zA-Z0-9_-]|[a-zA-Z0-9_.-][a-zA-Z0-9_. -]*[a-zA-Z0-9_.-])$
Disallowed Characters: Leading or trailing spaces; special characters outside the allowed set; empty string.
Special Constraints:

  • Length must be between 1 and 64 characters.
  • Cannot start or end with a space.

Used In:

Big Filename With Extension

Parameter: fileid
Description: A filename including extension. The name can contain alphanumeric characters, underscores, dots, hyphens, and spaces, but cannot start or end with a space.
Type: String
Required: Yes
Min Length: 1
Max Length: 128
Example: "report_final-2025.txt"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), dot (.), hyphen (-), and space ( ).
Regex: ^([a-zA-Z0-9_-]|[a-zA-Z0-9_.-][a-zA-Z0-9_. -]*[a-zA-Z0-9_.-])$
Disallowed Characters: Leading or trailing spaces; special characters outside the allowed set; empty string.
Special Constraints:

  • Length must be between 1 and 128 characters.
  • Cannot start or end with a space.

Used In:

Filename Without Extension

Parameter: filename without extension
Description: A filename without extension. The name can include alphanumeric characters, underscores, dots, hyphens, and spaces but must not start or end with a space.
Type: String
Required: Yes
Min Length: 1
Max Length: 60
Example: "My_file-name 01"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), dot (.), hyphen (-), and space ( ).
Regex: ^([a-zA-Z0-9_-]|[a-zA-Z0-9_.-][a-zA-Z0-9_. -]*[a-zA-Z0-9_.-])$
Disallowed Characters: Leading or trailing spaces; special characters outside those listed above; empty string.
Special Constraints:

  • Filename length must be between 1 and 60 characters, excluding the 4-character extension.
  • Filename cannot start or end with a space.
  • Extension (typically 3 characters plus a dot) is reserved separately and not included here.

Used In:

HSM Label

Parameter: label
Description: An identifier string containing only alphanumeric characters and underscores.
Type: String
Required In:

Min Length: 1
Max Length: 32
Example: "user_1234"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9) and underscore (_)
Regex: ^[a-zA-Z0-9_]{1,32}$
Disallowed Characters: Spaces, special characters, punctuation, and any other symbols not listed above.
Special Constraints:

  • No restrictions on starting character; can start with letter, digit, or underscore.
  • Length must be between 1 and 32 characters.

Used In:

HSM Role for Direct Login

Parameter: role
Description: The security function to login on the HSM.
Type: String
Required In:

Min Length: 2
Max Length: 3
Example: "co"
Default: N/A
Allowed Values: so, co, cu, lco
Regex: ^(so|co|cu|lco)$
Disallowed Characters: Any value other than the listed four roles.
Special Constraints:

  • Exact match to one of the allowed role values.
  • Length must be either 2 or 3 characters, matching the allowed values.

Used In:

HSM Roles for Indirect Login

Parameter: roles
Description: The list of primary roles used for initialize indirect login. For type value legacyKey and Key, this field will be optional/ignored.
Type: String
Required In:

Min Length: 2
Max Length: 12
Example: "so,co,cu"
Default: N/A
Allowed Values: so, co, cu, lco
Regex: ^(so|co|cu|lco)(?:,(so|co|cu|lco))*$
Disallowed Characters: Any characters other than the listed values and commas, including spaces, other punctuation, or invalid values.
Special Constraints:

  • The string must contain one or more values separated by commas.
  • Minimum total length is 2 characters (e.g., so).
  • Maximum total length is 12 characters.
  • No spaces allowed between codes and commas

Used In:

HSM STM Random User String

Parameter: randomUserString
Description: The random user string returned when running stmTransport. Applies to the stmRecover action.
Type: String
Required In:

Min Length: 1
Max Length: 19
Example: AX46-s63t-KL7G-tYt6
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), Special characters: $ + [ ] { } ( ) / = ? ' # @ ; : , ~ . \ -
Regex: ‘^[a-zA-Z0-9_ $+[]{}()=?’#@;:,~.-]{1,19}$`
Disallowed Characters: Any characters outside the allowed set, including spaces and control characters.
Special Constraints:

  • Length must be between 1 and 19 characters.
  • No restrictions on starting or ending characters.

Used In:

HSM/Partition Cloning Domain

Parameter: domain
Description: A string starting with a non-whitespace character followed by allowed characters including alphanumeric, spaces, and select special symbols.
Type: String
Required In:

Min Length: 2
Max Length: 129
Example: "A_valid_string!@# 123"
Default: ""
Allowed Characters: First character: any character except whitespace (no space, tab, newline, etc.) Subsequent characters: letters (a-z, A-Z), digits (0-9), underscore (_), space ( ), and symbols: ! @ # $ % ^ * - = + [ ] { } ( ) / : ' , . ~ ?
Regex: ^[^\s&|<>;"‘][a-zA-Z0-9_ !#$%^*=+[]{}()/:’,.~?-]{1,128}$
Disallowed Characters: Leading whitespace; characters outside the allowed set above; control characters and other special symbols like backslash (), double quotes ("), angle brackets (<>), and backticks (`)
Special Constraints:

  • The string must not start with any whitespace character.
  • Subsequent characters can include spaces and listed special characters.
  • In the context of PED based authentication, domain is optional; in contrast, Password based authentication requires domain to be provided.

Used In:

HSM/Partition PED Mode

Parameter: ped
Description: ‘The identifier of the PED connected to the HSM. '0’ is local PED; '1' is remote PED.`
Type: String
Required In:

Min Length: 1
Max Length: 1
Example: "0"
Default: "0"
Allowed Characters: Only the digits 0 or 1
Regex: ^[01]{1,1}$
Disallowed Characters: Any character other than 0 or 1
Special Constraints:

  • Must be exactly one character long.
  • Value must be either 0 or 1.

Used In:

HSM/Partition Role Passwords or Challenge Secrets

Parameter: password, oldPassword, newPassword
Description: Password for HSM SO, Partition SO, CO, CU, LCO
Type: String
Required In:

Min Length: 8
Max Length: 255
Example: Pass_word!#1234 @2025
Default: "" Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), Space ( ), Special characters: ! # $ % ' ( ) * + , . / : = ? @ [ ] ^ { } ~ -
Regex: ^[a-zA-Z0-9_!#$'()*+,./:=? @[]^{}~-]{8,255}$
Disallowed Characters: Any characters outside the allowed set, including backslashes (), double quotes ("), angle brackets (<>), backticks (`), and control characters.
Special Constraints:

  • Length must be between 8 and 255 characters.
  • No restrictions on starting or ending characters.
  • In the context of PED based authentication, password is optional; in contrast, Password based authentication requires password to be provided.

Used In:

IPv6 Address

Parameter: ipv6Address
Description: A full IPv6 address consisting of exactly eight groups of 1 to 4 hexadecimal digits separated by colons.
Type: String
Required: Yes
Min Length: 2
Max Length: 39
Example: "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
Default: N/A
Allowed Characters: Hexadecimal digits (0-9, a-f, A-F), Colon (:) as separator.
Regex: ^([a-fA-F0-9]{1,4}:){7}[a-fA-F0-9]{1,4}$
Disallowed Characters: Any characters outside the hex digits and colon separator; incomplete or compressed IPv6 forms (e.g., with ::) are not matched.
Special Constraints:

  • Must have exactly eight groups separated by colons.
  • Each group is 1 to 4 hex digits.
  • Length must be between 2 and 39 characters.

Used In:

Network Bond Mode

Parameter: mode
Description: Specifies the bonding mode for network interfaces.
Type: String
Required: Yes
Min Length: 4
Max Length: 13
Example: "active-backup"
Default: N/A
Allowed Values: active-backup, broadcast, lacp
Regex: ^(active-backup|broadcast|lacp)$
Disallowed Values: Any value not exactly matching one of the above
Special Constraints:

  • Value must exactly match one of the allowed bond modes.
  • Length must be between 4 and 13 characters matching the selected mode.

Used In:

Network Hostname

Parameter: networkHostname
Description: A valid network hostname consisting of alphanumeric characters, dots, and hyphens. It must start and end with an alphanumeric character.
Type: String
Required: Yes
Min Length: 1
Max Length: 64
Example: "host.example-com"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Dot (.), Hyphen (-).
Regex: ^[a-zA-Z0-9][a-zA-Z0-9.-]{0,62}[a-zA-Z0-9]?$
Disallowed Characters: Spaces, special characters outside allowed set, starting or ending with dot or hyphen.
Special Constraints:

  • Must start and end with an alphanumeric character.
  • Length must be between 1 and 64 characters.

Used In:

Network Interface IPv4 Configuration

Parameter: ipAddress for interface
Description: Represents an IPv4 address in standard dot-decimal notation or the special keyword "dhcp".
Type: String
Required: Yes
Min Length: 4
Max Length: 15
Example: "192.168.1.100" or "dhcp"
Default: N/A
Allowed Values: Valid IPv4 addresses from 0.0.0.0 to 255.255.255.255 OR The string "dhcp" (case-sensitive).
Regex: ^((?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9]).){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])|dhcp)$
Disallowed Values: Invalid IPv4 addresses (e.g., 999.999.999.999), Any strings other than "dhcp" or a valid IPv4.
Special Constraints:

  • IPv4 addresses must follow dot-decimal notation with each octet between 0 and 255.
  • Length limits: minimum 4 characters (e.g., 0.0.0.0), maximum 15 characters (e.g., 255.255.255.255).
  • The special string "dhcp" is allowed as an alternative to an IP address.
  • No leading zeros in IPv4 if the number is more than one digit (e.g., `01.02.03.04).

Used In:

Network IPv4 IPv6 Hostname

Parameter: address
Description: Represents an IPv4 address, IPv6 address, or a hostname string.
Type: String
Required: Yes
Min Length: 1
Max Length: 64
Example: IPv4: "192.168.1.1" OR IPv6: "2001:0db8:85a3:0000:0000:8a2e:0370:7334" OR Hostname: "example-host.domain"
Allowed Formats:

  • IPv4: Four octets 0-255 separated by dots
  • IPv6: Eight groups of 1 to 4 hex digits separated by colons
  • Hostname: Starts and ends with alphanumeric, contains alphanumerics, dots, or hyphens, length up to 64

Regex: ^((?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9]))|((?:[a-fA-F0-9]{1,4}:){7}[a-fA-F0-9]{1,4})|(a-zA-Z0-9?)$
Disallowed Values: Invalid IP addresses or malformed hostname, Empty strings or strings longer than 64 characters.
Special Constraints:

  • Length must be between 1 and 64 characters.
  • IPv4 addresses must be valid with octets 0-255.
  • IPv6 addresses must have 8 groups of 1-4 hex digits.
  • No leading zeros in IPv4 if the number is more than one digit (e.g., `01.02.03.04).
  • Hostnames must start and end with alphanumeric characters, may contain dots and hyphens inside.

Network IPv4 IPv6

Parameter: ipAddress
Description: Represents a valid IPv4 or IPv6 address.
Type: String
Required: Yes
Min Length: 2
Max Length: 39
Example: IPv4: "192.168.1.1" OR IPv6: "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
Default: N/A
Allowed Formats:

  • IPv4: Standard dot-decimal notation, each octet 0–255
  • IPv6: Hexadecimal groups separated by colons, 1 to 8 groups, each 1 to 4 hex digits

Regex: ^((?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9]).){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])|([a-fA-F0-9]{1,4}:){1,7}[a-fA-F0-9]{1,4})$
Disallowed Values: Invalid IPv4 or IPv6 formats, Empty string or strings outside length bounds.
Special Constraints:

  • Length must be between 7 (minimum valid IPv4) and 39 (maximum valid IPv6) characters.
  • IPv4 must be valid with octets 0–255.
  • No leading zeros in IPv4 if the number is more than one digit (e.g., `01.02.03.04).
  • IPv6 groups must be 1 to 4 hexadecimal digits, separated by colons.

Used In:

Network Ipv4

Parameter: ipv4Address
Description: A valid IPv4 address in standard dot-decimal notation.
Type: String
Required: Yes
Min Length: 7
Max Length: 15
Example: "192.168.1.1"
Default: N/A
Allowed Characters: Digits (0-9), Dots (.) as separators.
Regex: ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9]).){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$
Disallowed Values: Any invalid IPv4 address (e.g., 256.256.256.256, 999.999.999.999, incomplete addresses)
Special Constraints:

  • Each octet must be between 0 and 255.
  • Length must be between 7 (e.g., 1.1.1.1) and 15 (e.g., 255.255.255.255).
  • No leading zeros if the number is more than one digit (e.g., 01.02.03.04).

Used In:

Network Ping

Parameter: address
Description: A string representing a ping target address or hostname, containing alphanumeric characters, underscores, dots, colons, and hyphens.
Type: String
Required: Yes
Min Length: 7
Max Length: 64
Example: "192.168.1.1" or "host.example.com"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), dot (.), colon (:), hyphen (-)
Regex: ^[a-zA-Z0-9_.:-]{7,64}$
Disallowed Characters: Spaces, special characters outside the allowed set.
Special Constraints:

  • Length must be between 7 and 64 characters.
  • Empty string is not allowed (enforced by min length).

Used In:

Network Route Identifier

Parameter: routeid
Description: Represents a route network identifier consisting of alphanumeric characters, underscores, colons, and dots.
Type: String
Required: Yes
Min Length: 1
Max Length: 64
Example: "192.168.0.0_24_s_50" or "2000%3a%3a18_128_s_1"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), Colon (:), Dot (.)
Regex:`^[a-zA-Z0-9_:.]+$
Disallowed Characters: Spaces, special characters outside the allowed set, control characters.
Special Constraints:

  • Length must be between 1 and 64 characters.
  • No whitespace allowed.

Used In:

Network Search Domain

Parameter: networkSearchDomain
Description: Domain name used for network search, allowing alphanumeric characters, dots, underscores, and hyphens.
Type: String
Required: Yes
Min Length: 1
Max Length: 64
Example: "example-domain_01.com"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Dot (.), underscore (_), hyphen (-).
Regex: ^[a-zA-Z0-9._-]{1,64}$
Disallowed Characters: Spaces, special characters outside allowed set, and control characters.
Special Constraints:

  • Length must be between 1 and 64 characters.
  • No leading or trailing dots or hyphens (enforced separately if needed).

Used In:

Network Route Type

Parameter: routeType
Description: Specifies the type of network route.
Type: String
Required: Yes
Min Length: 4
Max Length: 7
Example: "host"
Default: N/A
Allowed Values: host, network
Regex: ^(host|network)$
Disallowed Values: Any value not exactly matching host or network
Special Constraints:

  • Value must be exactly either host or network.
  • Length must be 4 or 7 characters matching the selected value.

Used In:

NTLS Client

Parameter: clientId
Description: An identifier string that can include alphanumeric characters, underscore (_), dot (.), colon (:), and hyphen (-), but cannot be exactly "server".
Type: String
Required: Yes
Min Length: 1
Max Length: 128
Example: "client_01"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), dot (.), colon (:), hyphen (-).
Regex: ^(?!server$)[a-zA-Z0-9_.:-]{1,128}$
Disallowed Values: The exact string "server" is disallowed, Whitespace: (space), tab, newline, Special characters: ! @ # $ % ^ & * ( ) + = { } [ ] \ | ; ' " < > , ? /
Special Constraints:

  • Length must be between 1 and 128 characters.
  • Exact value "server" is not allowed.

Used In:

Package Authcode

Parameter: authCode
Description: A fixed-length authorization code containing exactly 16 characters. Allowed characters are uppercase and lowercase letters, digits, and the forward slash (/) and backslash ().
Type: String
Required: Yes
Min Length: 16
Max Length: 16
Example: "A1b2C3d4E5f6G7H8"
Default: N/A
Allowed Characters: Uppercase letters (A-Z), Lowercase letters (a-z), Digits (0-9), Forward slash (/).
Regex: ^[A-Za-z0-9/]{16,16}$
Disallowed Characters: Any character not listed above, including spaces and special symbols.
Special Constraints:

  • Must be exactly 16 characters long.
  • Case-sensitive.

Used In:

Partition Domain Label

Parameter: domainLabel OR newLabel
Description: A label string containing alphanumeric characters and selected special symbols.
Type: String
Required In:

Min Length: 1
Max Length: 32
Example: "Label_01!@#"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), underscore (_), space ( ), and special characters: $ ^ * ( ) + { } [ ] . ' / ~ ! @ # % - = : , Regex: ^[a-zA-Z0-9_ $^*()+{}[].'/~!#%=:,-]{1,32}$
Disallowed Characters: Any characters outside the allowed set, including control characters, backslashes (), double quotes ("), angle brackets (<>), and other symbols not listed above.
Special Constraints:

  • Length must be between 1 and 32 characters.
  • No restrictions on starting character.

Used In:

Partition Label

Parameter: label
Description: A parameter label string containing alphanumeric characters, spaces, and a set of special characters.
Type: String
Required In:

Min Length: 1
Max Length: 32
Example: "Param_Label #1!"
Default: If no label is provided, the name specified during creation will be used for initialization as Label.
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), underscore (_), space ( ), and special characters: ! @ # $ % ^ * ( ) = + [ ] { } / : ' - , . ~ Regex: ^[a-zA-Z0-9_ !#$%^*()=+[]{}/:',.~-]{1,32}$
Disallowed Characters: Characters outside the allowed set, including backslash (), quotes ("), angle brackets (<>), backtick (`), and other special symbols.
Special Constraints:

  • Length must be between 1 and 32 characters.
  • No restrictions on starting character.

Used In:

Partition Name

Parameter: name
Description: A user-friendly text string to reference the partition after it is created.
Type: String
Required In:

Min Length: 1
Max Length: 32
Example: "Parameter Name #1: Value"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), underscore (_), space ( ), and special characters: ! @ # $ % ^ * ( ) = + { } [ ] : ' , - . / ~
Regex: ^[a-zA-Z0-9_ !#$%^*()=+{}[]:',./~-]{1,32}$
Disallowed Characters: Characters outside the allowed set, including backslash (), double quotes ("), angle brackets (<>), backticks (`), and other symbols.
Special Constraints:

  • Length must be between 1 and 32 characters.
  • No restrictions on starting character.

Used In:

SNMP Authentication Protocol

Parameter: authenticationProtocol
Description: Specifies the hash algorithm to be used. Must be exactly "SHA".
Type: String
Required: Yes
Min Length: 3
Max Length: 3
Example: "SHA"
Default: N/A
Allowed Value: SHA
Regex: ^SHA$
Disallowed Values: Any value other than "SHA"
Special Constraints:

  • Must be exactly 3 characters: S, H, A.
  • Case-sensitive — only uppercase "SHA" is allowed.

Used In:

SNMP Notification Type

Parameter: type
Description: Type of SNMP notification to be sent. Must be either "trap" or "inform".
Type: String
Required In:

Min Length: 4
Max Length: 6
Example: "trap"
Default: N/A
Allowed Values: trap , inform
Regex: ^(trap|inform)$
Disallowed Values: Any value other than "trap" or "inform"
Special Constraints:

  • Exact match to either trap or inform.
  • Length must be 4 or 6 characters only.

Used In:

SNMP Password

Parameter: authenticationPassword OR privacyPassword
Description: Password for SNMP user authentication containing alphanumeric characters, underscores, spaces, and select special characters.
Type: String
Required: Yes
Min Length: 8
Max Length: 128
Example: "P@ssw0rd!#2025"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), space ( ), Special characters: $ ( ) [ ] { } * + . / ^ ! # % , : = @ ~ ? ' -
Regex: ‘^[a-zA-Z0-9_ $()[]{}*+./^!#%,:=?’-]{8,128}$`
Disallowed Characters: Characters outside the allowed set, including backslashes (), double quotes ("), angle brackets (<>), and control characters.
Special Constraints:

  • Length must be between 8 and 128 characters.
  • No restrictions on starting or ending characters.

Used In:

SNMP Privacy Protocol

Parameter: privacyProtocol
Description: Specifies the encryption algorithm to be used. Must be exactly "AES".
Type: String
Required: Yes
Min Length: 3
Max Length: 3
Example: "AES"
Default: N/A
Allowed Value: AES
Regex: ^AES$
Disallowed Values: Any value other than "AES".
Special Constraints:

  • Must be exactly 3 characters: A, E, S.
  • Case-sensitive — only uppercase "AES" is allowed.

Used In:

SNMP Security Name

Parameter: securityName
Description: Specifies the name of the user.
Type: String
Required: Yes
Min Length: 1
Max Length: 31
Example: "myUser"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), Hyphen ('-')
Regex: ^[a-zA-Z0-9_-]*$
Disallowed Characters: Characters outside the allowed set.
Special Constraints:

  • Length must be between 1 and 31 characters.
  • No restrictions on starting or ending characters.

Used In:

SNMP Engine ID

Parameter: engineId
Description: Specifies the engine that receives notifications and that has the authority to control the flow of information.
Type: String
Required:

Min Length: 10
Max Length: 64
Example: "1234567890"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9)
Regex: ^[0-9a-fA-F]{10}$|^[0-9a-fA-F]{12}$|^[0-9a-fA-F]{14}$|^[0-9a-fA-F]{16}$
Disallowed Characters: Characters outside the allowed set.
Special Constraints:

  • Length must be between 10 and 64 characters.
  • No restrictions on starting or ending characters.

Used In:

Syslog Remote Host

Parameter: syslogRemoteHost
Description: Specifies the remote syslog host address with protocol and optional port. The format is <hostname>_<protocol>:<port>.
Type: String
Required: Yes
Min Length: Variable (depends on hostname and port).
Max Length: Variable.
Example: "host01_tcp:514"
Default: N/A
Allowed Characters:

  • Hostname: Alphanumeric (a-z, A-Z, 0-9), Hyphen (-), dot (.), square brackets ([, ]), underscore (_), and colon (:)
  • Protocols: tcp, udp, relp
  • Port: Optional port number consisting of 0 to 5 digits (0 to 65535 expected but not enforced by regex)

Regex: ^([a-zA-Z0-9-.[]_:]*)_(tcp|udp|relp):[0-9]{0,5}$
Disallowed Characters: Any characters outside the allowed hostname set and protocols; missing underscore or colon separators.
Special Constraints:

  • The hostname part can be empty or contain allowed characters.
  • The protocol must be exactly one of tcp, udp, or relp.
  • The port is optional but if present must be 0 to 5 digits.

Used In:

Syslog Severity Level

Parameter: severity
Description: Specifies the logging level. Allowed values include full and abbreviated forms.
Type: String
Required: Yes
Min Length: 3
Max Length: 9
Example: "error"
Default: N/A
Allowed Values: emergency, alert, critical, crit, error, err, warning, warn, notice, info, debug, all.
Regex: ^(emergency|alert|critical|crit|error|err|warning|warn|notice|info|debug|all)$
Disallowed Values: Any value outside the above list.
Special Constraints:

  • Value must exactly match one of the allowed log levels.
  • Length must be between 3 and 9 characters matching the chosen value.

Used In:

System Configuration Backup Description

Parameter: description
Description: A descriptive string for backup identification containing alphanumeric characters, select punctuation, and symbols.
Type: String
Required: Yes
Min Length: 1
Max Length: 128
Example: "Backup_2025-06-19 (Full) @ Server-01"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), dot (.), comma (,), colon (:), Curly braces ({, }), square brackets ([, ]), parentheses ((, )), At symbol (@), space ( ), and hyphen (-).
Regex: ^[a-zA-Z0-9_.,:\{\}\[\]\(\)@ -]{1,128}$
Disallowed Characters: Any characters outside the allowed set, including control characters and other special symbols.
Special Constraints:

  • Length must be between 1 and 128 characters.
  • No restrictions on starting or ending characters.

Used In:

System Configuration Backup Identifier

Parameter: backupid
Description: A string containing alphanumeric characters, underscores, dots, and hyphens.
Type: String
Required: Yes
Min Length: 1
Max Length: 128
Example: "example_file-name_01"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), dot (.), and hyphen (-)
Regex: ^[a-zA-Z0-9_.-]*$
Disallowed Characters: Spaces, special characters outside the allowed set, control characters.
Special Constraints:

  • Length must be between 1 and 128 characters.
  • Empty string is not allowed.

Used In:

System Configuration Backup Service

Parameter: service
Description: Specifies the name of a service. Must be one of the predefined service names listed below.
Type: String
Required: Yes
Min Length: 3
Max Length: 12
Example: "syslog"
Default: N/A
Allowed Values: network, ssh, ntls, syslog, ntp, snmp, users, system, webserver, ctc, all, cluster, ismigration.
Regex: ^(network|ssh|ntls|syslog|ntp|snmp|users|system|webserver|ctc|all|cluster|ismigration)$
Disallowed Values: Any value not exactly matching one of the above service names.
Special Constraints:

  • Value must be exactly one of the allowed service names.
  • Length must be between 3 and 12 characters matching the selected value.

Used In:

System Log Facility

Parameter: logfacility
Description: Specifies the log facility to use when generating the test message.
Type: String
Required: Yes
Min Length: 4
Max Length: 8
Example: "kern"
Default: N/A
Allowed Characters: Alphanumeric (a-z, A-Z, 0-9)
Regex: ^[a-zA-Z0-9]*$
Disallowed Characters: Characters outside the allowed set.
Special Constraints:

  • Length must be between 4 and 8 characters.
  • No restrictions on starting or ending characters.

Used In:

System Log Level

Parameter: logLevel
Description: Specifies the severity level to assign to the test message.
Type: String
Required: Yes
Min Length: 3
Max Length: 9
Example: "critical"
Default: N/A
Allowed Characters: Alphabets (a-z, A-Z)
Regex: ^[a-zA-Z]*$
Disallowed Characters: Characters outside the allowed set.
Special Constraints:

  • Length must be between 3 and 9 characters.
  • No restrictions on starting or ending characters.

Used In:

System Message

Parameter: message
Description: A string that specifies the body text for the test message.
Type: String
Required: Yes
Min Length: 1
Max Length: 128
Example: "hello"
Default: N/A
Regex: ‘^[a-zA-Z0-9_ $()*+./^[]{}!#%,:=’?-]*$`
Disallowed Characters: Characters outside the allowed set.
Special Constraints:

  • Length must be between 1 and 128 characters.
  • No restrictions on starting or ending characters.

Used In:

Webserver Cipher List

Parameter: cipherList
Description: A colon-separated list of cipher names. Each cipher must consist of alphanumeric characters, underscores (_), or hyphens (-). The list must include at least two ciphers and can contain up to 1025 entries.
Type: String
Required: Yes
Min Length: 1
Max Length: 1024
Example: "TLS_AES_128_GCM_SHA256:TLS_CHACHA20_POLY1305_SHA256"
Default: N/A
Allowed Characters per Cipher: Alphanumeric (a-z, A-Z, 0-9), Underscore (_), Hyphen (-), Separator: Colon (:).
Regex: ^([a-zA-Z0-9_-]+)(:[a-zA-Z0-9_-]+){1,1024}$
Disallowed Characters: Any character outside a-z, A-Z, 0-9, _, -, or :. Leading or trailing colons, empty segments, or duplicate separators (::) are invalid.
Special Constraints:

  • Must consist of at least two cipher names separated by colons.
  • Each cipher name must be non-empty and consist only of valid characters.

Used In:

Webserver Cors Origin

Parameter: corsOrigins
Description: Represents the origin (host and optional port) allowed for CORS requests. Must include a valid hostname (e.g., example.com) and may include an optional port (e.g., example.com:8080) or a literal '*'.
Type: String
Required: Yes
Min Length: 1
Max Length: 255
Min Items: 1
Max Items: 10
Example: "example.com:8080"
Default: N/A
Allowed Pattern:

  • Hostname part: alphanumeric and hyphens (a-z, A-Z, 0-9, -).
  • TLD: . followed by 2 to 6 alphabetic characters.
  • Optional port: : followed by 1 to 5 digits.
  • A literal *

Regex: ^(?:([A-Za-z0-9-]+)(.+[A-Za-z]{2,6})?(:[0-9]{1,5})?|*)$
Disallowed Characters: Spaces, special characters (like /, @, #, etc.), and invalid domain/port formats.
Special Constraints:

  • Must start with a hostname (e.g., example, api-server).
  • Must include a top-level domain (e.g., .com, .org).
  • Optional port must be preceded by a colon and consist of 1 to 5 digits.

Used In:

Webserver Service Net Device

Parameter: netDevice
Description: Name of the network interface. Must be one of the predefined values: all, all_ipv4, eth0–eth3, or bond0–bond1.
Type: String
Required: Yes
Min Length: 3
Max Length: 8
Example: "eth1"
Default: N/A
Allowed Values: all, all_ipv4, eth0, eth1, eth2, eth3, bond0, bond1
Regex: ^(?:all|all_ipv4|eth[0-3]|bond[0-1])$
Disallowed Values: Any string not exactly matching one of the allowed options; e.g., eth4, bond2, ALL, or eth01 are invalid.
Special Constraints:

  • Value must be exactly one of the specified fixed names.
  • Length must be between 3 and 8 characters.

Used In:

REST API for Luna Network HSMs " Reference Guide
007-013322-007 Rev. A Copyright 2026  Thales. All rights reserved.