[BETA] Disables an action set. | Unleash Documentation

curl -X POST https://app.unleash-instance.example.com/api/admin/projects/projectId/actions/id/off \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": 42,
  "project": "enterprise-project",
  "createdAt": "2024-05-10T09:15:00+02:00",
  "createdByUserId": 7,
  "name": "Disable Beta Features",
  "actorId": 15,
  "actions": [
    {
      "id": 101,
      "createdAt": "2024-05-10T09:15:00+02:00",
      "createdByUserId": 7,
      "action": "disable-feature",
      "sortOrder": 1,
      "executionParams": {
        "featureName": "beta-dashboard"
      }
    }
  ],
  "match": {
    "source": "signal-endpoint",
    "sourceId": 987,
    "payload": {
      "type": "error-rate-above-threshold"
    }
  },
  "description": "Disables beta features when error rate exceeds 5%",
  "enabled": false
}

Enterprise feature

[BETA] This API is in beta state, which means it may change or be removed in the future.

Disables an existing action set, identified by its id.

curl -X POST https://app.unleash-instance.example.com/api/admin/projects/projectId/actions/id/off \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": 42,
  "project": "enterprise-project",
  "createdAt": "2024-05-10T09:15:00+02:00",
  "createdByUserId": 7,
  "name": "Disable Beta Features",
  "actorId": 15,
  "actions": [
    {
      "id": 101,
      "createdAt": "2024-05-10T09:15:00+02:00",
      "createdByUserId": 7,
      "action": "disable-feature",
      "sortOrder": 1,
      "executionParams": {
        "featureName": "beta-dashboard"
      }
    }
  ],
  "match": {
    "source": "signal-endpoint",
    "sourceId": 987,
    "payload": {
      "type": "error-rate-above-threshold"
    }
  },
  "description": "Disables beta features when error rate exceeds 5%",
  "enabled": false
}

Enterprise feature

[BETA] This API is in beta state, which means it may change or be removed in the future.

Disables an existing action set, identified by its id.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

projectIdstringRequired

idstringRequired

Response

#/components/schemas/actionsSchema

idinteger>=1

The ID of the action set.

projectstring

The project that this action set belongs to.

createdAtstringformat: "date-time"

The date and time of when the action set was created.

createdByUserIdinteger

The ID of the user that created this action set.

namestring

The name of the action set

actorIdinteger>=1

The id of the service account that will execute the action

actionslist of objects

The list of actions to execute in sequential order when the action set is triggered.

matchobject

Defines a matching rule for the signal that will trigger the action set

descriptionstring or null

The description of the action set

enabledbooleanDefaults to true

Whether this action set is enabled or not

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

$	curl -X POST https://app.unleash-instance.example.com/api/admin/projects/projectId/actions/id/off \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": 42,
3	"project": "enterprise-project",
4	"createdAt": "2024-05-10T09:15:00+02:00",
5	"createdByUserId": 7,
6	"name": "Disable Beta Features",
7	"actorId": 15,
8	"actions": [
9	{
10	"id": 101,
11	"createdAt": "2024-05-10T09:15:00+02:00",
12	"createdByUserId": 7,
13	"action": "disable-feature",
14	"sortOrder": 1,
15	"executionParams": {
16	"featureName": "beta-dashboard"
17	}
18	}
19	],
20	"match": {
21	"source": "signal-endpoint",
22	"sourceId": 987,
23	"payload": {
24	"type": "error-rate-above-threshold"
25	}
26	},
27	"description": "Disables beta features when error rate exceeds 5%",
28	"enabled": false
29	}