Entity Schemas

Download JSON Schema (JSONSchema)

Dynamic Applications POST Request

https://example.invalid/schemas/dynamic-applications.schema.json

JSON Schema for POST /lce/api/dynamic_applications. Captures explicit field shapes and many implicit validation rules that are expressible in JSON Schema. Rules requiring DB lookups or cross-entity uniqueness across arrays are documented but not enforceable here.

oneOf

#/$defs/DynamicApplicationUpdateRequestItem

type

array

items

#/$defs/DynamicApplicationUpdateRequestItem

type

object

properties

  • dynamic_applications

Wrapped collection of Dynamic Applications to create or update.

type

array

items

#/$defs/DynamicApplicationUpdateRequestItem

additionalProperties

True

$defs

  • GUID

Uppercase 32-hex GUID. If present, entity is treated as existing (update semantics) and must exist in DB (DB existence not enforceable via JSON Schema).

type

string

pattern

^[A-F0-9]{32}$

  • Reference

Request-scoped identifier used to link newly-created entities within this request. Must be unique across the entire payload across ALL entity types (not enforceable in JSON Schema).

type

string

minLength

1

  • FlexibleBooleanToggle

Accepts boolean-like strings or 0/1. Case-insensitive behavior is not enforceable in JSON Schema; clients should use canonical values.

oneOf

type

integer

enum

0, 1

type

string

enum

FALSE, TRUE

  • FlexibleEnabledToggle

EnabledToggle (accepts integer or string).

oneOf

type

integer

enum

0, 1

type

string

enum

DISABLED, ENABLED

  • FlexibleRequiredToggle

Required toggle (accepts integer or string).

oneOf

type

integer

enum

0, 1

type

string

enum

NOT_REQUIRED, REQUIRED

  • ApplicationType

Only Snippet Framework types are accepted for this endpoint.

oneOf

type

integer

type

string

enum

SNIPPET_PERFORMANCE, SNIPPET_CONFIGURATION, BULK_SNIPPET_PERFORMANCE, BULK_SNIPPET_CONFIGURATION

  • CollectionObjectClassPerformance

type

string

enum

PERFORMANCE_COUNTER, PERFORMANCE_PERCENT, PERFORMANCE_KILOBYTE, PERFORMANCE_GAUGE, DISCOVERY, LABEL_HOURLY_POLLED, LABEL_ALWAYS_POLLED, INDEX, LABEL_IP_ALWAYS_POLLED

  • CollectionObjectClassConfig

type

string

enum

CONFIG_CHARACTER, CONFIG_ENUM, CONFIG_TIMETICKS, CONFIG_GAUGE, CONFIG_NUMERIC, CONFIG_TIMESTAMP, CONFIG_MAC_ADDRESS, CONFIG_IP_ADDRESS, CONFIG_DATETIME, DISCOVERY, LABEL_HOURLY_POLLED, LABEL_ALWAYS_POLLED, INDEX, INDEX_LABEL, LABEL_CONFIG_GROUP

  • CollectionObjectUsage

type

string

enum

STANDARD, GROUP_INDEX, IDENTITY_NAMESPACE, RELATIONSHIP_NAMESPACE, GUID_RELATIONSHIP, UNIQUE_IDENTIFIER_RELATIONSHIP, GUID_PLUS_INDEX, UNIQUE_IDENTIFIER_PLUS_INDEX

  • TableAlignment

type

string

enum

LEFT, CENTER, RIGHT

  • ConfigStringType

type

string

enum

STANDARD, HEX_UNICODE

  • AssetLink

AssetLink. For CONFIG apps the server restricts this to an allowed subset (captured in CollectionObject config-only rules below).

type

string

enum

NONE, MAKE, MODEL, SERIAL_NUMBER, OPERATING_SYSTEM, HOST_ID_SID, OS_SYSTEM_NAME, CPU_COUNT, CPU_TYPE_MAKE, CPU_SPEED, FIRMWARE_BIOS_NAME, INSTALLED_MEMORY, HARD_DISK_DRIVE, COMPONENT_TYPE, COMPONENT_MAKE, COMPONENT_MODEL, COMPONENT_SERIAL, COMPONENT_SLOT, COMPONENT_NOTES, COMPONENT_CONNECT, PROFILE_MEMO, ASSET_TAG, DISK_ARRAY_SIZE, DISK_COUNT, DISK_SIZE, METHOD, ANNUAL_RATE, RFID_NUMBER, MODEL_NUMBER

  • ComponentIdentifier

type

string

enum

UNKNOWN, UNIQUE_IDENTIFIER, DISTINGUISHED_NAME, CLASS_IDENTIFIER_1, CLASS_IDENTIFIER_2, DEVICE_NAME, MAC_ADDRESS, UUID, AVAILABILITY, GUID, ORGANIZATION, PREVIOUS_UNIQUE_IDS, IP_ADDRESS

  • DiscoveryAlignmentCondition

type

string

enum

IF_OID_PRESENT, IF_OID_NOT_PRESENT

  • DiscoveryOperator

type

string

enum

UNSET, IS_GREATER_THAN_RESULT, IS_EQUAL_TO_RESULT, IS_LESS_THAN_RESULT, IS_NOT_EQUAL_TO_RESULT, IS_LIKE, MATCHES_REGEX, NO_VALIDITY_CHECK

  • ThresholdType

type

string

enum

PERCENTAGE, INTEGER, DECIMAL

  • EventSeverity

oneOf

type

integer

enum

0, 1, 2, 3, 4

type

string

enum

HEALTHY, NOTICE, MINOR, MAJOR, CRITICAL

  • EventSource

oneOf

type

integer

enum

1, 2, 3, 4, 6, 7, 10, 12, 13, 14, 15

type

string

enum

SYSLOG, INTERNAL, TRAP, DYNAMIC, API, EMAIL, AGENT, RCR_ACCEPTED, RCR_SUGGESTION, RCR_CUSTOM, SKYLAR

  • EventTopologySuppression

oneOf

type

integer

enum

0, 1, 2, 3

type

string

enum

DISABLED, SUPPRESSING, SUPPRESSIBLE, BOTH

  • EventYType

oneOf

type

integer

enum

7

type

string

enum

INTERFACE, NONE

type

null

  • EventMatchLogic

oneOf

type

integer

enum

0, 1

type

string

enum

TEXT_SEARCH, REGEX_MATCH

  • EventComponentType

oneOf

type

integer

enum

0, 1, 2, 3, 4, 5, 7

type

string

enum

NOT_ANY, CPU, DISK, FILE_SYSTEM, MEMORY, SWAP, INTERFACE

  • EventTime

oneOf

type

integer

enum

0, 1, 2, 3, 5, 10, 15, 20, 25, 30, 45, 60, 90, 120, 150, 180, 210, 240, 270, 300, 330, 360, 420, 480, 540, 600, 660, 720, 780, 840, 900, 960, 1020, 1080, 1140, 1200, 1260, 1320, 1380, 1440, 2160, 2880

type

string

enum

DISABLED, ONE_MINUTE, TWO_MINUTES, THREE_MINUTES, FIVE_MINUTES, TEN_MINUTES, FIFTEEN_MINUTES, TWENTY_MINUTES, TWENTY_FIVE_MINUTES, THIRTY_MINUTES, FORTY_FIVE_MINUTES, ONE_HOUR, ONE_HOUR_THIRTY_MINUTES, TWO_HOURS, TWO_HOURS_THIRTY_MINUTES, THREE_HOURS, THREE_HOURS_THIRTY_MINUTES, FOUR_HOURS, FOUR_HOURS_THIRTY_MINUTES, FIVE_HOURS, FIVE_HOURS_THIRTY_MINUTES, SIX_HOURS, SEVEN_HOURS, EIGHT_HOURS, NINE_HOURS, TEN_HOURS, ELEVEN_HOURS, TWELVE_HOURS, THIRTEEN_HOURS, FOURTEEN_HOURS, FIFTEEN_HOURS, SIXTEEN_HOURS, SEVENTEEN_HOURS, EIGHTEEN_HOURS, NINETEEN_HOURS, TWENTY_HOURS, TWENTY_ONE_HOURS, TWENTY_TWO_HOURS, TWENTY_THREE_HOURS, ONE_DAY, ONE_DAY_TWELVE_HOURS, TWO_DAYS

  • EventSyslogFacility

oneOf

type

string

enum

kernel, user, mail, system, security, internal, printer, news, UUCP, clock, security2, FTP, NTP, audit, alert, clock2, local0, local1, local2, local3, local4, local5, local6, local7, KERNEL_MESSAGES, USER_LEVEL_MESSAGES, MAIL_SYSTEM, SYSTEM_DAEMONS, SECURITY_AUTHORIZATION_MESSAGES_1, INTERNAL_SYSLOGD_MESSAGES, LINE_PRINTER_SUBSYSTEM, NETWORK_NEWS_SUBSYSTEM, UUCP_SUBSYSTEM, CLOCK_DAEMON_1, SECURITY_AUTHORIZATION_MESSAGES_2, FTP_DAEMON, NTP_SUBSYSTEM, LOG_AUDIT, LOG_ALERT, CLOCK_DAEMON_2, LOCAL_USE_0, LOCAL_USE_1, LOCAL_USE_2, LOCAL_USE_3, LOCAL_USE_4, LOCAL_USE_5, LOCAL_USE_6, LOCAL_USE_7, MATCH_ANY

type

null

  • EventSyslogSeverity

oneOf

type

integer

enum

0, 1, 2, 3, 4, 5, 6, 7

type

string

enum

EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG, MATCH_ANY

type

null

  • Snippet

Defines a reusable script or code block for the Dynamic Application.

type

object

properties

  • guid

Unique identifier for this Snippet.

oneOf

#/$defs/GUID

type

null

  • reference

The reference label for this Snippet. Used to distinguish between different instances.

oneOf

#/$defs/Reference

type

null

  • name

Human-readable name for this Snippet.

type

string

maxLength

64

minLength

1

  • snippet

Python code or reusable script content for this Snippet.

type

string

  • state

#/$defs/FlexibleEnabledToggle

  • required

#/$defs/FlexibleRequiredToggle

  • id

Not accepted in POST; ignored by server if provided. This schema forbids it to prevent confusion.

not

additionalProperties

False

  • PresentationObject

Defines how to display a performance metric collected by the Dynamic Application.

type

object

properties

  • guid

A unique identifier for this Presentation Object.

oneOf

#/$defs/GUID

type

null

  • reference

The reference label for this Presentation Object. Used to distinguish between different instances.

oneOf

#/$defs/Reference

type

null

  • name

Human-readable name for this Presentation Object.

type

string

maxLength

42

minLength

1

  • guide_text

Description of what data this Presentation Object displays.

type

string

maxLength

2048

  • formula

Python expression to transform this Presentation Object’s value.

type

string

maxLength

512

default

()

  • show_as_percent

#/$defs/FlexibleBooleanToggle

  • summarization_state

#/$defs/FlexibleBooleanToggle

  • abbreviation_suffix

The abbreviation or suffix to use for this Presentation Object.

type

string

maxLength

16

  • data_unit

The units for the data this Presentation Object displays.

type

string

maxLength

25

  • id

not

additionalProperties

False

  • ThresholdObject

Defines threshold settings used for alerts generated by a Dynamic Application.

type

object

properties

  • guid

A unique identifier for this Threshold Object.

oneOf

#/$defs/GUID

type

null

  • reference

The reference label for this Threshold Object. Used to distinguish between different instances.

oneOf

#/$defs/Reference

type

null

  • name

Human-readable name for this Threshold Object.

type

string

maxLength

64

minLength

1

  • override_threshold_value

#/$defs/FlexibleBooleanToggle

  • numeric_range_high

Specifies the high end of the possible values.

type

number

minimum

0

  • numeric_range_low

Specifies the low end of the possible values.

type

number

minimum

0

  • type

#/$defs/ThresholdType

  • unit

The unit for the data this Threshold Object is defined around.

oneOf

type

string

maxLength

25

type

null

  • value

The default threshold value used if a subscriber device does not override it.

type

number

minimum

0

  • id

not

additionalProperties

False

  • AlertObject

Defines an alert owned by a Dynamic Application.

type

object

properties

  • guid

A unique identifier for this Alert Object.

oneOf

#/$defs/GUID

type

null

  • reference

The reference label for this Alert Object. Used to distinguish between different instances.

oneOf

#/$defs/Reference

type

null

  • state

#/$defs/FlexibleEnabledToggle

  • name

Human-readable name for this Alert Object.

type

string

maxLength

128

minLength

1

  • formula

Python expression to transform this Alert Object’s value.

type

string

maxLength

512

minLength

1

  • log_message

The message to appear in logs when this Alert Object is triggered.

type

string

maxLength

128

minLength

1

  • maintain_state

#/$defs/FlexibleEnabledToggle

  • triggered_alert_id

ID of the Alert Object to trigger when this Alert Object is triggered.

type

integer

minimum

0

default

0

  • triggered_alert_reference

The reference label for identifying which Alert Object to trigger when it has not yet been created and only has a reference.

oneOf

#/$defs/Reference

type

null

  • id

not

additionalProperties

False

  • EventPolicy

Event policy owned by or linked to a Dynamic Application. Field legality depends on event source. Some rules are documented here but remain server-enforced.

type

object

properties

  • guid

A unique identifier for this Event Policy.

oneOf

#/$defs/GUID

type

null

  • reference

The reference label for this Event Policy. Used to distinguish between different instances.

oneOf

#/$defs/Reference

type

null

  • pp_guid

The unique GUID identifier of the PowerPack this Event Policy is aligned to.

oneOf

#/$defs/GUID

type

null

  • app_guid

A unique identifier for the Dynamic Application linked to this Event Policy. Only relevant for DYNAMIC event sources.

oneOf

#/$defs/GUID

type

null

  • app_id

The unique numeric identifier for the Dynamic Application linked to this Event Policy. Only relevant for DYNAMIC event sources.

type

integer

minimum

0

  • source

#/$defs/EventSource

  • state

#/$defs/FlexibleEnabledToggle

  • severity

#/$defs/EventSeverity

  • use_severity_modifier

#/$defs/FlexibleBooleanToggle

  • name

The name of this Event Policy.

type

string

maxLength

128

minLength

1

  • message

The message that appears in the Event Console or Viewing Events page when this event occurs.

type

string

maxLength

255

minLength

1

  • description

The description of this Event Policy.

type

string

  • occurrence_count

The number of identical event instances that must occur before Skylar One creates a new event message. A value of 0 means disabled.

type

integer

maximum

1000

minimum

0

  • occurrence_time

#/$defs/EventTime

  • expiry_delay

#/$defs/EventTime

  • detection_weight

Validation order weight used when two event definitions are very similar.

type

integer

maximum

20

minimum

0

  • syslog_facility

#/$defs/EventSyslogFacility

  • syslog_severity

#/$defs/EventSyslogSeverity

  • syslog_application_name

Specifies what the application name field of an incoming syslog message must match for this event to trigger.

oneOf

type

string

maxLength

48

type

null

  • syslog_process_id

Specifies what the process id field of an incoming syslog message must match for this event to trigger.

oneOf

type

string

maxLength

128

type

null

  • syslog_message_id

Specifies what the message id field of an incoming syslog message must match for this event to trigger.

oneOf

type

string

maxLength

32

type

null

  • source_host_oid

Specifies an OID included in the trap that contains the IP address of the device that originally sent the trap message.

oneOf

type

string

maxLength

255

type

null

  • trap_oid

Trap OID to associate with this Event Policy.

oneOf

type

string

maxLength

255

type

null

  • link_id

For INTERNAL events, associates the message with the specified id. For DYNAMIC events, associates the alert with the specified id. For AGENT events, associates the log policy with the specified id.

type

integer

minimum

0

default

0

  • link_reference

The reference to an Alert Object inside the same Dynamic Application when creating a new Alert Object in the same context. Otherwise, it is not used.

oneOf

#/$defs/Reference

type

null

  • component_type

#/$defs/EventComponentType

  • external_event_id

Optional external event identifier used when correlating with another system.

oneOf

type

integer

type

null

  • external_category

Optional category used when sending this event to an external system.

type

string

maxLength

255

  • topology_suppression

#/$defs/EventTopologySuppression

  • match_logic

#/$defs/EventMatchLogic

  • use_multi_match

#/$defs/FlexibleBooleanToggle

  • use_message_match

#/$defs/FlexibleBooleanToggle

  • first_match_string

Correlates this event with a log message. Required for Syslog, API, and Email events.

type

string

maxLength

512

  • second_match_string

A secondary string used to match against the originating log message.

type

string

maxLength

512

  • identifier_pattern

A regular expression used to extract the specific sub-entity associated with this event.

type

string

maxLength

512

  • override_identifier_type

#/$defs/EventYType

  • identifier_format

If identifier_pattern returns multiple results, this field specifies which results to use and in which order.

type

string

maxLength

128

  • auto_clear_events

Specifies the events that will be cleared when this event becomes active.

type

array

default

items

type

string

  • id

not

additionalProperties

False

allOf

If occurrence_count is set (>0), occurrence_time must also be set (not DISABLED), and vice versa.

if

properties

  • occurrence_count

type

integer

exclusiveMinimum

0

then

properties

  • occurrence_time

not

anyOf

const

0

const

DISABLED

If occurrence_time is set (not DISABLED), occurrence_count must also be set (>0).

if

properties

  • occurrence_time

not

anyOf

const

0

const

DISABLED

then

properties

  • occurrence_count

type

integer

exclusiveMinimum

0

Source-specific field validation. JSON Schema can approximate legal combinations, but some source-dependent rules remain server-enforced.

if

properties

  • source

anyOf

const

SYSLOG

const

1

then

properties

  • syslog_facility

#/$defs/EventSyslogFacility

  • syslog_severity

#/$defs/EventSyslogSeverity

  • syslog_application_name

oneOf

type

string

maxLength

48

type

null

  • syslog_process_id

oneOf

type

string

maxLength

128

type

null

  • syslog_message_id

oneOf

type

string

maxLength

32

type

null

  • first_match_string

type

string

maxLength

512

minLength

1

if

properties

  • source

anyOf

const

DYNAMIC

const

4

then

anyOf

properties

  • link_id

type

integer

exclusiveMinimum

0

properties

  • link_reference

#/$defs/Reference

if

properties

  • source

anyOf

const

INTERNAL

const

2

then

properties

  • link_id

type

integer

exclusiveMinimum

0

if

properties

  • source

anyOf

const

API

const

6

const

EMAIL

const

7

then

properties

  • first_match_string

type

string

maxLength

512

minLength

1

  • CollectionObjectBase

Collection object. Field legality depends on app type and class_type.

type

object

properties

  • guid

A unique identifier for this Collection Object.

oneOf

#/$defs/GUID

type

null

  • reference

The reference label for this Collection Object. Used to distinguish between different instances.

oneOf

#/$defs/Reference

type

null

  • name

Human-readable name for the data point.

type

string

maxLength

64

minLength

1

  • class_type

Validated against allowed values depending on app type. If omitted, server defaults based on app type (PERFORMANCE_COUNTER vs CONFIG_CHARACTER).

oneOf

type

string

type

integer

  • snippet_id

ID of the associated Snippet. A value of 0 means default / unset. Server may assign fallback snippet.

type

integer

minimum

0

default

0

  • snippet_reference

The reference label for identifying which Snippet to link to when one has not been created yet.

oneOf

#/$defs/Reference

type

null

  • snippet_argument

Snippet Framework arguments for collection.

type

string

  • id

not

additionalProperties

True

  • CollectionObjectDiscoveryExtras

type

object

properties

  • class_type

const

DISCOVERY

  • tabular

#/$defs/FlexibleEnabledToggle

  • alignment_condition

#/$defs/DiscoveryAlignmentCondition

  • validity_check_pattern

The pattern to use in the Discovery validity check.

type

string

maxLength

128

  • validity_check_operator

#/$defs/DiscoveryOperator

allOf

if

properties

  • alignment_condition

const

IF_OID_PRESENT

else

not

  • CollectionObjectEnumExtras

type

object

properties

  • class_type

const

CONFIG_ENUM

  • string_type

#/$defs/ConfigStringType

  • group

Numerical group for related objects.

type

integer

maximum

50

minimum

0

  • usage_type

#/$defs/CollectionObjectUsage

  • change_alerting

#/$defs/FlexibleEnabledToggle

  • table_alignment

#/$defs/TableAlignment

  • hide_object

#/$defs/FlexibleBooleanToggle

  • disable_maintenance

#/$defs/FlexibleBooleanToggle

  • description

Description of what data this object gathers.

type

string

  • enum_values

The enum values to use if this Collection Object is CONFIG_ENUM type.

type

string

  • formula

Python expression to transform collected value.

type

string

maxLength

512

  • CollectionObjectConfigExtras

type

object

properties

  • string_type

#/$defs/ConfigStringType

  • group

Numerical group for related objects.

type

integer

maximum

50

minimum

0

  • usage_type

#/$defs/CollectionObjectUsage

  • asset_link

Config-only. Server restricts to an allowed subset for config apps; schema enforces that subset here.

type

string

enum

NONE, MAKE, MODEL, SERIAL_NUMBER, OPERATING_SYSTEM, HOST_ID_SID, OS_SYSTEM_NAME, CPU_COUNT, CPU_TYPE_MAKE, CPU_SPEED, FIRMWARE_BIOS_NAME, INSTALLED_MEMORY, ASSET_TAG, DISK_ARRAY_SIZE, DISK_COUNT, DISK_SIZE, MODEL_NUMBER

  • asset_link_precedence

The asset link precedence value to use for this Collection Object. Must be increments of 10.

type

integer

multipleOf

10

maximum

100

minimum

0

  • change_alerting

#/$defs/FlexibleEnabledToggle

  • table_alignment

#/$defs/TableAlignment

  • hide_object

#/$defs/FlexibleBooleanToggle

  • disable_maintenance

#/$defs/FlexibleBooleanToggle

  • description

Description of what data this object gathers.

type

string

  • component_identifiers

Only allowed when parent dynamic_app.component_mapping is ENABLED (enforced at higher level). Also must be globally unique across collection_objects (not enforceable in JSON Schema).

type

array

items

#/$defs/ComponentIdentifier

uniqueItems

True

  • formula

Python expression to transform collected value.

type

string

maxLength

512

  • CollectionObjectPerformanceExtras

type

object

properties

  • group

Numerical group for related objects.

type

integer

maximum

50

minimum

0

  • usage_type

#/$defs/CollectionObjectUsage

  • enable_deviation_alerting

#/$defs/FlexibleBooleanToggle

  • min_weeks_data

The minimum number of weeks to store data for this Collection Object.

type

integer

minimum

0

  • max_weeks_data

The maximum number of weeks to store data for this Collection Object.

type

integer

minimum

0

  • disable_maintenance

#/$defs/FlexibleBooleanToggle

  • CollectionObjectConfigAllowed

allOf

#/$defs/CollectionObjectBase

properties

  • class_type

oneOf

#/$defs/CollectionObjectClassConfig

type

integer

if

properties

  • class_type

const

DISCOVERY

then

allOf

#/$defs/CollectionObjectDiscoveryExtras

else

if

properties

  • class_type

const

CONFIG_ENUM

then

allOf

#/$defs/CollectionObjectConfigExtras

#/$defs/CollectionObjectEnumExtras

else

allOf

#/$defs/CollectionObjectConfigExtras

  • CollectionObjectPerformanceAllowed

allOf

#/$defs/CollectionObjectBase

properties

  • class_type

oneOf

#/$defs/CollectionObjectClassPerformance

type

integer

if

properties

  • class_type

const

DISCOVERY

then

allOf

#/$defs/CollectionObjectDiscoveryExtras

else

allOf

#/$defs/CollectionObjectPerformanceExtras

  • DynamicAppBase

Dynamic Application base model. Many server behaviors (defaults, rewrites, DB checks) are documented in field descriptions but cannot be enforced here.

type

object

properties

  • guid

Unique GUID identifier for this Dynamic Application. Required for update; omit or null for create.

oneOf

#/$defs/GUID

type

null

  • reference

Request-scoped unique label for linking new entities.

oneOf

#/$defs/Reference

type

null

  • name

The human-readable name of this Dynamic Application. Required on create. Optional on update.

type

string

maxLength

64

minLength

1

  • type

#/$defs/ApplicationType

  • pp_guid

The unique GUID identifier of the PowerPack this Dynamic Application is aligned to (immutable).

oneOf

#/$defs/GUID

type

null

  • is_sf_app_type

#/$defs/FlexibleBooleanToggle

  • abandon_collection_limit

This is how many collection objects must be unavailable before the Dynamic Application should stop trying to collect data and wait until the next scheduled collection session.

oneOf

type

integer

minimum

0

type

null

  • max_devices

The maximum amount of devices that can be grouped together to execute in a single process without causing collection issues.

type

integer

minimum

1

  • version

The version number of this Dynamic Application.

type

number

minimum

0.1

  • state

#/$defs/FlexibleEnabledToggle

  • poll_interval

The frequency at which Skylar One will poll all devices that use this Dynamic Application.

oneOf

type

integer

type

string

  • cu_affinity

Specifies which collectors are allowed to run collection jobs for this Dynamic Application.

oneOf

type

integer

type

string

enum

DEFAULT, ROOT_DEVICE, ASSIGNED_COLLECTOR

  • execution_environment

The unique GUID identifier of the Execution Environment aligned to this Dynamic Application. Can be an Execution environment GUID or sl1_default_ee.

type

string

  • component_mapping

#/$defs/FlexibleEnabledToggle

  • component_mapping_dynamic_applications

List of Dynamic Applications that are aligned by the current Dynamic Application.

type

array

default

items

oneOf

#/$defs/GUID

#/$defs/Reference

  • description

Detailed description of purpose for this Dynamic Application.

type

string

  • disable_rollup_of_data

#/$defs/FlexibleBooleanToggle

  • release_notes

Release notes, changelog and version history for this Dynamic Application.

type

string

  • null_row_option

Specifies what Skylar One will display for the row in the Configuration Report page if this Dynamic Application does not collect any values for a row in a table of configuration data that previously returned data.

oneOf

type

integer

type

string

  • null_column_option

Specifies what Skylar One will display in the table cell in the Configuration Report page if this Dynamic Application does not collect any values for a table cell in a table of configuration data that previously returned data.

oneOf

type

integer

type

string

  • snippets

Reusable Python script blocks that handle collection and custom steps.

type

array

default

items

#/$defs/Snippet

  • collection_objects

Data points to collect.

type

array

default

items

  • presentation_objects

Presentation objects.

type

array

default

items

#/$defs/PresentationObject

  • threshold_objects

Threshold objects.

type

array

default

items

#/$defs/ThresholdObject

  • alert_objects

Alert objects.

type

array

default

items

#/$defs/AlertObject

  • event_policies

Event policies.

type

array

default

items

#/$defs/EventPolicy

  • id

not

  • DynamicApplicationUpdateRequestItem

allOf

#/$defs/DynamicAppBase

if

properties

  • type

anyOf

const

SNIPPET_PERFORMANCE

const

BULK_SNIPPET_PERFORMANCE

then

properties

  • collection_objects

type

array

items

#/$defs/CollectionObjectPerformanceAllowed

else

properties

  • collection_objects

type

array

items

#/$defs/CollectionObjectConfigAllowed

component_identifiers field legality based on component_mapping. When component_mapping is DISABLED, any appearance of component_identifiers is invalid (even empty list).

if

properties

  • component_mapping

anyOf

const

DISABLED

const

0

then

properties

  • collection_objects

type

array

items

not

Presentation objects only meaningful for performance apps; server ignores/rejects for config apps depending on implementation. Schema forbids presentation_objects when app is config type to match documented behavior.

if

properties

  • type

anyOf

const

SNIPPET_CONFIGURATION

const

BULK_SNIPPET_CONFIGURATION

then

not