SN System Properties Reference
Property reference

glide.rest.sampling.enabled

The glide.rest.sampling.enabled property activates request sampling for scripted REST APIs. It is crucial for generating OpenAPI specifications, but should only be enabled in non-production environments to avoid performance issues.

Default
false
Type
boolean
Application
Global

Key questions about this property

The answers below summarize the purpose, scope, default effect, and review scenarios for this property.

What does it do? This property allows the automatic generation of API request definitions by enabling request sampling from scripted REST API resources.
What area does it affect? Scripted REST APIs
What does the default mean? The default value is "false", which means this behavior is disabled by default.
When should you review it? Review this property when configuring scripted REST APIs, especially before moving to production.

Out of the box property record

Raw metadata from the property record.

Property name glide.rest.sampling.enabled
Sys ID fdcc82c2ff9b3210e336ffffffffff09
Type boolean
Application Global
Default value false
Description System property to enable request capturing and on scripted rest APIs for OpenAPI spec generation. Should be limited to sub-production instances.
Updated 2026-02-27 14:03:55

Sources

Official references and nearby text excerpts where this property appears.

Documentation excerpt View supporting context
Context preview Snippet 1
... to an API resource to generate request header associations, query parameter associations, and a request schema for that resource. Before you begin An instance admin must set the system property glide.rest.sampling.enabled to true. To limit the likelihood of performance problems, only enable automatic generation of API request definitions in non-production instances. Role required: web_service_admin Procedure 1. Create a scripted REST API ...
Documentation excerpt View supporting context
Context preview Snippet 2
... off of the instance address not the request host address. • Type: true | false • Default value: true • Location: Add the property to the System Property [sys_properties] table. glide.rest.sampling.enabled Enables request sampling from scripted REST API resources. Request samples can be used to automatically generate definitions for request headers, query parameters, and schemas. General guidance to help limit performance ...

More in glide.rest

Other properties in the same namespace.

glide.rest.enforce.end_request_processing.once This property enforces that each REST request is processed a single time, preventing potential duplication of glide.rest.global.honor_snc_internal_flag This property controls the enforcement of the snc_internal role requirement for accessing REST API resources, glide.rest.java.honor_snc_internal_flag This property configures the default access control for Java implemented REST API resources based on the 'snc_ glide.rest.outbound.preserve_requests This property, when set to true, ensures that the query content in RestMessageV2 is replaced with processed or glide.rest.sampling.max_configuration_count This property limits the number of concurrent configurations for request sampling in scripted REST APIs to a m glide.rest.sampling.max_sample_count This property configures the upper limit of samples collected for each endpoint during request sampling, ensur glide.rest.sanitize_request_input This property configures the system to sanitize script elements in request data, enhancing security by mitigat glide.rest.service.stats.row.level.acl.enabled This property determines whether row-level access control is enforced for REST service statistics, impacting d

All 15 properties in glide.rest →