Gates

Create Gate

Changed on Sep 25, 2026

post/console/v1/gates

Request

Base URL
https://statsigapi.net
URL
https://statsigapi.net/console/v1/gates
Auth
API key in header STATSIG-API-KEY

Query parameters

includeArchiveMetadata'true' | 'false'

When "true", populate archivedAt / archivedBy* / archiveReason on the gate when it is currently archived. When omitted or "false", those fields are absent from the response.

Request body

namestring

The gate display name

isEnabledboolean

descriptionstring

tagsstring[]

type'PERMANENT' | 'TEMPORARY'

idTypestring

creatorIDstring nullable

creatorEmailstring nullable

teamstring nullable

teamIDstring nullable

measureMetricLiftsboolean

releasePipelineIDstring nullable

idstring

The gate name ID

isTemplateboolean

Example request

{
  "name": "a_verbose_gate",
  "idType": "userID",
  "isEnabled": false,
  "description": "helpful summary of what this gate does",
  "lastModifierName": "CONSOLE API",
  "lastModifierID": "5rfuqoxLIYTscuSaaCOlB8",
  "targetApps": [
    "my_app"
  ],
  "team": "team",
  "rules": [
    {
      "name": "All Conditions",
      "passPercentage": 10,
      "conditions": [
        {
          "type": "public"
        },
        {
          "type": "user_id",
          "targetValue": [
            "111",
            "222"
          ],
          "operator": "any"
        },
        {
          "type": "email",
          "targetValue": [
            "@outlook.com",
            "@gmail.com"
          ],
          "operator": "str_contains_any"
        },
        {
          "type": "custom_field",
          "targetValue": 31,
          "operator": "gt",
          "field": "age"
        },
        {
          "type": "app_version",
          "targetValue": "1.1.1",
          "operator": "version_gt"
        },
        {
          "type": "browser_name",
          "targetValue": [
            "Android",
            "Chrome"
          ],
          "operator": "any"
        },
        {
          "type": "browser_version",
          "targetValue": [
            "94.0.4606.81",
            "94.0.4606.92"
          ],
          "operator": "any"
        },
        {
          "type": "os_name",
          "targetValue": [
            "Android",
            "Windows"
          ],
          "operator": "none"
        },
        {
          "type": "os_version",
          "targetValue": "11.0.0",
          "operator": "version_lte"
        },
        {
          "type": "country",
          "targetValue": [
            "NZ",
            "US"
          ],
          "operator": "any"
        },
        {
          "type": "passes_gate",
          "targetValue": "my_gate_2"
        },
        {
          "type": "fails_gate",
          "targetValue": "my_gate_2"
        },
        {
          "type": "time",
          "targetValue": 1643070357193,
          "operator": "after"
        },
        {
          "type": "environment_tier",
          "targetValue": [
            "production"
          ],
          "operator": "any"
        },
        {
          "type": "passes_segment",
          "targetValue": "growth_org"
        },
        {
          "type": "fails_segment",
          "targetValue": "growth_org"
        },
        {
          "type": "ip_address",
          "targetValue": [
            "1.1.1.1",
            "8.8.8.8"
          ],
          "operator": "any"
        }
      ],
      "environment": null
    }
  ],
  "checksPerHour": 0,
  "tags": [],
  "monitoringMetrics": [
    {
      "name": "dau",
      "type": "user"
    }
  ]
}

Response

Create gate response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Gate created successfully.",
  "data": {
    "id": "a_gate",
    "permalink": "https://console.statsig.com/company_id/gates/a_gate",
    "name": "A Gate",
    "description": "description",
    "idType": "userID",
    "lastModifierID": "1vaQaBoLlkauH9iiuOSBP2",
    "lastModifiedTime": 1704929983827,
    "lastModifierName": "CONSOLE API",
    "lastModifierEmail": null,
    "creatorID": "1vaQaBoLlkauH9iiuOSBP2",
    "createdTime": 1704929979761,
    "creatorName": "CONSOLE API",
    "creatorEmail": null,
    "targetApps": [],
    "holdoutIDs": [],
    "tags": [],
    "isEnabled": true,
    "status": "In Progress",
    "rules": [],
    "checksPerHour": 0,
    "type": "PERMANENT",
    "typeReason": "NONE",
    "team": null,
    "reviewSettings": {
      "requiredReview": false,
      "allowedReviewers": []
    },
    "measureMetricLifts": true,
    "owner": {
      "ownerID": "user123",
      "ownerName": "CONSOLE API",
      "ownerType": "SDK_KEY",
      "ownerEmail": ""
    },
    "monitoringMetrics": [],
    "version": 1
  }
}

Changes

Sep 25, 202623753feb4120 Revision changes
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property //
- info
  the request optional property // became not read-only
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  the response optional property //// became not read-only for the status
Aug 26, 20261fd471fa03cc Revision changes
- breaking
  request property //// was restricted to a list of enum values
- warning
  added the new after enum value to the ////// response property for the response status
- warning
  added the new any enum value to the ////// response property for the response status
- warning
  added the new any_case_sensitive enum value to the ////// response property for the response status
- warning
  added the new array_contains_all enum value to the ////// response property for the response status
- warning
  added the new array_contains_any enum value to the ////// response property for the response status
- warning
  added the new array_contains_none enum value to the ////// response property for the response status
- warning
  added the new before enum value to the ////// response property for the response status
- warning
  added the new encoded_any enum value to the ////// response property for the response status
- warning
  added the new gt enum value to the ////// response property for the response status
- warning
  added the new gte enum value to the ////// response property for the response status
- warning
  added the new is_not_null enum value to the ////// response property for the response status
- warning
  added the new is_null enum value to the ////// response property for the response status
- warning
  added the new lt enum value to the ////// response property for the response status
- warning
  added the new lte enum value to the ////// response property for the response status
- warning
  added the new none enum value to the ////// response property for the response status
- warning
  added the new none_case_sensitive enum value to the ////// response property for the response status
- warning
  added the new not_array_contains_all enum value to the ////// response property for the response status
- warning
  added the new on enum value to the ////// response property for the response status
- warning
  added the new str_contains_any enum value to the ////// response property for the response status
- warning
  added the new str_contains_none enum value to the ////// response property for the response status
- warning
  added the new str_matches enum value to the ////// response property for the response status
- warning
  added the new version_eq enum value to the ////// response property for the response status
- warning
  added the new version_gt enum value to the ////// response property for the response status
- warning
  added the new version_gte enum value to the ////// response property for the response status
- warning
  added the new version_lt enum value to the ////// response property for the response status
- warning
  added the new version_lte enum value to the ////// response property for the response status
- info
  added the new after enum value to the request property ////
- info
  added the new any enum value to the request property ////
- info
  added the new any_case_sensitive enum value to the request property ////
- info
  added the new array_contains_all enum value to the request property ////
- info
  added the new array_contains_any enum value to the request property ////
- info
  added the new array_contains_none enum value to the request property ////
- info
  added the new before enum value to the request property ////
- info
  added the new encoded_any enum value to the request property ////
- info
  added the new gt enum value to the request property ////
- info
  added the new gte enum value to the request property ////
- info
  added the new is_not_null enum value to the request property ////
- info
  added the new is_null enum value to the request property ////
- info
  added the new lt enum value to the request property ////
- info
  added the new lte enum value to the request property ////
- info
  added the new none enum value to the request property ////
- info
  added the new none_case_sensitive enum value to the request property ////
- info
  added the new not_array_contains_all enum value to the request property ////
- info
  added the new on enum value to the request property ////
- info
  added the new str_contains_any enum value to the request property ////
- info
  added the new str_contains_none enum value to the request property ////
- info
  added the new str_matches enum value to the request property ////
- info
  added the new version_eq enum value to the request property ////
- info
  added the new version_gt enum value to the request property ////
- info
  added the new version_gte enum value to the request property ////
- info
  added the new version_lt enum value to the request property ////
- info
  added the new version_lte enum value to the request property ////

Operation history (4 revisions)