APapinizer
RLCL

Create an RLCL with metadata

RETIRED (APNZ-6652 R4): rate limit lists are no longer enforced by the gateway — they were migrated to typed limit plans and assignments at upgrade. This write operation now answers 400 with errorKey credentialRateLimit.retired. Original: Creates an RLCL with metadata information

post/apiops/projects/{projectName}/rlcl/

Request

Path parameters

projectNamestring required

Request body

namestring
descriptionstring
enabledboolean
executionOrder'BEFORE_PROXY_GROUP' | 'AFTER_PROXY_GROUP' | 'BEFORE_API_PROXY' | 'AFTER_API_PROXY' | 'BEFORE_API_METHOD' | 'AFTER_API_METHOD' | 'FIRST' | 'LAST'
cacheConnectionTimeoutInSecondsinteger
cacheErrorHandlingType'FAIL' | 'CONTINUE'
timeIntervalWindowType'FIXED' | 'SLIDING'
showRateLimitStatisticsInResponseHeaderboolean
identitySource'VARIABLE' | 'AUTH_RESOLVED'

Identity source: VARIABLE (resolve from targetVariable) or AUTH_RESOLVED (use the username/key resolved by the authentication policy). When AUTH_RESOLVED, executionOrder is forced to LAST and targetVariable is ignored.

outOfTargetAction'BLOCK' | 'GENERAL_QUOTA' | 'NONE'

Behaviour for requests outside the target audience: BLOCK (reject), GENERAL_QUOTA (apply the general quota below) or NONE (the rule does not apply to them - neither blocked nor counted). Omitted defaults to BLOCK.

generalQuotaMode'TOTAL' | 'PER_IDENTITY'

General quota mode (when outOfTargetAction=GENERAL_QUOTA): TOTAL (single shared counter) or PER_IDENTITY (per identity counter).

generalQuotaPermittedMessageCountinteger

Permitted message count for the general quota (required when outOfTargetAction=GENERAL_QUOTA).

generalQuotaTimeIntervalPeriodLengthinteger

Time interval period length for the general quota (required when outOfTargetAction=GENERAL_QUOTA).

generalQuotaTimeInterval'ONE_SECOND' | 'ONE_MINUTE' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_MONTH'

Time interval unit for the general quota (required when outOfTargetAction=GENERAL_QUOTA).

Response

successful operation!

status'SUCCESS' | 'FAILURE'
resultMessagestring
resultListstring[]
resultCountinteger
unresolvedReferencesstring[]

Changes

No recorded changes to this operation across all 21 revisions of this API.