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
- 200
- 401
- 404
strategySchema
- application/json
- Schema
- Example (from schema)
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
{
"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
- Example (from 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.
{
"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."
}
The requested resource was not found.
- application/json
- Schema
- Example (from 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.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NotFoundError",
"message": "Could not find the addon with ID \"12345\"."
}
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Request
Request
curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
python / requests
curl -L -X GET '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
go / native
curl -L -X GET '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
nodejs / native
curl -L -X GET '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
ruby / Net::HTTP
curl -L -X GET '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
csharp / httpclient
curl -L -X GET '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
php / cURL
curl -L -X GET '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
java / OkHttp
curl -L -X GET '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
powershell / RestMethod
curl -L -X GET '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'