Get a flow-control key

Returns 404 for a key outside the calling credential’s environment.

GET/api/v2/flow-control/{flowControlKeyId}

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.

Path parameters

flowControlKeyIdstringrequired

Public flow-control key identifier.

matches ^fck_

Header parameters

X-Request-Idstring

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

max length 128

Responses

200

Flow-control configuration and live counts returned.

successbooleanrequired

Allowed:true

dataFlowControlKeyrequired

Show properties

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

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

404

Not Found - Resource does not exist

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.flowControlKeyIdpath*Public flow-control key identifier.

Request

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

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

import requests

response = requests.get(
    "https://api.anlyon.com/api/v2/flow-control/string",
    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"
  }
}

{
  "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": "NOT_FOUND",
    "message": "Resource not found"
  }
}

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