Set ramp monitoring mode

POST

ramp-schedules

{id}

actions

set-monitoring-mode

cURL

curl -X POST 'https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "entityType": "feature",
  "entityId": "<string>",
  "targets": [
    {
      "id": "<string>",
      "entityType": "feature",
      "entityId": "<string>",
      "ruleId": "<string>",
      "environment": "<string>",
      "activatingRevisionVersion": 123
    }
  ],
  "steps": [
    {
      "interval": 1,
      "actions": [
        {
          "targetType": "feature-rule",
          "targetId": "<string>",
          "patch": {
            "ruleId": "<string>",
            "coverage": 0.5,
            "condition": "<string>",
            "savedGroups": [
              {
                "ids": [
                  "<string>"
                ]
              }
            ],
            "prerequisites": [
              {
                "id": "<string>",
                "condition": "<string>"
              }
            ],
            "allEnvironments": true,
            "environments": [
              "<string>"
            ],
            "force": "<unknown>",
            "enabled": true
          }
        }
      ],
      "approvalNotes": "<string>",
      "monitored": true,
      "holdConditions": {
        "minSampleSize": 123,
        "requiresApproval": true
      }
    }
  ],
  "currentStepIndex": 0,
  "nextStepAt": "2023-11-07T05:31:56Z",
  "startActions": [
    {
      "targetType": "feature-rule",
      "targetId": "<string>",
      "patch": {
        "ruleId": "<string>",
        "coverage": 0.5,
        "condition": "<string>",
        "savedGroups": [
          {
            "ids": [
              "<string>"
            ]
          }
        ],
        "prerequisites": [
          {
            "id": "<string>",
            "condition": "<string>"
          }
        ],
        "allEnvironments": true,
        "environments": [
          "<string>"
        ],
        "force": "<unknown>",
        "enabled": true
      }
    }
  ],
  "endActions": [
    {
      "targetType": "feature-rule",
      "targetId": "<string>",
      "patch": {
        "ruleId": "<string>",
        "coverage": 0.5,
        "condition": "<string>",
        "savedGroups": [
          {
            "ids": [
              "<string>"
            ]
          }
        ],
        "prerequisites": [
          {
            "id": "<string>",
            "condition": "<string>"
          }
        ],
        "allEnvironments": true,
        "environments": [
          "<string>"
        ],
        "force": "<unknown>",
        "enabled": true
      }
    }
  ],
  "startDate": "2023-11-07T05:31:56Z",
  "cutoffDate": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "phaseStartedAt": "2023-11-07T05:31:56Z",
  "pausedAt": "2023-11-07T05:31:56Z",
  "nextProcessAt": "2023-11-07T05:31:56Z",
  "elapsedMs": 123,
  "lockdownConfig": {},
  "monitoringConfig": {
    "datasourceId": "<string>",
    "exposureQueryId": "<string>",
    "guardrailMetricIds": [
      "<string>"
    ],
    "signalMetricIds": [
      "<string>"
    ],
    "updateScheduleMinutes": 11,
    "autoUpdate": true,
    "noTrafficGracePeriodHours": 1
  },
  "currentStepEnteredAt": "2023-11-07T05:31:56Z",
  "stepApproval": {
    "stepIndex": 123,
    "approvedAt": "2023-11-07T05:31:56Z",
    "approvedBy": "<string>"
  },
  "monitoringStartDate": "2023-11-07T05:31:56Z",
  "lastRollbackAt": "2023-11-07T05:31:56Z",
  "lastRollbackReason": "<string>",
  "monitoringStatus": {
    "autoUpdate": true,
    "effectiveAutoUpdate": true,
    "currentStepMonitored": true,
    "safeRolloutId": "<string>",
    "blockedReason": "<string>",
    "nextSnapshotAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

If using Bearer auth, pass the Secret Key as the token:

curl https://api.growthbook.io/api/v1/features   -H "Authorization: Bearer secret_abc123DEF456"

Path Parameters

string

required

Body

application/json

monitoringMode

enum<string>

required

auto schedules snapshots automatically while allowed by ramp state. manual disables agenda updates and relies on manual Update clicks.

Available options:

auto,

manual

Response

200 - application/json

Resource created

string

required

Unique identifier (rs_ prefix)

dateCreated

string<date-time>

required

dateUpdated

string<date-time>

required

name

string

required

entityType

enum<string>

required

Available options:

feature

entityId

string

required

targets

object[]

required

Controlled entity references

Show child attributes

steps

object[]

required

Ordered ramp steps

Show child attributes

status

enum<string>

required

Available options:

pending,

ready,

running,

paused,

completed,

rolled-back

currentStepIndex

integer

required

Index of current step; -1 = not yet started

Required range: x >= -1

nextStepAt

string<date-time> | null

required

When the current step's time gate elapses; null for steps with no interval (pure approval gates) and terminal states

startActions

object[]

Actions that restore controlled rules to their pre-ramp state. Applied when rolling back or jumping to start.

Show child attributes

endActions

object[]

Actions applied on top of all step patches when the ramp completes. Represents the final desired rule state.

Show child attributes

startDate

string<date-time> | null

When the ramp fires. Absent/null means immediately on publish; set to a future datetime to delay start and keep the rule disabled until that time.

cutoffDate

string<date-time> | null

Rule-level kill date. When reached, the ramp is completed and the rule is disabled (enabled=false). Use for time-boxed rules that must stop serving on a fixed date regardless of ramp progress. Set to null to clear.

startedAt

string<date-time> | null

phaseStartedAt

string<date-time> | null

Anchor for cumulative interval timing; resets after each approval gate is satisfied

pausedAt

string<date-time> | null

nextProcessAt

string<date-time> | null

elapsedMs

integer | null

Milliseconds since startedAt (computed at response time, not stored)

lockdownConfig

object

Show child attributes

monitoringConfig

object | null

Show child attributes

experimentHealthAction

enum<string>

Available options:

rollback,

hold,

warn

currentStepEnteredAt

string<date-time> | null

stepApproval

object | null

Approval record for the current step. Valid only while stepApproval.stepIndex === currentStepIndex.

Show child attributes

monitoringStartDate

string<date-time> | null

When the monitored section most recently started (first monitored step entered). Used for no-traffic grace period gating.

lastRollbackAt

string<date-time> | null

lastRollbackReason

string | null

monitoringStatus

object | null

Read-only monitoring status. Present when monitoringConfig is set.

Show child attributes

cURL

curl -X POST 'https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/set-monitoring-mode")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "entityType": "feature",
  "entityId": "<string>",
  "targets": [
    {
      "id": "<string>",
      "entityType": "feature",
      "entityId": "<string>",
      "ruleId": "<string>",
      "environment": "<string>",
      "activatingRevisionVersion": 123
    }
  ],
  "steps": [
    {
      "interval": 1,
      "actions": [
        {
          "targetType": "feature-rule",
          "targetId": "<string>",
          "patch": {
            "ruleId": "<string>",
            "coverage": 0.5,
            "condition": "<string>",
            "savedGroups": [
              {
                "ids": [
                  "<string>"
                ]
              }
            ],
            "prerequisites": [
              {
                "id": "<string>",
                "condition": "<string>"
              }
            ],
            "allEnvironments": true,
            "environments": [
              "<string>"
            ],
            "force": "<unknown>",
            "enabled": true
          }
        }
      ],
      "approvalNotes": "<string>",
      "monitored": true,
      "holdConditions": {
        "minSampleSize": 123,
        "requiresApproval": true
      }
    }
  ],
  "currentStepIndex": 0,
  "nextStepAt": "2023-11-07T05:31:56Z",
  "startActions": [
    {
      "targetType": "feature-rule",
      "targetId": "<string>",
      "patch": {
        "ruleId": "<string>",
        "coverage": 0.5,
        "condition": "<string>",
        "savedGroups": [
          {
            "ids": [
              "<string>"
            ]
          }
        ],
        "prerequisites": [
          {
            "id": "<string>",
            "condition": "<string>"
          }
        ],
        "allEnvironments": true,
        "environments": [
          "<string>"
        ],
        "force": "<unknown>",
        "enabled": true
      }
    }
  ],
  "endActions": [
    {
      "targetType": "feature-rule",
      "targetId": "<string>",
      "patch": {
        "ruleId": "<string>",
        "coverage": 0.5,
        "condition": "<string>",
        "savedGroups": [
          {
            "ids": [
              "<string>"
            ]
          }
        ],
        "prerequisites": [
          {
            "id": "<string>",
            "condition": "<string>"
          }
        ],
        "allEnvironments": true,
        "environments": [
          "<string>"
        ],
        "force": "<unknown>",
        "enabled": true
      }
    }
  ],
  "startDate": "2023-11-07T05:31:56Z",
  "cutoffDate": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "phaseStartedAt": "2023-11-07T05:31:56Z",
  "pausedAt": "2023-11-07T05:31:56Z",
  "nextProcessAt": "2023-11-07T05:31:56Z",
  "elapsedMs": 123,
  "lockdownConfig": {},
  "monitoringConfig": {
    "datasourceId": "<string>",
    "exposureQueryId": "<string>",
    "guardrailMetricIds": [
      "<string>"
    ],
    "signalMetricIds": [
      "<string>"
    ],
    "updateScheduleMinutes": 11,
    "autoUpdate": true,
    "noTrafficGracePeriodHours": 1
  },
  "currentStepEnteredAt": "2023-11-07T05:31:56Z",
  "stepApproval": {
    "stepIndex": 123,
    "approvedAt": "2023-11-07T05:31:56Z",
    "approvedBy": "<string>"
  },
  "monitoringStartDate": "2023-11-07T05:31:56Z",
  "lastRollbackAt": "2023-11-07T05:31:56Z",
  "lastRollbackReason": "<string>",
  "monitoringStatus": {
    "autoUpdate": true,
    "effectiveAutoUpdate": true,
    "currentStepMonitored": true,
    "safeRolloutId": "<string>",
    "blockedReason": "<string>",
    "nextSnapshotAt": "2023-11-07T05:31:56Z"
  }
}

Introduction

Endpoints

Models

Authorizations

Path Parameters

Body

Response