Skip to main content

Get a strategy definition

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

Authorization

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

Retrieves the definition of the strategy specified in the URL

Request

Path Parameters

  • name string required
Responses

strategySchema

Schema
  • 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
  • ]

Authorization

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

Request

Base URL
<your-unleash-url>
Security Scheme
apiKey
name — path required
curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'