Skip to main content

Get a strategy definition

GET 

<your-unleash-url>/api/admin/strategies/:name

Retrieves the definition of the strategy specified in the URL

Request

Path Parameters

    name stringrequired

Responses

strategySchema

Schema
    titlestringnullable

    An optional title for the strategy

    Example: GradualRollout - Prod25
    namestringrequired

    The name (type) of the strategy

    Example: flexibleRollout
    displayNamestringnullablerequired

    A human friendly name for the strategy

    Example: Gradual Rollout
    descriptionstringnullablerequired

    A short description of the strategy

    Example: Gradual rollout to logged in users
    editablebooleanrequired

    Whether the strategy can be edited or not. Strategies bundled with Unleash cannot be edited.

    Example: true
    deprecatedbooleanrequired
    Example: true
    parameters object[]required

    A list of relevant parameters for each strategy

  • Array [
  • namestring
    Example: percentage
    typestring
    Example: percentage
    descriptionstring
    Example: Gradual rollout to logged in users
    requiredboolean
    Example: true
  • ]

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
curl -L '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'
Request Collapse all
Base URL
<your-unleash-url>
Auth
Parameters
— pathrequired
ResponseClear

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