ESET PROTECT On-Prem

Hors ligne | Aller en ligne

ESET PROTECT On-Prem – Table des matières

# Create task

Copier l'URL de l'article actuel Envoyer par courriel

Relative path: /v1/device_tasks

Create a [device task].

There is one [device task template] for every unique `display_name`, description, and `action` combination.
This template inherits `display_name`, `description` and `action` from the `task` in the request.

The created task requires to have at least one trigger set. Otherwise, the call fails.

### Request body

Display Schema instead of an Example or vice-versa

Type | Required | Example | Schema
--- | --- | --- | ---
application/json | Yes |
    {
      "task": {
        "action": {
          "name": "string",
          "params": {
            "@type": "string",
            "additionalProp1": {},
            "additionalProp2": {},
            "additionalProp3": {}
          }
        },
        "assetGroupUuid": "string",
        "description": "string",
        "displayName": "string",
        "source": "DEVICE_TASK_SOURCE_UNSPECIFIED",
        "targets": {
          "deviceGroupsUuids": [
            "string"
          ],
          "devicesUuids": [
            "string"
          ]
        },
        "triggers": [
          {
            "manual": {
              "expireTime": "string"
            }
          }
        ],
        "uuid": "string",
        "createTime": "string",
        "versionId": "string",
        "updateTime": "string"
      }
    }
    {
      "$ref": "v1CreateTaskRequest",
      "task": {
        "$ref": "v1DeviceTask",
        "description": {
          "type": "string",
          "description": "User's description. Free text."
        },
        "action": {
          "$ref": "v1Action",
          "description": "Descriptor of the call to make.",
          "name": {
            "type": "string",
            "description": "Name of the function to execute. GRPC/ERPC function names in the form of package.ServiceName/RpcName For example: - eset.dotnod.scan_management.v1.ScanManager/CreateScan - eset.dotnod.power_management.v1.PowerManager/RegisterAction - eset.dotnod.network_access_protection.v1.NetworkAccessProtection/StartNetworkIsolation Actions outside .NOD are available as documented at ESET Connect Online Help."
          },
          "params": {
            "$ref": "protobufAny",
            "description": "Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example 'foo.bar.com/x/y.z' will yield type name 'y.z'. JSON The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { '@type': 'type.googleapis.com/google.profile.Person', 'firstName': <string>, 'lastName': <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): { '@type': 'type.googleapis.com/google.protobuf.Duration', 'value': '1.212s' }",
            "@type": {
              "type": "string",
              "description": "A URL/resource name whose content describes the type of the serialized protocol buffer message. For URLs which use the scheme http, https, or no scheme, the following restrictions and interpretations apply: If no scheme is provided, https is assumed. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading '.' is not accepted). An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics."
            },
            "additionalProperties": {
              "type": "object"
            }
          }
        },
        "assetGroupUuid": {
          "type": "string",
          "description": "Specifies in which asset group the task should be created. If empty or null, the asset group will be assigned automatically. type: asset_management.v1.Group"
        },
        "displayName": {
          "type": "string",
          "description": "User-friendly name of the task."
        },
        "source": {
          "$ref": "v1DeviceTaskSource",
          "type": "string",
          "description": "Possible sources of a task. DEVICE_TASK_SOURCE_UNSPECIFIED: fallback DEVICE_TASK_SOURCE_INTERNAL_AUTOMATION: The task was created by automation internal to the tenant. For example, some internal rule system. DEVICE_TASK_SOURCE_EXTERNAL_AUTOMATION: The task was created by automation external to the tenant/company. For example, a rule system of a company hired to provide managed detection and response services. DEVICE_TASK_SOURCE_INTERNAL_USER: The task was created by the user from within the tenant/company. For example, an internal security officer. DEVICE_TASK_SOURCE_EXTERNAL_USER: The task was created by the user external to the tenant/company. For example, a security manager of a company hired to provide managed detection and response services.",
          "enum": [
            "DEVICE_TASK_SOURCE_UNSPECIFIED",
            "DEVICE_TASK_SOURCE_INTERNAL_AUTOMATION",
            "DEVICE_TASK_SOURCE_EXTERNAL_AUTOMATION",
            "DEVICE_TASK_SOURCE_INTERNAL_USER",
            "DEVICE_TASK_SOURCE_EXTERNAL_USER"
          ]
        },
        "targets": {
          "$ref": "v1DeviceTaskTargets",
          "description": "Specifies where the task should run.",
          "deviceGroupsUuids": [
            {
              "type": "string"
            }
          ],
          "devicesUuids": [
            {
              "type": "string"
            }
          ]
        },
        "triggers": [
          {
            "$ref": "v1Trigger",
            "description": "Encodes information about when to run the task.",
            "manual": {
              "$ref": "v1ManualTrigger",
              "description": "For manually triggered tasks, this trigger causes immediate execution in as soon as possible fashion. Info: Examples: - Triggers: Manual Trigger - Windows Services: Trigger Start - Manual Trigger",
              "expireTime": {
                "type": "string",
                "description": "Task is not triggered after this time. This is useful for the task to not be triggered on stale targets (for example, those turned on after long time of vacation).",
                "format": "date-time"
              }
            }
          }
        ],
        "uuid": {
          "type": "string",
          "description": "Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within the entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier. RFC UUID can be recognized by being formatted according to the template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on Wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'"
        },
        "createTime": {
          "type": "string",
          "description": "The creation timestamp of an entity.",
          "format": "date-time"
        },
        "versionId": {
          "type": "string",
          "description": "Identifier of entity version. Every change to internal state of the entity leads to increase of this number. Every time this number changes, update_time must change as well. [Version id] also determines whether one version is more recent than another. More recent versions have higher numbers. Info: Similar concepts are - change sequence number (CSN) - version_id Info: Modeled after: https://google.aip.dev/162 revision_create_time is delivered by update_time of https://google.aip.dev/148#timestamps",
          "format": "uint64"
        },
        "updateTime": {
          "type": "string",
          "description": "Represents the timestamp when the resource was most recently updated. Any change to the resource made by users (create/update/delete) must update this value; changes to a resource made internally by the service should refresh this value unless specified otherwise on entity level. Info: Modeled after: https://google.aip.dev/148#timestamps",
          "format": "date-time"
        }
      }
    }

### Responses

Display Schema+Headers instead of an Example or vice-versa

Code | Description and Example | Description, Schema and Headers
--- | --- | ---
200 | A successful response. Response example
    {
      "task": {
        "action": {
          "name": "string",
          "params": {
            "@type": "string",
            "additionalProp1": {},
            "additionalProp2": {},
            "additionalProp3": {}
          }
        },
        "assetGroupUuid": "string",
        "description": "string",
        "displayName": "string",
        "source": "DEVICE_TASK_SOURCE_UNSPECIFIED",
        "targets": {
          "deviceGroupsUuids": [
            "string"
          ],
          "devicesUuids": [
            "string"
          ]
        },
        "triggers": [
          {
            "manual": {
              "createTime": "string",
              "expireTime": "string"
            }
          }
        ],
        "uuid": "string",
        "createTime": "string",
        "versionId": "string",
        "updateTime": "string"
      }
    }
| A successful response. Response schema
    {
      "$ref": "v1CreateTaskResponse",
      "task": {
        "$ref": "v1DeviceTask",
        "description": {
          "type": "string",
          "description": "User's description. Free text."
        },
        "action": {
          "$ref": "v1Action",
          "description": "Descriptor of the call to make.",
          "name": {
            "type": "string",
            "description": "Name of the function to execute. GRPC/ERPC function names in the form of package.ServiceName/RpcName For example: - eset.dotnod.scan_management.v1.ScanManager/CreateScan - eset.dotnod.power_management.v1.PowerManager/RegisterAction - eset.dotnod.network_access_protection.v1.NetworkAccessProtection/StartNetworkIsolation Actions outside .NOD are available as documented at ESET Connect Online Help."
          },
          "params": {
            "$ref": "protobufAny",
            "description": "Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example 'foo.bar.com/x/y.z' will yield type name 'y.z'. JSON The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { '@type': 'type.googleapis.com/google.profile.Person', 'firstName': <string>, 'lastName': <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): { '@type': 'type.googleapis.com/google.protobuf.Duration', 'value': '1.212s' }",
            "@type": {
              "type": "string",
              "description": "A URL/resource name whose content describes the type of the serialized protocol buffer message. For URLs which use the scheme http, https, or no scheme, the following restrictions and interpretations apply: If no scheme is provided, https is assumed. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading '.' is not accepted). An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics."
            },
            "additionalProperties": {
              "type": "object"
            }
          }
        },
        "assetGroupUuid": {
          "type": "string",
          "description": "Specifies in which asset group the task should be created. If empty or null, the asset group will be assigned automatically. type: asset_management.v1.Group"
        },
        "displayName": {
          "type": "string",
          "description": "User-friendly name of the task."
        },
        "source": {
          "$ref": "v1DeviceTaskSource",
          "type": "string",
          "description": "Possible sources of a task. DEVICE_TASK_SOURCE_UNSPECIFIED: fallback DEVICE_TASK_SOURCE_INTERNAL_AUTOMATION: The task was created by automation internal to the tenant. For example, some internal rule system. DEVICE_TASK_SOURCE_EXTERNAL_AUTOMATION: The task was created by automation external to the tenant/company. For example, a rule system of a company hired to provide managed detection and response services. DEVICE_TASK_SOURCE_INTERNAL_USER: The task was created by the user from within the tenant/company. For example, an internal security officer. DEVICE_TASK_SOURCE_EXTERNAL_USER: The task was created by the user external to the tenant/company. For example, a security manager of a company hired to provide managed detection and response services.",
          "enum": [
            "DEVICE_TASK_SOURCE_UNSPECIFIED",
            "DEVICE_TASK_SOURCE_INTERNAL_AUTOMATION",
            "DEVICE_TASK_SOURCE_EXTERNAL_AUTOMATION",
            "DEVICE_TASK_SOURCE_INTERNAL_USER",
            "DEVICE_TASK_SOURCE_EXTERNAL_USER"
          ]
        },
        "targets": {
          "$ref": "v1DeviceTaskTargets",
          "description": "Specifies where the task should run.",
          "deviceGroupsUuids": [
            {
              "type": "string"
            }
          ],
          "devicesUuids": [
            {
              "type": "string"
            }
          ]
        },
        "triggers": [
          {
            "$ref": "v1Trigger",
            "description": "Encodes information about when to run the task.",
            "manual": {
              "$ref": "v1ManualTrigger",
              "description": "For manually triggered tasks, this trigger causes immediate execution in as soon as possible fashion. Info: Examples: - Triggers: Manual Trigger - Windows Services: Trigger Start - Manual Trigger",
              "createTime": {
                "type": "string",
                "description": "When the manual trigger has been created. The task can only be triggered after this time. Read-only.",
                "format": "date-time",
                "readOnly": true
              },
              "expireTime": {
                "type": "string",
                "description": "Task is not triggered after this time. This is useful for the task to not be triggered on stale targets (for example, those turned on after long time of vacation).",
                "format": "date-time"
              }
            }
          }
        ],
        "uuid": {
          "type": "string",
          "description": "Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within the entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier. RFC UUID can be recognized by being formatted according to the template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on Wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'"
        },
        "createTime": {
          "type": "string",
          "description": "The creation timestamp of an entity.",
          "format": "date-time"
        },
        "versionId": {
          "type": "string",
          "description": "Identifier of entity version. Every change to internal state of the entity leads to increase of this number. Every time this number changes, update_time must change as well. [Version id] also determines whether one version is more recent than another. More recent versions have higher numbers. Info: Similar concepts are - change sequence number (CSN) - version_id Info: Modeled after: https://google.aip.dev/162 revision_create_time is delivered by update_time of https://google.aip.dev/148#timestamps",
          "format": "uint64"
        },
        "updateTime": {
          "type": "string",
          "description": "Represents the timestamp when the resource was most recently updated. Any change to the resource made by users (create/update/delete) must update this value; changes to a resource made internally by the service should refresh this value unless specified otherwise on entity level. Info: Modeled after: https://google.aip.dev/148#timestamps",
          "format": "date-time"
        }
      }
    }
default | An unexpected error response. Response example
    {
      "code": 0,
      "message": "string",
      "details": [
        {
          "@type": "string",
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      ]
    }
| An unexpected error response. Response schema
    {
      "$ref": "rpcStatus",
      "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.",
      "code": {
        "type": "integer",
        "description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].",
        "format": "int32"
      },
      "message": {
        "type": "string",
        "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
      },
      "details": [
        {
          "$ref": "protobufAny",
          "description": "Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example 'foo.bar.com/x/y.z' will yield type name 'y.z'. JSON The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { '@type': 'type.googleapis.com/google.profile.Person', 'firstName': <string>, 'lastName': <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): { '@type': 'type.googleapis.com/google.protobuf.Duration', 'value': '1.212s' }",
          "@type": {
            "type": "string",
            "description": "A URL/resource name whose content describes the type of the serialized protocol buffer message. For URLs which use the scheme http, https, or no scheme, the following restrictions and interpretations apply: If no scheme is provided, https is assumed. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading '.' is not accepted). An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics."
          },
          "additionalProperties": {
            "type": "object"
          }
        }
      ]
    }

˄˅