Press CTRL+K to open search

Create a new Entitlement Script

Prev Next
Post
/entitlement-scripts

Create a new Entitlement Script.

Security
HTTP
Type bearer
Body parameters

Entitlement Script object.

object
id
string (uuid)

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
name
string Required

Name of the object.

Exampleobject
notes
string

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.
tags
Array of string

Array of tags.

Example[ "developer", "api-created" ]
string
type
string

The type of the field to use the script for.

Valid values[ "host", "portOrType", "appShortcut" ]
Default"host"
expression
string Required

A JavaScript expression that returns a list of IPs and names.

Examplevar httpResponse = httpGet('https://ips.company.com/my-resource'); var data = JSON.parse(httpResponse.data); return data.ips;
Responses
200

Created Entitlement Script.

object
id
string (uuid)

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
name
string

Name of the object.

Exampleobject
notes
string

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.
created
string (date-time)

Create date.

updated
string (date-time)

Last update date.

readOnly
boolean

Whether the entity is protected from manual updates and deletes.

Examplefalse
tags
Array of string

Array of tags.

Example[ "developer", "api-created" ]
string
type
string

The type of the field to use the script for.

Valid values[ "host", "portOrType", "appShortcut" ]
Default"host"
expression
string

A JavaScript expression that returns a list of IPs and names.

Examplevar httpResponse = httpGet('https://ips.company.com/my-resource'); var data = JSON.parse(httpResponse.data); return data.ips;
400

JSON error. Check the JSON format.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

409

The submitted resource conflicts with another.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

422

Request validation error. Check "errors" array for details.

Expand All
object

Http 422 error for object validation.

id
string

Machine readable error code.

message
string

Human readable error details.

errors
Array of object

List of fields with validation errors.

object
field
string

Name of the field that failed validation.

Examplename
message
string

Failure reason.

Examplemay not be null
displayField
string

Name of the field that should be displayed in the UI. It's an internal field to be used by the local replication service.

ExampleName
replicationMessage
string

Message to be displayed in the replication UI. It's an internal field to be used by the local replication service.

ExampleName is required.
500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

©AppGate 2026. All Rights Reserved.