API Data Types

Application

Fields:

Name Type Required? Description
_id String Yes -
userId String No -
hashId String No -
metadata JSON No -
settings JSON No -
parameters JSON No -
applicationTypes ApplicationTypes No -
languageSpecifications LanguageSpecifications No -
sourceMaps JSON No -
useRecommendedOrder Boolean No -
debugMode Boolean No -
tolerateMinification Boolean No -
name String No -
createdAt String No -
isLocked Boolean No -
isPlayground Boolean No -
version String No -
completedDemo Boolean No -
protections [ApplicationProtection] No -
sources [ApplicationSource] No -
displayGrowthWarning Boolean No -
selectedTemplate JSON No -
useProfilingData Boolean No -
profilingDataMode String No -
useAppClassification Boolean No -
sourcesCount Int No -
classificationStatus String No -
classificationReport JSON No -
browsers JSON No -

ApplicationTypes

Fields:

Name Type Required? Description
webBrowserApp Boolean No -
desktopApp Boolean No -
serverApp Boolean No -
hybridMobileApp Boolean No -
javascriptNativeApp Boolean No -
html5GameApp Boolean No -

LanguageSpecifications

Fields:

Name Type Required? Description
es5 Boolean No -
es6 Boolean No -
es7 Boolean No -
es8 Boolean No -

ApplicationProtection

Fields:

Name Type Required? Description
_id String Yes -
isPurged Boolean No -
applicationId String No -
userId String No -
version String No -
state String No -
startedAt String No -
finishedAt String No -
hasForcedDateLock Boolean No Protection has forced expiration date
parameters JSON No -
sources [ApplicationSource] No -
bundle String No -
errorMessage String No Protection error message
errorCode String No Protection error code, mapped to code-errors
result String No -
sourceMapResult String No -
outputSymbolTable String No -
sourceMaps String No Application source maps option.
randomizationSeed String No -
useRecommendedOrder Boolean No -
bail Boolean No -
cancel Boolean No -
deprecations [Deprecation] No -
size Int No -
transformedSize Int No -
growthWarning Boolean No Indicates if the protection surpassed a reasonable growth
rtNotificationServiceSenderToken String No -
rtNotificationServiceSenderTokenId String No -
profilingRunId String No -
classificationReport String No -
browsers JSON No -
profilingDataMode String No -
inputSymbolTable String No -

ApplicationSource

Fields:

Name Type Required? Description
_id String Yes -
extension String No -
filename String No -
size Int No -
transformedSize Int No -
content String No -
transformedContent String No -
isSource Boolean No -
errorMessages [ErrorMessages] No -
metrics [FileMetrics] No -
metadataStatus String No -
metadata JSON No -
updatedAt String No -

ErrorMessages

Fields:

Name Type Required? Description
message String No -
code Int No -
fatal Boolean No -
column Int No -
line Int No -

FileMetrics

Fields:

Name Type Required? Description
transformation String No -
size Int No -
growth Float No -
nodes Int No -

Deprecation

Fields:

Name Type Required? Description
type String No -
entity String No -

Count

Fields:

Name Type Required? Description
count Int No -

Template

Fields:

Name Type Required? Description
_id String Yes -
name String No -
description String No -
createdAt String No -
parameters JSON No -
isDefault Boolean No -
isPerformance Boolean No -
userId ID No -
annotation String No -

VmSetting

Fields:

Name Type Required? Description
name String No -
value String No -

ApplicationSourceCreate

Fields:

Name Type Required? Description
extension String No Source file extension.
filename String Yes Source file name.
content String No Source file content.

ApplicationCreate

Fields:

Name Type Required? Description
applicationTypes ApplicationTypesInput No Application types.
languageSpecifications LanguageSpecificationsInput No Application language specifications.
parameters [TransformationInput] No Application parameters.
areSubscribersOrdered Boolean No Flag to indicate if application parameters are ordered.
sourceMaps JSON No Application source maps option.
useRecommendedOrder Boolean No Flag to indicate if application uses recommended order or not
debugMode Boolean No Flag to indicate if application is in debug mode or not
displayGrowthWarning Boolean No Flag to indicate if protection file size growth warnings should be shown
tolerateMinification Boolean No Flag to indicate whether or not output code should ignore modifications caused by minification
codeHardeningThreshold Int No Code hardening threshold field in bytes, which prevents files with lower file size to be targeted by Code Hardening
useProfilingData Boolean No Flag to indicate whether or not to use data from the latest profiling run.
profilingDataMode String No Indicates the profiling data mode of the application (off/automatic/annotation)
useAppClassification Boolean No Flag to indicate whether or not Application Classification metadata should be used when creating a new protection.
browsers JSON No Browser minimum compatibility parameters.
name String Yes Application name.

ApplicationTypesInput

Fields:

Name Type Required? Description
webBrowserApp Boolean No Web Browser Application type.
desktopApp Boolean No Desktop Application type.
serverApp Boolean No Server Application type.
hybridMobileApp Boolean No Hybrid Mobile Application type.
javascriptNativeApp Boolean No JavaScript Native Application type.
html5GameApp Boolean No HTML5 Game Application type.

LanguageSpecificationsInput

Fields:

Name Type Required? Description
es5 Boolean No EcmaScript5 language specification.
es6 Boolean No EcmaScript6 language specification.
es7 Boolean No EcmaScript7 language specification.
es8 Boolean No EcmaScript8 language specification.

TransformationInput

Fields:

Name Type Required? Description
name TransformationName Yes -
options JSON No -
status Int No -

TransformationName

ApplicationProtectionCreate

Fields:

Name Type Required? Description
templateId String No Template unique identifier. If provided, the application transformations will be replaced.
randomizationSeed String No Randomization seed to be used (explicitly) for this transformation.
bail Boolean No Whether or not to cancel protection if a parsisng error occurs
source ApplicationSourceCreate No Application source raw data.
inputSymbolTable String No The input symbol table to use
applicationTypes ApplicationTypesInput No Application types.
languageSpecifications LanguageSpecificationsInput No Application language specifications.
parameters [TransformationInput] No Application parameters.
areSubscribersOrdered Boolean No Flag to indicate if application parameters are ordered.
sourceMaps JSON No Application source maps option.
useRecommendedOrder Boolean No Flag to indicate if application uses recommended order or not
debugMode Boolean No Flag to indicate if application is in debug mode or not
displayGrowthWarning Boolean No Flag to indicate if protection file size growth warnings should be shown
tolerateMinification Boolean No Flag to indicate whether or not output code should ignore modifications caused by minification
codeHardeningThreshold Int No Code hardening threshold field in bytes, which prevents files with lower file size to be targeted by Code Hardening
useProfilingData Boolean No Flag to indicate whether or not to use data from the latest profiling run.
profilingDataMode String No Indicates the profiling data mode of the application (off/automatic/annotation)
useAppClassification Boolean No Flag to indicate whether or not Application Classification metadata should be used when creating a new protection.
browsers JSON No Browser minimum compatibility parameters.

TemplateInput

Fields:

Name Type Required? Description
name String No Template name.
description String No Template description.
parameters JSON No Template specific parameters.

ApplicationUpdate

Fields:

Name Type Required? Description
applicationTypes ApplicationTypesInput No Application types.
languageSpecifications LanguageSpecificationsInput No Application language specifications.
parameters [TransformationInput] No Application parameters.
areSubscribersOrdered Boolean No Flag to indicate if application parameters are ordered.
sourceMaps JSON No Application source maps option.
useRecommendedOrder Boolean No Flag to indicate if application uses recommended order or not
debugMode Boolean No Flag to indicate if application is in debug mode or not
displayGrowthWarning Boolean No Flag to indicate if protection file size growth warnings should be shown
tolerateMinification Boolean No Flag to indicate whether or not output code should ignore modifications caused by minification
codeHardeningThreshold Int No Code hardening threshold field in bytes, which prevents files with lower file size to be targeted by Code Hardening
useProfilingData Boolean No Flag to indicate whether or not to use data from the latest profiling run.
profilingDataMode String No Indicates the profiling data mode of the application (off/automatic/annotation)
useAppClassification Boolean No Flag to indicate whether or not Application Classification metadata should be used when creating a new protection.
browsers JSON No Browser minimum compatibility parameters.
name String No Application name.
completedDemo Boolean No Demo status for this application

ApplicationSourceUpdate

Fields:

Name Type Required? Description
extension String No Source file extension.
filename String No Source file name.
content String No Source file content.