Get RLCL

Endpoint

GET /apiops/projects/{projectName}/rlcl/{rlclName}/

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
rlclName	string	Yes	RLCL name

Response

Success Response (200 OK)

The requested RLCL is returned as the single element of resultList.

{
  "status": "SUCCESS",
  "resultList": [
    {
      "name": "PartnerLimits",
      "description": "Rate limits for partner credentials",
      "enabled": true,
      "executionOrder": "BEFORE_API_PROXY",
      "cacheConnectionTimeoutInSeconds": 3,
      "cacheErrorHandlingType": "FAIL",
      "timeIntervalWindowType": "FIXED",
      "showRateLimitStatisticsInResponseHeader": false,
      "identitySource": "AUTH_RESOLVED",
      "targetVariable": null,
      "targetAudienceRuleList": [
        {
          "operator": "EQ",
          "value": "partner-app"
        }
      ],
      "outOfTargetAction": "GENERAL_QUOTA",
      "generalQuotaMode": "TOTAL",
      "generalQuotaPermittedMessageCount": 1000,
      "generalQuotaTimeIntervalPeriodLength": 1,
      "generalQuotaTimeInterval": "ONE_HOUR",
      "credentialNameList": [
        "partner-user"
      ],
      "endpointRateLimitList": [
        {
          "apiProxyName": "PaymentAPI",
          "endpointId": "6690c1f2e4b0a1c2d3e4f5a6",
          "endpointName": "createPayment",
          "permittedMessageCount": 100,
          "timeIntervalPeriodLength": 1,
          "timeInterval": "ONE_MINUTE",
          "enabled": true
        }
      ],
      "condition": {
        "conditionRuleList": [
          {
            "conditionCriteria": "AND",
            "conditionRuleList": []
          }
        ]
      }
    }
  ],
  "resultCount": 1
}

Response Fields

Field	Type	Description
name	string	RLCL name
description	string	RLCL description, null when not set
enabled	boolean	Whether the RLCL is active
executionOrder	enum	BEFORE_API_PROXY, AFTER_API_METHOD, ... Forced to AFTER_API_METHOD when identitySource=AUTH_RESOLVED
cacheConnectionTimeoutInSeconds	integer	Cache connection timeout used while counting
cacheErrorHandlingType	enum	FAIL or IGNORE - behaviour when the cache is unreachable
timeIntervalWindowType	enum	FIXED or SLIDING
showRateLimitStatisticsInResponseHeader	boolean	Whether rate limit statistics are added to response headers
identitySource	enum	VARIABLE (resolved from targetVariable) or AUTH_RESOLVED (username/key resolved by the authentication policy)
targetVariable	object	Variable definition used to resolve the identity; null when identitySource=AUTH_RESOLVED
targetAudienceRuleList	array[object]	Operator + value rules evaluated with OR semantics against the resolved identity
outOfTargetAction	enum	BLOCK or GENERAL_QUOTA - behaviour for requests outside the target audience
generalQuotaMode	enum	TOTAL or PER_IDENTITY
generalQuotaPermittedMessageCount	integer	Permitted message count for the general quota
generalQuotaTimeIntervalPeriodLength	integer	Time interval period length for the general quota
generalQuotaTimeInterval	enum	Time interval unit for the general quota
credentialNameList	array[string]	Usernames of the credentials attached to this RLCL. Attachments whose credential no longer exists are omitted, so the list can be sent back as-is to the credential add/update endpoints
endpointRateLimitList	array[object]	Endpoint rate limits defined in this RLCL, addressed by apiProxyName + endpointName
condition	object	Condition of the RLCL

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "RLCL (PartnerLimits) is not found!"
}

or

{
  "status": "FAILURE",
  "resultMessage": "rlclName value can not be empty!"
}

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/rlcl/PartnerLimits/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notes and Warnings

• Round-trip friendly: The returned shape mirrors what the create and update endpoints accept, so a GET result can be edited and sent back. Endpoint rate limits carry apiProxyName (not the internal API proxy ID) exactly like the Update Endpoints body expects
• apiProxyName resolution: When an endpoint rate limit points to an API proxy that no longer exists, apiProxyName comes back as null while the rest of the entry is still returned
• Read-only: This endpoint does not modify anything and does not trigger a deployment

Permissions

• User must have IDENTITY + VIEW permission in the project

Related Documentation

• List RLCLs - List all RLCLs of a project
• Update RLCL - Update an existing RLCL configuration
• Update Endpoints - Manage endpoint rate limits of an RLCL
• Add Credentials - Attach credentials to an RLCL