List flags
client.flagship.apps.flags.list(stringappId, FlagListParams { account_id, cursor, limit } params, RequestOptionsoptions?): CursorPaginationAfter<FlagListResponse { default_variation, enabled, key, 6 more } >
GET/accounts/{account_id}/flagship/apps/{app_id}/flags
Lists an app’s flags ordered by key. Pass cursor from result_info to page forward; a null cursor indicates the last page.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
List flags
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const flagListResponse of client.flagship.apps.flags.list('app_id', {
account_id: 'account_id',
})) {
console.log(flagListResponse.default_variation);
}{
"errors": [
{
"message": "message"
}
],
"messages": [
{
"message": "message"
}
],
"result": [
{
"default_variation": "x",
"enabled": true,
"key": "x",
"rules": [
{
"conditions": [
{
"attribute": "x",
"operator": "equals",
"value": {}
}
],
"priority": 1,
"serve_variation": "x",
"rollout": {
"percentage": 0,
"attribute": "x"
}
}
],
"variations": {
"foo": "string"
},
"description": "description",
"type": "boolean",
"updated_at": "updated_at",
"updated_by": "updated_by"
}
],
"result_info": {
"count": 0,
"cursor": "cursor"
},
"success": true
}Returns Examples
{
"errors": [
{
"message": "message"
}
],
"messages": [
{
"message": "message"
}
],
"result": [
{
"default_variation": "x",
"enabled": true,
"key": "x",
"rules": [
{
"conditions": [
{
"attribute": "x",
"operator": "equals",
"value": {}
}
],
"priority": 1,
"serve_variation": "x",
"rollout": {
"percentage": 0,
"attribute": "x"
}
}
],
"variations": {
"foo": "string"
},
"description": "description",
"type": "boolean",
"updated_at": "updated_at",
"updated_by": "updated_by"
}
],
"result_info": {
"count": 0,
"cursor": "cursor"
},
"success": true
}