Strategies

Get a strategy definition

Retrieves the definition of the strategy specified in the URL

get/api/admin/strategies/{name}

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/strategies/{name}
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

namestring required

Response

strategySchema

titlestring nullable

An optional title for the strategy

namestring required

The name (type) of the strategy

displayNamestring nullable required

A human friendly name for the strategy

descriptionstring nullable required

A short description of the strategy

editableboolean required

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

deprecatedboolean required

Example response

{
  "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
    }
  ]
}

Changes

No recorded changes to this operation across all 7 revisions of this API.