The API reference is not available right now

This instance could not load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such operation

This instance does not document an operation under that identifier. It may have been renamed, or it may belong to a feature this installation does not have enabled.

Back to the API reference

API reference RateLimitRule

Rate Limit Rules: retrieves a continuation-token paged list of rules.

GET /api/rate-limiting/rules/continuation deprecated

Requires: RateLimiting.Rules, merchant scope.

**Required permissions**: `RateLimiting.Rules` **Scope**: merchant

Parameters

Name In Type Description
ProfileId required query string (uuid) Scope to a single profile.
Algorithm required query WinkPGRateLimitingAbstractionsRateLimitAlgorithm Scope to a single algorithm override.
IsActive required query boolean Scope to active or inactive rules.
Filter.Logic required query PhoenixAbpCoreDataFilteringFilterLogic
Filter.Rules required query array of PhoenixAbpCoreDataFilteringFilterRule
Filter.Groups required query array of PhoenixAbpCoreDataFilteringFilterGroup
MaxResultCount required query integer (int32) Page size.
ContinuationToken required query string Cosmos continuation token for the next page.
Sorting.Field required query string
Sorting.Descending required query boolean
MaxCreationTime required query string (date-time) Upper bound on creation time.
MinCreationTime required query string (date-time) Lower bound on creation time.
MaxModifitionTime required query string (date-time) Upper bound on last modification time.
MinModifitionTime required query string (date-time) Lower bound on last modification time.
IncludeDeleted required query boolean Include soft-deleted rows, so a deleted rule can be restored from the grid.
IncludeInactive required query boolean Include rows the platform marks inactive.
suppressNulls required query boolean If true, omit properties with null values.

Request body

application/json , required

Field Type Description

This request body has no documented fields.

Responses

200 OK

Field Type Description

This response has no documented body fields.

403 Forbidden

Field Type Description

This response has no documented body fields.

401 Unauthorized

Field Type Description

This response has no documented body fields.

400 Bad Request

Field Type Description

This response has no documented body fields.

404 Not Found

Field Type Description

This response has no documented body fields.

501 Not Implemented

Field Type Description

This response has no documented body fields.

500 Internal Server Error

Field Type Description

This response has no documented body fields.

default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

Field Type Description

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by

Authentication