Update elimination bucket

POST /elimination.EliminationAnalyser/UpdateEliminationBucket

Description

Update the elimination bucket for an entity.

Example request

cURL

curl --request POST \
  --url https://api.example.com/elimination.EliminationAnalyser/UpdateEliminationBucket \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-profile-id: <x-profile-id>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "id": "merchant1",
  "params": "card",
  "labels_with_bucket_name": [
    {
      "label": "stripe",
      "bucket_name": "bucket1"
    }
  ],
  "config": {
    "bucket_size": 5,
    "bucket_leak_interval_in_secs": 10
  }
}
'

Example response

200

{
  "status": "BUCKET_UPDATION_SUCCEEDED"
}

Headers

• x-tenant-id (string) — required

• x-profile-id (string) — required

• x-api-key (string) — required

Body (application/json)

• id (string) — required

  • Entity identifier

  • Example: "merchant1"

• labels_with_bucket_name (object[]) — required

  • Example:

    [
      {
        "label": "stripe",
        "bucket_name": "processor_decline"
      }
    ]

• config (object) — required

• params (string) — optional additional parameters

  • Example: "card"

Response (200 application/json)

• status (enum) — required

  • Status of the update operation. Available options: BUCKET_UPDATION_SUCCEEDED, BUCKET_UPDATION_FAILED

Links

• Documentation: https://api-reference.hyperswitch.io/introduction

• Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview

• Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview

• Source edit: https://github.com/juspay/hyperswitch/edit/main/api-reference/intelligent-router-api-reference/elimination/update-elimination-bucket.mdx

• Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/intelligent-router-api-reference/elimination/update-elimination-bucket

Related:

• Fetch eliminated processor list: https://api-reference.hyperswitch.io/intelligent-router-api-reference/elimination/fetch-eliminated-processor-list

• Invalidate elimination bucket: https://api-reference.hyperswitch.io/intelligent-router-api-reference/elimination/invalidate-elimination-bucket