Skip to main content
POST
/
generic
/
data
/
generate
/
system
Generate synthetic system data
curl --request POST \
  --url https://apix.spotzee.com/api/ext/generic/data/generate/system \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data count=10 \
  --data locale=en \
  --data seed=12345 \
  --data method=profile \
  --data extension=txt \
  --data mimeType=application/json \
  --data extensionCount=1 \
  --data extensionCountMin=1 \
  --data extensionCountMax=2 \
  --data interfaceType=en \
  --data interfaceSchema=pci \
  --data includeYear=false \
  --data includeNonStandard=false
{
  "status": "success",
  "data": {
    "systems": [
      {
        "method": "profile",
        "value": "sample_config.json",
        "commonFileExt": "json",
        "commonFileName": "sample_config.txt",
        "commonFileType": "text",
        "cron": "15 8 * * 1",
        "directoryPath": "/workspace/assets",
        "fileExt": "json",
        "fileName": "sample_config.json",
        "filePath": "/workspace/assets/sample_config.json",
        "fileType": "application",
        "mimeType": "application/json",
        "networkInterface": "enp5s0f1d0",
        "semver": "1.15.2",
        "extension": "txt",
        "mimeTypeInput": "application/json",
        "extensionCount": 1,
        "interfaceType": "en",
        "interfaceSchema": "pci",
        "includeYear": false,
        "includeNonStandard": false
      }
    ],
    "generated": 1,
    "locale": "en",
    "seed": 12345,
    "method": "profile"
  },
  "performance": {
    "generationTime": 2,
    "itemsGenerated": 1,
    "locale": "en"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Use format: Bearer YOUR_API_KEY

Body

application/x-www-form-urlencoded
​
count
string

Number of system records to generate (1-100). Passed as string but must be numeric.

Pattern: ^[1-9]\d?$|^100$
Example:

"10"

​
locale
string

Locale for generated data (e.g., en, es, fr, de, pt_BR, zh_CN)

Example:

"en"

​
seed
string

Seed for deterministic generation. Same seed produces same results.

Example:

"12345"

​
method
enum<string>

System generation method. Defaults to profile.

Available options:
profile,
commonFileExt,
commonFileName,
commonFileType,
cron,
directoryPath,
fileExt,
fileName,
filePath,
fileType,
mimeType,
networkInterface,
semver
Example:

"profile"

​
extension
string

Optional file extension for commonFileName output. Do not include a leading dot.

Maximum string length: 16
Example:

"txt"

​
mimeType
string

Optional MIME type for fileExt output.

Maximum string length: 128
Example:

"application/json"

​
extensionCount
string

Exact generated extension count for fileName output. Defaults to 1 and is capped at 3.

Pattern: ^[1-9]\d*$
Example:

"1"

​
extensionCountMin
string

Minimum generated extension count for fileName output. Capped at 3.

Pattern: ^[1-9]\d*$
Example:

"1"

​
extensionCountMax
string

Maximum generated extension count for fileName output. Capped at 3.

Pattern: ^[1-9]\d*$
Example:

"2"

​
interfaceType
enum<string>

Optional network-interface type for networkInterface output.

Available options:
en,
wl,
ww
Example:

"en"

​
interfaceSchema
enum<string>

Optional network-interface schema for networkInterface output.

Available options:
index,
slot,
mac,
pci
Example:

"pci"

​
includeYear
enum<string>

Include a year field when method=cron or profile.

Available options:
true,
false
Example:

"false"

​
includeNonStandard
enum<string>

Allow non-standard cron labels when method=cron or profile.

Available options:
true,
false
Example:

"false"

Response

Successfully generated system data

​
status
enum<string>
required
Available options:
success
​
data
object
required
​
performance
object