TypeScript
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.experimentation.experiments.advanceRamp("id", {
target_level: 1,
});
}
main();import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.experimentation.experiments.advanceRamp("id", {
target_level: 1,
});
}
main();
package example
import (
context "context"
management "github.com/auth0/go-auth0/v3/management"
client "github.com/auth0/go-auth0/v3/management/client"
option "github.com/auth0/go-auth0/v3/management/option"
)
func do() {
mgmt, err := client.New(
"{YOUR_DOMAIN}",
option.WithToken(
"<token>",
),
)
if err != nil {
return
}
request := &management.AdvanceRampRequestContent{
TargetLevel: 1,
}
mgmt.Experimentation.Experiments.AdvanceRamp(
context.TODO(),
"id",
request,
)
}
# Ensure you're logged in: auth0 login
auth0 api post "experimentation/experiments/id/advance-ramp" --data '{
"target_level": 1
}'using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Experimentation;
public partial class Examples
{
public async Task Example() {
var client = new ManagementApiClient(
token: "<token>",
clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
);
await client.Experimentation.Experiments.AdvanceRampAsync(
id: "id",
request: new AdvanceRampRequestContent {
TargetLevel = 1
}
);
}
}
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.experimentation.types.AdvanceRampRequestContent;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.experimentation().experiments().advanceRamp(
"id",
AdvanceRampRequestContent
.builder()
.targetLevel(1)
.build()
);
}
}<?php
namespace Example;
use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Experimentation\Experiments\Requests\AdvanceRampRequestContent;
$client = new ManagementClient(new ManagementClientOptions(
domain: '{YOUR_DOMAIN}',
token: '<token>',
));
$client->experimentation->experiments->advanceRamp(
'id',
new AdvanceRampRequestContent([
'targetLevel' => 1,
]),
);
from auth0.management import ManagementClient
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.experimentation.experiments.advance_ramp(
id="id",
target_level=1,
)
require "auth0"
client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")
client.experimentation.experiments.advance_ramp(
id: "id",
target_level: 1
)
curl --request POST \
--url https://{tenantDomain}/api/v2/experimentation/experiments/{id}/advance-ramp \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"target_level": 50
}
'{
"experiment_id": "<string>",
"from_level": 123,
"to_level": 123,
"current_level": 123
}Advance the rollout level of a ramp experiment.
Increments the current ramp index to the requested target level. Up-only: the target must be the immediate next level in the schedule. Idempotent: calling with the current level returns success without writing anything.
POST
https://{tenantDomain}/api/v2
/
experimentation
/
experiments
/
{id}
/
advance-ramp
TypeScript
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.experimentation.experiments.advanceRamp("id", {
target_level: 1,
});
}
main();import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.experimentation.experiments.advanceRamp("id", {
target_level: 1,
});
}
main();
package example
import (
context "context"
management "github.com/auth0/go-auth0/v3/management"
client "github.com/auth0/go-auth0/v3/management/client"
option "github.com/auth0/go-auth0/v3/management/option"
)
func do() {
mgmt, err := client.New(
"{YOUR_DOMAIN}",
option.WithToken(
"<token>",
),
)
if err != nil {
return
}
request := &management.AdvanceRampRequestContent{
TargetLevel: 1,
}
mgmt.Experimentation.Experiments.AdvanceRamp(
context.TODO(),
"id",
request,
)
}
# Ensure you're logged in: auth0 login
auth0 api post "experimentation/experiments/id/advance-ramp" --data '{
"target_level": 1
}'using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Experimentation;
public partial class Examples
{
public async Task Example() {
var client = new ManagementApiClient(
token: "<token>",
clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
);
await client.Experimentation.Experiments.AdvanceRampAsync(
id: "id",
request: new AdvanceRampRequestContent {
TargetLevel = 1
}
);
}
}
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.experimentation.types.AdvanceRampRequestContent;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.experimentation().experiments().advanceRamp(
"id",
AdvanceRampRequestContent
.builder()
.targetLevel(1)
.build()
);
}
}<?php
namespace Example;
use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Experimentation\Experiments\Requests\AdvanceRampRequestContent;
$client = new ManagementClient(new ManagementClientOptions(
domain: '{YOUR_DOMAIN}',
token: '<token>',
));
$client->experimentation->experiments->advanceRamp(
'id',
new AdvanceRampRequestContent([
'targetLevel' => 1,
]),
);
from auth0.management import ManagementClient
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.experimentation.experiments.advance_ramp(
id="id",
target_level=1,
)
require "auth0"
client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")
client.experimentation.experiments.advance_ramp(
id: "id",
target_level: 1
)
curl --request POST \
--url https://{tenantDomain}/api/v2/experimentation/experiments/{id}/advance-ramp \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"target_level": 50
}
'{
"experiment_id": "<string>",
"from_level": 123,
"to_level": 123,
"current_level": 123
}Authorizations
bearerAuthoAuth2ClientCredentials
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the experiment to advance.
Body
application/jsonapplication/x-www-form-urlencoded
The target rollout level to advance to.
The target percentage level from the experiment schedule. Must be the immediate next level.
Required range:
0 <= x <= 100