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

import requests

url = "https://apix.spotzee.com/api/ext/generic/data/generate/system"

payload = {
    "count": "10",
    "locale": "en",
    "seed": "12345",
    "method": "profile",
    "extension": "txt",
    "mimeType": "application/json",
    "extensionCount": "1",
    "extensionCountMin": "1",
    "extensionCountMax": "2",
    "interfaceType": "en",
    "interfaceSchema": "pci",
    "includeYear": "false",
    "includeNonStandard": "false"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    count: '10',
    locale: 'en',
    seed: '12345',
    method: 'profile',
    extension: 'txt',
    mimeType: 'application/json',
    extensionCount: '1',
    extensionCountMin: '1',
    extensionCountMax: '2',
    interfaceType: 'en',
    interfaceSchema: 'pci',
    includeYear: 'false',
    includeNonStandard: 'false'
  })
};

fetch('https://apix.spotzee.com/api/ext/generic/data/generate/system', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.spotzee.com/api/ext/generic/data/generate/system"

	payload := strings.NewReader("count=10&locale=en&seed=12345&method=profile&extension=txt&mimeType=application%2Fjson&extensionCount=1&extensionCountMin=1&extensionCountMax=2&interfaceType=en&interfaceSchema=pci&includeYear=false&includeNonStandard=false")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "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"
  }
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

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

import requests

url = "https://apix.spotzee.com/api/ext/generic/data/generate/system"

payload = {
    "count": "10",
    "locale": "en",
    "seed": "12345",
    "method": "profile",
    "extension": "txt",
    "mimeType": "application/json",
    "extensionCount": "1",
    "extensionCountMin": "1",
    "extensionCountMax": "2",
    "interfaceType": "en",
    "interfaceSchema": "pci",
    "includeYear": "false",
    "includeNonStandard": "false"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    count: '10',
    locale: 'en',
    seed: '12345',
    method: 'profile',
    extension: 'txt',
    mimeType: 'application/json',
    extensionCount: '1',
    extensionCountMin: '1',
    extensionCountMax: '2',
    interfaceType: 'en',
    interfaceSchema: 'pci',
    includeYear: 'false',
    includeNonStandard: 'false'
  })
};

fetch('https://apix.spotzee.com/api/ext/generic/data/generate/system', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.spotzee.com/api/ext/generic/data/generate/system"

	payload := strings.NewReader("count=10&locale=en&seed=12345&method=profile&extension=txt&mimeType=application%2Fjson&extensionCount=1&extensionCountMin=1&extensionCountMax=2&interfaceType=en&interfaceSchema=pci&includeYear=false&includeNonStandard=false")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "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"
  }
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

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

Hide child attributes

data.systems

object[]

required

Hide child attributes

data.systems.method

enum<string>

required

Resolved system generation method.

Available options:

profile,

commonFileExt,

commonFileName,

commonFileType,

cron,

directoryPath,

fileExt,

fileName,

filePath,

fileType,

mimeType,

networkInterface,

semver

Example:

"profile"

data.systems.value

string

required

Primary generated system fixture value.

Example:

"sample_config.json"

data.systems.commonFileExt

string

Generated common file extension.

Example:

"json"

data.systems.commonFileName

string

Generated common file name.

Example:

"sample_config.txt"

data.systems.commonFileType

string

Generated common file type.

Example:

"text"

data.systems.cron

string

Generated cron expression.

Example:

"15 8 * * 1"

data.systems.directoryPath

string

Generated directory path fixture.

Example:

"/workspace/assets"

data.systems.fileExt

string

Generated file extension.

Example:

"json"

data.systems.fileName

string

Generated file name.

Example:

"sample_config.json"

data.systems.filePath

string

Generated file path fixture.

Example:

"/workspace/assets/sample_config.json"

data.systems.fileType

string

Generated file type.

Example:

"application"

data.systems.mimeType

string

Generated MIME type.

Example:

"application/json"

data.systems.networkInterface

string

Generated network-interface name.

Example:

"enp5s0f1d0"

data.systems.semver

string

Generated semantic version.

Example:

"1.15.2"

data.systems.extension

string

Resolved extension input.

Example:

"txt"

data.systems.mimeTypeInput

string

Resolved MIME type input.

Example:

"application/json"

data.systems.extensionCount

number

Resolved exact file-name extension count.

Example:

1

data.systems.extensionCountMin

number

Resolved minimum file-name extension count.

Example:

1

data.systems.extensionCountMax

number

Resolved maximum file-name extension count.

Example:

2

data.systems.interfaceType

enum<string>

Resolved network-interface type.

Available options:

en,

wl,

ww

Example:

"en"

data.systems.interfaceSchema

enum<string>

Resolved network-interface schema.

Available options:

index,

slot,

mac,

pci

Example:

"pci"

data.systems.includeYear

boolean

Resolved cron year inclusion flag.

Example:

false

data.systems.includeNonStandard

boolean

Resolved non-standard cron label flag.

Example:

false

data.generated

number

required

data.locale

string

required

data.method

enum<string>

required

Available options:

profile,

commonFileExt,

commonFileName,

commonFileType,

cron,

directoryPath,

fileExt,

fileName,

filePath,

fileType,

mimeType,

networkInterface,

semver

data.seed

number

performance

object

Hide child attributes

performance.generationTime

number

required

Generation time in milliseconds.

Example:

2

performance.itemsGenerated

number

required

Number of items generated.

Example:

10

performance.locale

string

required

Locale used for generation.

Example:

"en"

Overview

AI

Text

DNS

Email

SMS

Data

Generate synthetic system data

Authorizations

Body

Response