Sign in

v1

latestOpenAPI 3.1.02026-07-1382339.6 KB
Configuration
Configuration

Get Rate Limit Configuration

Retrieve the rate limit configuration for a specific client, agency, and environment combination. The triple (ClientId, AgencyId, Env) uniquely identifies one ClientMapping row on SB/PROD. On QA/IMPL (single HHA mirror), the resolved mapping may use a different stored Env than the query parameter; see response Data.Env. Returns the per-second or per-minute request limit stored on that mapping. Falls back to application defaults (50 / Minute) when no explicit configuration has been saved.

get/v1/rate-limits/config

Query parameters

ClientIdstring nullable

FHIR client UUID (required). Example: 9b2f1a6e-3c84-4d8e-9b8a-7e2c9f2a1c45

FHIR client UUID (required). Example: 9b2f1a6e-3c84-4d8e-9b8a-7e2c9f2a1c45

AgencyIdstring nullable

Agency (vendor) identifier — required; must be a positive integer

Agency (vendor) identifier — required; must be a positive integer

Envstring nullable

HHA environment (required): app, app2, or cloud

HHA environment (required): app, app2, or cloud

Response

Successful Response

Messagestring required

Response message

Example response

{
  "Data": {
    "Agency": {
      "AgencyId": 123,
      "RateLimit": 50
    },
    "ClientId": "9b2f1a6e-3c84-4d8e-9b8a-7e2c9f2a1c45",
    "ClientMappingId": 10123,
    "Env": "app",
    "RateLimitWindow": "Minute"
  },
  "Message": "Rate limiting configuration fetched successfully"
}