Update a trial policy

Updates the specified trial policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/trial-policies/{id}

JWT

trialPolicy:write

Parameters

Name	Type	In	Description
id*	string	path	Unique identifier for the trial policy.

Request Body Schema

Property	Type	Description	Constraints
name	string	Name of the policy.	min: 1, max: 256
fingerprintMatchingStrategy	string	Strategy for matching machine fingerprint.	enum: [fuzzy, exact, loose]
allowVmActivation	boolean	Whether to allow an activation inside a virtual machine.
allowContainerActivation	boolean	Whether to allow an activation inside a container.
userLocked	boolean	Locks the activation to the machine user.
disableGeoLocation	boolean	Whether IP address and geo-location should be stored.
allowedIpRanges	array	Allowed IP ranges. Leave empty to ignore.	items: string
allowedCountries	array	List of the allowed countries. Leave empty to ignore.	items: string
disallowedCountries	array	List of the disallowed countries. Leave empty to ignore.	items: string
allowedIpAddresses	array	List of the allowed ip addresses. Leave empty to ignore.	items: string
disallowedIpAddresses	array	List of the disallowed ip addresses. Leave empty to ignore.	items: string
trialLength	integer	The duration after which the trial will expire.	min: 1, max: 2147483647, format: int32

Request Example

{
  "name": "string",
  "fingerprintMatchingStrategy": "fuzzy",
  "allowVmActivation": true,
  "allowContainerActivation": true,
  "userLocked": true,
  "disableGeoLocation": true,
  "allowedIpRanges": [
    "string"
  ],
  "allowedCountries": [
    "string"
  ],
  "disallowedCountries": [
    "string"
  ],
  "allowedIpAddresses": [
    "string"
  ],
  "disallowedIpAddresses": [
    "string"
  ],
  "trialLength": 1
}

Triggers webhook: trialPolicy.updated

POST <your-webhook-url>
{
  "event": "trialPolicy.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "allowVmActivation": true,
    "allowContainerActivation": true,
    "userLocked": true,
    "disableGeoLocation": true,
    "allowedIpRange": "string",
    "allowedIpRanges": [
      "string"
    ],
    "allowedCountries": [
      "string"
    ],
    "disallowedCountries": [
      "string"
    ],
    "allowedIpAddresses": [
      "string"
    ],
    "disallowedIpAddresses": [
      "string"
    ],
    "trialLength": 0,
    "fingerprintMatchingStrategy": "fuzzy"
  },
  "triggeredAt": "string"
}

Responses

200

400

401

403

404

429

500

200 OK

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "allowVmActivation": true,
  "allowContainerActivation": true,
  "userLocked": true,
  "disableGeoLocation": true,
  "allowedIpRange": "string",
  "allowedIpRanges": [
    "string"
  ],
  "allowedCountries": [
    "string"
  ],
  "disallowedCountries": [
    "string"
  ],
  "allowedIpAddresses": [
    "string"
  ],
  "disallowedIpAddresses": [
    "string"
  ],
  "trialLength": 0,
  "fingerprintMatchingStrategy": "fuzzy"
}