STstatsig
Gates

Disable Gate

Changed on
put/console/v1/gates/{id}/disable

Request

  • Base URL
    https://statsigapi.net
  • URL
    https://statsigapi.net/console/v1/gates/{id}/disable
  • Auth
    API key in header STATSIG-API-KEY

Path parameters

idstring required

id

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.

Response

Launch gate response

messagestring required

A simple string explaining the result of the operation.

Example response

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

Changes

  • 23753feb4120Revision changes
    • 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

  • 1fd471fa03ccRevision changes
    • 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