Get all strategies

GET /api/admin/strategies

Retrieves all strategy types (predefined and custom strategies) that are defined on this Unleash instance.

Request

Responses

• 200
• 401

---

strategiesSchema

application/json

Schema

Schema

• version integer required

  Possible values: [1]

  Version of the strategies schema

• strategies object[]required

  List of strategies

  Array [

  title string nullable

  An optional title for the strategy

  name string required

  The name (type) of the strategy

  displayName string nullable required

  A human friendly name for the strategy

  description string nullable required

  A short description of the strategy

  editable boolean required

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

  deprecated boolean required

  parameters object[]required

  A list of relevant parameters for each strategy

  Array [

  name string

  type string

  description string

  required boolean

  ]

  ]

Example (from schema)

{
  "version": 1,
  "strategies": [
    {
      "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
        }
      ]
    }
  ]
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

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

Loading...