Create policy
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.
Endpoint URL for Europe, Germany, United States, Canada and Japan regions:
|
https://eu.policy-management.eset.systems/v2/policies |
|
https://de.policy-management.eset.systems/v2/policies |
|
https://us.policy-management.eset.systems/v2/policies |
|
https://ca.policy-management.eset.systems/v2/policies |
|
https://jpn.policy-management.eset.systems/v2/policies |
Request body
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. In its binary encoding, an Any is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the type URL is described on the type_url field. Protobuf APIs provide utilities to interact with Any values: A 'pack' operation accepts a message and constructs a generic Any wrapper around it. An 'unpack' operation reads the content of an Any message, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declared type_url. An 'is' operation decides whether an Any contains a message of the given type, i.e. whether it can 'unpack' that type. The JSON format representation of an Any follows one of these cases: For types without special-cased JSON encodings, the JSON format representation of the Any is the same as that of the message, with an additional @type field which contains the type URL. For types with special-cased JSON encodings (typically called 'well-known' types, listed in https://protobuf.dev/programming-guides/json/#any), the JSON format representation has a key @type which contains the type URL and a key value which contains the JSON-serialized value. The text format representation of an Any is like a message with one field whose name is the type URL in brackets. For example, an Any containing a foo.Bar message may be written [type.googleapis.com/foo.Bar] { a: 2 }.",
"@type": {
"type": "string",
"description": "Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name. Example: type.googleapis.com/google.protobuf.StringValue This string must contain at least one / character, and the content after the last / must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them. The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last / to identify the type. type.googleapis.com/ is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests. All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): /-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, type.googleapis.com%2FFoo should be rejected. In the original design of Any, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs."
},
"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
Code |
Description and Example |
Description, Schema and Headers |
|---|---|---|
200 |
Successful response.
{
"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"
}
}
|
Successful response.
{
"$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. In its binary encoding, an Any is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the type URL is described on the type_url field. Protobuf APIs provide utilities to interact with Any values: A 'pack' operation accepts a message and constructs a generic Any wrapper around it. An 'unpack' operation reads the content of an Any message, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declared type_url. An 'is' operation decides whether an Any contains a message of the given type, i.e. whether it can 'unpack' that type. The JSON format representation of an Any follows one of these cases: For types without special-cased JSON encodings, the JSON format representation of the Any is the same as that of the message, with an additional @type field which contains the type URL. For types with special-cased JSON encodings (typically called 'well-known' types, listed in https://protobuf.dev/programming-guides/json/#any), the JSON format representation has a key @type which contains the type URL and a key value which contains the JSON-serialized value. The text format representation of an Any is like a message with one field whose name is the type URL in brackets. For example, an Any containing a foo.Bar message may be written [type.googleapis.com/foo.Bar] { a: 2 }.",
"@type": {
"type": "string",
"description": "Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name. Example: type.googleapis.com/google.protobuf.StringValue This string must contain at least one / character, and the content after the last / must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them. The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last / to identify the type. type.googleapis.com/ is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests. All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): /-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, type.googleapis.com%2FFoo should be rejected. In the original design of Any, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs."
},
"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
}
}
}
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
202 |
Response took too long; request cached. Response can be retrieved later using the response-id header. |
Response took too long; request cached. Response can be retrieved later using the response-id header.
[]
{
"response-id": {
"description": "Unique ID of a pending request. Used to retrieve cached result.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
400 |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided. |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
401 |
Token has expired or is invalid. |
Token has expired or is invalid.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
403 |
Access denied. Check permissions. |
Access denied. Check permissions.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
404 |
Requested resource not found. |
Requested resource not found.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
429 |
Rate limit reached. Try again later. |
Rate limit reached. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
500 |
Internal server failure. Try again later. |
Internal server failure. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
502 |
Internal server failure. Try again later. |
Internal server failure. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
503 |
Environment under maintenance. Try again later. |
Environment under maintenance. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
504 |
Action took too long; timeout reached |
Action took too long; timeout reached
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|