List flow-control keys

Lists only keys in the calling credential’s environment.

GET/api/v2/flow-control

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Query parameters

searchstring

pageinteger

Page number for pagination

min 1 · default: 1

limitinteger

Number of items per page

min 1 · max 100 · default: 20

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Responses

200

Flow-control keys and live counts returned with page pagination.

successbooleanrequired

Allowed:true

dataFlowControlKey[]required

Show properties

Array of FlowControlKey

flowControlKeyIdstringrequired

matches ^fck_

keystringrequired

rateLimitinteger | nullrequired

min 1

rateLimitWindowinteger | nullrequired

min 1

parallelisminteger | nullrequired

min 1

isPausedbooleanrequired

isPinnedbooleanrequired

activeCountintegerrequired

Live Redis count.

min 0

waitlistCountintegerrequired

Live Redis count.

min 0

createdAtstring<date-time>required

updatedAtstring<date-time>required

paginationOffsetPaginationrequired

Show properties

totalintegerrequired

min 0

pageintegerrequired

min 1

limitintegerrequired

min 1

totalPagesintegerrequired

min 0

hasMorebooleanrequired

400

Bad Request - Invalid input data

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

429

Too Many Requests - Rate limit exceeded

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.searchquerypagequeryPage number for paginationlimitqueryNumber of items per page

Request

curl -X GET 'https://api.anlyon.com/api/v2/flow-control' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.anlyon.com/api/v2/flow-control", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.anlyon.com/api/v2/flow-control",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": [
    {
      "flowControlKeyId": "string",
      "key": "string",
      "rateLimit": 1,
      "rateLimitWindow": 1,
      "parallelism": 1,
      "isPaused": true,
      "isPinned": true,
      "activeCount": 0,
      "waitlistCount": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "total": 0,
    "page": 1,
    "limit": 1,
    "totalPages": 0,
    "hasMore": true
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {
      "url": "Invalid URL format"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later."
  }
}