Ana içeriğe geç

Add Credentials to RLCL

Retired — always returns 400

This endpoint is retired. Every call now returns 400 Bad Request with resultMessage naming the retirement (error key credentialRateLimit.retired) — nothing is changed, regardless of the request body. Existing lists were migrated to typed Limit Plans and assignments at upgrade; see Legacy Limits Migrated at Upgrade. Manage limits from the Limits screen instead. List RLCLs, Get RLCL, and Delete RLCL are unaffected. The rest of this page documents the retired behavior for historical reference.

Endpoint​

POST /apiops/projects/{projectName}/rlcl/{rlclName}/credentials/

Authentication​

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request​

Headers​

HeaderValueRequired
AuthorizationBearer {token}Yes
Content-Typeapplication/jsonYes

Path Parameters​

ParameterTypeRequiredDescription
projectNamestringYesProject name
rlclNamestringYesRLCL name

Request Body​

Full JSON Body Example - Single Credential​

{
"credentialNameList": [
"api-user"
]
}

Full JSON Body Example - Multiple Credentials​

{
"credentialNameList": [
"api-user-1",
"api-user-2",
"premium-user"
]
}

Request Body Fields​

FieldTypeRequiredDefaultDescription
credentialNameListarray[string]Yes-List of consumer names (usernames) to add

Notes​

  • credentialNameList must not be empty
  • Consumer names must exist in the project
  • Duplicate consumers are ignored (not added twice)
  • Consumers are added to the existing list

Response​

Success Response (200 OK)​

{
"status": "SUCCESS",
"deploymentResult": {
"success": true
}
}

Error Response (400 Bad Request)​

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

or

{
"status": "FAILURE",
"resultMessage": "Credential with name (api-user) is not found in project!"
}

cURL Example​

curl -X POST \
"https://demo.apinizer.com/apiops/projects/MyProject/rlcl/PremiumUserRLCL/credentials/" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"credentialNameList": [
"api-user-1",
"api-user-2"
]
}'

Permissions​

  • User must have IDENTITY + MANAGE permission in the project

Notes and Warnings​

  • Consumer Names:
    • Use consumer usernames (not IDs)
    • Consumers must exist in the project
  • Duplicate Handling:
    • Duplicate consumers are ignored
    • No error is thrown for duplicates
  • RLCL Must Exist:
    • RLCL must exist before adding consumers