ESET PROTECT On-Prem

Offline | Prejsť do režimu online

ESET PROTECT On-Prem – Obsah

# Create policy

Skopírovať odkaz na aktuálny článok Odoslať e‑mailom

Relative path: /v2/policies

Create a policy.

All the included feature policies must be valid. Otherwise, INVALID_ARGUMENT (gRPC) or 400 BAD Request (REST) is returned.

### Body example

{ "policy": { "features": [ { "flags": {}, "configuration": { "data": " ", "product": "eset.local.products.endpoint", "@type": "type.googleapis.com/Era.Common.DataDefinition.Policy.PolicyData" }, "featureId": 4294967295 } ], "description": "Created by API", "displayName": "Policy_via_REST_API" } }

### How to get the `data` part from the existing policy:

1.Log in to the ESET PROTECT Web Console.

2.Open Policies.

3.Click the policy and select the Export option in the context menu or via the Actions button.

4.A .dat file will be exported.

5.Open the .dat file in a text editor and copy the last line without its ending (for example, omit `eset.local.products.endpoint`).

6.Insert the copied part to the `data` part of the request body.
Example of a code to be copied from the .dat file:

### Request body

Display Schema instead of an Example or vice-versa

Type | Required | Example | Schema
--- | --- | --- | ---
application/json | Yes |
    {
      "policy": {
        "description": "string",
        "displayName": "string",
        "features": [
          {
            "configuration": {
              "@type": "string",
              "additionalProp1": {},
              "additionalProp2": {},
              "additionalProp3": {}
            },
            "featureId": 0,
            "flags": {
              "additionalProp1": {
                "applyForcefully": true,
                "readOnly": true
              },
              "additionalProp2": {
                "applyForcefully": true,
                "readOnly": true
              },
              "additionalProp3": {
                "applyForcefully": true,
                "readOnly": true
              }
            }
          }
        ]
      }
    }
    {
      "$ref": "v2CreatePolicyRequest",
      "policy": {
        "$ref": "v2Policy",
        "description": {
          "type": "string",
          "description": "Description of the policy."
        },
        "displayName": {
          "type": "string",
          "description": "Human-readable name of the policy."
        },
        "features": [
          {
            "$ref": "v2FeaturePolicy",
            "description": "Policy for individual feature. The type of the proposed configuration must match the feature. If the feature does not understand the configuration, the configuration is considered to be empty.",
            "configuration": {
              "$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"
              }
            },
            "featureId": {
              "type": "integer",
              "description": "Reference to the feature whose configuration is proposed. Some IDs are reserved for legacy software. For ERA/ESMC/EP(C) legacy policy, use 0xFFFFFFFF value for feature_id. type: feature_catalog.v1.Feature",
              "format": "int64"
            },
            "flags": {
              "type": "object",
              "additionalProperties": {
                "$ref": "v2SettingFlags",
                "type": "object",
                "properties": {
                  "applyForcefully": {
                    "type": "boolean",
                    "description": "Will win merging, if merged before other policies."
                  },
                  "readOnly": {
                    "type": "boolean",
                    "description": "Cannot be overridden by client."
                  }
                },
                "description": "Flag of the individual setting."
              },
              "description": "Map selector to set of flags. The selector is of the same format as the paths of the field mask. That also implies flags cannot be given to array members, only whole arrays."
            }
          }
        ]
      }
    }

### 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
    {
      "policy": {
        "builtIn": true,
        "description": "string",
        "displayName": "string",
        "features": [
          {
            "configuration": {
              "@type": "string",
              "additionalProp1": {},
              "additionalProp2": {},
              "additionalProp3": {}
            },
            "featureId": 0,
            "flags": {
              "additionalProp1": {
                "applyForcefully": true,
                "readOnly": true
              },
              "additionalProp2": {
                "applyForcefully": true,
                "readOnly": true
              },
              "additionalProp3": {
                "applyForcefully": true,
                "readOnly": true
              }
            }
          }
        ],
        "uuid": "string"
      }
    }
| A successful response. Response schema
    {
      "$ref": "v2CreatePolicyResponse",
      "policy": {
        "$ref": "v2Policy",
        "description": {
          "type": "string",
          "description": "Description of the policy."
        },
        "builtIn": {
          "type": "boolean",
          "description": "True if the policy is built-in. Built-in policies cannot be created, modified or deleted.",
          "readOnly": true
        },
        "displayName": {
          "type": "string",
          "description": "Human-readable name of the policy."
        },
        "features": [
          {
            "$ref": "v2FeaturePolicy",
            "description": "Policy for individual feature. The type of the proposed configuration must match the feature. If the feature does not understand the configuration, the configuration is considered to be empty.",
            "configuration": {
              "$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"
              }
            },
            "featureId": {
              "type": "integer",
              "description": "Reference to the feature whose configuration is proposed. Some IDs are reserved for legacy software. For ERA/ESMC/EP(C) legacy policy, use 0xFFFFFFFF value for feature_id. type: feature_catalog.v1.Feature",
              "format": "int64"
            },
            "flags": {
              "type": "object",
              "additionalProperties": {
                "$ref": "v2SettingFlags",
                "type": "object",
                "properties": {
                  "applyForcefully": {
                    "type": "boolean",
                    "description": "Will win merging, if merged before other policies."
                  },
                  "readOnly": {
                    "type": "boolean",
                    "description": "Cannot be overridden by client."
                  }
                },
                "description": "Flag of the individual setting."
              },
              "description": "Map selector to set of flags. The selector is of the same format as the paths of the field mask. That also implies flags cannot be given to array members, only whole arrays."
            }
          }
        ],
        "uuid": {
          "type": "string",
          "description": "Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within 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'",
          "readOnly": true
        }
      }
    }
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"
          }
        }
      ]
    }

˄˅