Skip to main content
Version: 8.1

resource.json File

Each Ignition project resource contains a resource.json file within the resource folder. The resource.json file is comprised of both user and calculated metadata. It also contains a manifest of other resource data files that compose the actual resource’s data to the rest of Ignition. In addition to improving conflict resolution and version tracking, the resource.json file can be used to audit modifications that may happen directly on the file system, outside of Ignition. The following table describes the objects listed in the resource.json file.

ScopeIdentifies where a resource is used:
  • G: Gateway
  • C: Client
  • A: All
VersionDefines the type of resource and how to parse data internally. For example, named queries in version: 2 makes data available as listed attributes when they are not in version: 1.
RestrictedIf true, only users assigned proper role requirements will have access.
OverrideableIf true, the ability to override the inherited resource is enabled. This object does not apply in child projects.
FilesDisplays the location resource data is stored, most commonly data.bin or config.json.
AttributesContains resource property values. Two attributes are stored automatically, lastModification and lastModificationSignature. Modification updates are useful for audit purposes and determining if updates were made internally or otherwise. Other desired attributes can be added by users.

Note, the project.json file functions similarly to store fundamental data and is included all projects. The project.json file displays the project's title, parent project name (if applicable), project description, inheritable status, and if the project is enabled on the Gateway.