Skip to main content

ConfigImportGroup

categorystringrequired

Possible values: [shares, accounts, schedules, notifications, backup, system, custom_config, templates, stacks]

added object[]required

In the archive, not in the live configuration.

  • Array [
  • kindstringrequired

    Possible values: [share, share_user_permission, share_group_permission, user, user_group, user_group_member, api_token, schedule_chain, schedule_job, notification_channel, notification_route, notification_severity, notification_quiet_hours, backup_destination, appdata_backup_container, backup_recipient, acme, ups, array_settings, host_config, external_disk, hostname, timezone, backup_passphrase, update_channel, update_check, custom_config_file, template_file, stack_file]

    namestringrequired

    What a user calls it: a share name, a username, a schedule job, a destination name; share / user for a permission, group / user for a membership, user / token name for an API token, event / channel for a route, the label of an external disk, the kind of a host configuration decision, the path of a custom config file or template relative to its directory, stack/file for a stack's compose or meta.json file. Empty for the settings that exist once. A secret or a passphrase is reported as changed, never by its value.

  • ]
  • changed object[]required

    In both, with different content.

  • Array [
  • kindstringrequired

    Possible values: [share, share_user_permission, share_group_permission, user, user_group, user_group_member, api_token, schedule_chain, schedule_job, notification_channel, notification_route, notification_severity, notification_quiet_hours, backup_destination, appdata_backup_container, backup_recipient, acme, ups, array_settings, host_config, external_disk, hostname, timezone, backup_passphrase, update_channel, update_check, custom_config_file, template_file, stack_file]

    namestringrequired

    What a user calls it: a share name, a username, a schedule job, a destination name; share / user for a permission, group / user for a membership, user / token name for an API token, event / channel for a route, the label of an external disk, the kind of a host configuration decision, the path of a custom config file or template relative to its directory, stack/file for a stack's compose or meta.json file. Empty for the settings that exist once. A secret or a passphrase is reported as changed, never by its value.

  • ]
  • removed object[]required

    In the live configuration, not in the archive.

  • Array [
  • kindstringrequired

    Possible values: [share, share_user_permission, share_group_permission, user, user_group, user_group_member, api_token, schedule_chain, schedule_job, notification_channel, notification_route, notification_severity, notification_quiet_hours, backup_destination, appdata_backup_container, backup_recipient, acme, ups, array_settings, host_config, external_disk, hostname, timezone, backup_passphrase, update_channel, update_check, custom_config_file, template_file, stack_file]

    namestringrequired

    What a user calls it: a share name, a username, a schedule job, a destination name; share / user for a permission, group / user for a membership, user / token name for an API token, event / channel for a route, the label of an external disk, the kind of a host configuration decision, the path of a custom config file or template relative to its directory, stack/file for a stack's compose or meta.json file. Empty for the settings that exist once. A secret or a passphrase is reported as changed, never by its value.

  • ]
  • ConfigImportGroup
    {
    "category": "shares",
    "added": [
    {
    "kind": "share",
    "name": "string"
    }
    ],
    "changed": [
    {
    "kind": "share",
    "name": "string"
    }
    ],
    "removed": [
    {
    "kind": "share",
    "name": "string"
    }
    ]
    }