How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GrowthBook ramp-schedules API

Multi-step rollout schedules that gradually ramp feature rule changes over time, with support for interval, approval, and scheduled triggers.

GrowthBook ramp-schedules API is one of 36 APIs that GrowthBook publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ramp-schedules. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 14 operations across 11 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.growthbook.io/api, https://{domain}/api.

14 operations 11 paths 1 schemas 1 DELETE2 GET10 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.growthbook.io/api
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

GrowthBook ramp-schedules API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — If using Bearer auth, pass the Secret Key as the token: bash curl https://api.growthbook.io/api/v1/features -H "Authorization: Bearer secretabc123DEF456"
  • basicAuth — If using HTTP Basic auth, pass the Secret Key as the username and leave the password blank: bash curl https://api.growthbook.io/api/v1/features -u secretabc123…

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 1 DELETE, 2 GET, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ramp-schedules 14

Multi-step rollout schedules that gradually ramp feature rule changes over time, with support for interval, approval, and scheduled triggers.

GET
/v1/ramp-schedules
Get all rampSchedules
listRampSchedules 4 params → 200
POST
/v1/ramp-schedules
Create a single rampSchedule
createRampSchedule body → 200
POST
/v1/ramp-schedules/{id}/actions/start
Start a ramp schedule
startRampSchedule 1 param → 200
POST
/v1/ramp-schedules/{id}/actions/pause
Pause a ramp schedule
pauseRampSchedule 1 param → 200
POST
/v1/ramp-schedules/{id}/actions/resume
Resume a paused ramp schedule
resumeRampSchedule 1 param → 200
POST
/v1/ramp-schedules/{id}/actions/rollback
Roll back a ramp schedule
rollbackRampSchedule 1 param → 200
POST
/v1/ramp-schedules/{id}/actions/jump
Jump to a specific step
jumpRampSchedule 1 param body → 200
POST
/v1/ramp-schedules/{id}/actions/complete
Complete a ramp schedule immediately
completeRampSchedule 1 param → 200
POST
/v1/ramp-schedules/{id}/actions/approve-step
Approve the current pending-approval step
approveStepRampSchedule 1 param → 200
POST
/v1/ramp-schedules/{id}/actions/add-target
Add a target rule to a ramp schedule
addTargetRampSchedule 1 param body → 200
POST
/v1/ramp-schedules/{id}/actions/eject-target
Remove a target rule from a ramp schedule
ejectTargetRampSchedule 1 param body → 200
GET
/v1/ramp-schedules/{id}
Get a single rampSchedule
getRampSchedule 1 param → 200
DELETE
/v1/ramp-schedules/{id}
Delete a single rampSchedule
deleteRampSchedule 1 param → 200
PUT
/v1/ramp-schedules/{id}
Update a single rampSchedule
updateRampSchedule 1 param body → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is RampSchedule (19 properties). Each schema is shown below with its type and property counts.

RampSchedule
object
19 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

growthbook-ramp-schedules-api-openapi.yml Raw ↑

Other APIs GrowthBook publishes across the network.

GrowthBook AnalyticsExplorations API
GrowthBook archetypes API
GrowthBook attributes API
GrowthBook code-references API
GrowthBook CustomFields API
GrowthBook Dashboards API
GrowthBook data-sources API
GrowthBook dimensions API
GrowthBook environments API
GrowthBook experiments API
GrowthBook ExperimentTemplates API
GrowthBook fact-metrics API
Where this information came from

This is an independent, third-party profile of GrowthBook ramp-schedules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.