Create a strategy

POST 
<your-unleash-url>/api/admin/strategies

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Creates a custom strategy type based on the supplied data. Custom strategies are deprecated and should not be used. Prefer using built in strategies with constraints instead.

Request

application/json

Bodyrequired

createStrategySchema

name stringrequired
The name of the strategy type. Must be unique.
Example: my-custom-strategy
title string
The title of the strategy
Example: My awesome strategy
description string
A description of the strategy type.
Example: Enable the feature for users who have not logged in before.
editable boolean
Whether the strategy type is editable or not. Defaults to true.
Example: false
deprecated boolean
Whether the strategy type is deprecated or not. Defaults to false.
Example: true
parameters object[]required
The parameter list lets you pass arguments to your custom activation strategy. These will be made available to your custom strategy implementation.
Array [
name stringrequired
The name of the parameter
Example: Rollout percentage
type stringrequired
The type of the parameter
Possible values: [string, percentage, list, number, boolean]
Example: percentage
description string
A description of this strategy parameter. Use this to indicate to the users what the parameter does.
Example: How many percent of users should see this feature?
required boolean
Whether this parameter must be configured when using the strategy. Defaults to false
Example: false
]

Responses

201

The resource was successfully created.

Response Headers

• location string

  The location of the newly created resource.

application/json

Schema

Schema

title stringnullable
An optional title for the strategy
Example: GradualRollout - Prod25
name stringrequired
The name (type) of the strategy
Example: flexibleRollout
displayName stringnullablerequired
A human friendly name for the strategy
Example: Gradual Rollout
description stringnullablerequired
A short description of the strategy
Example: Gradual rollout to logged in users
editable booleanrequired
Whether the strategy can be edited or not. Strategies bundled with Unleash cannot be edited.
Example: true
deprecated booleanrequired
Example: true
parameters object[]required
A list of relevant parameters for each strategy
Array [
name string
Example: percentage
type string
Example: percentage
description string
Example: Gradual rollout to logged in users
required boolean
Example: true
]

Example (auto)

{
  "title": "GradualRollout - Prod25",
  "name": "flexibleRollout",
  "displayName": "Gradual Rollout",
  "description": "Gradual rollout to logged in users",
  "editable": true,
  "deprecated": true,
  "parameters": [
    {
      "name": "percentage",
      "type": "percentage",
      "description": "Gradual rollout to logged in users",
      "required": true
    }
  ]
}

401

Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

409

The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NameExistsError
message string
A description of what went wrong.
Example: There is already a feature called "my-awesome-feature".

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NameExistsError",
  "message": "There is already a feature called \"my-awesome-feature\"."
}

415

The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ContentTypeerror
message string
A description of what went wrong.
Example: We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ContentTypeerror",
  "message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/strategies' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
-d '{
  "name": "my-custom-strategy",
  "title": "My awesome strategy",
  "description": "Enable the feature for users who have not logged in before.",
  "editable": false,
  "deprecated": true,
  "parameters": [
    {
      "name": "Rollout percentage",
      "type": "percentage",
      "description": "How many percent of users should see this feature?",
      "required": false
    }
  ]
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Body required

{
  "name": "my-custom-strategy",
  "title": "My awesome strategy",
  "description": "Enable the feature for users who have not logged in before.",
  "editable": false,
  "deprecated": true,
  "parameters": [
    {
      "name": "Rollout percentage",
      "type": "percentage",
      "description": "How many percent of users should see this feature?",
      "required": false
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!