Get a strategy definition

GET 
/api/admin/strategies/:name

Retrieves the definition of the strategy specified in the URL

Request

Path Parameters

name stringrequired

Responses

200

strategySchema

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 (from schema)

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

404

The requested resource was not found.

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: NotFoundError
message string
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...