Getting startedGuidesReferenceChangelog
Apoxy:// Docs / Reference / RateLimitPolicy

RateLimitPolicy

API reference for Rate Limit Policies (clrk.apoxy.dev/v1alpha1)

API Group: clrk.apoxy.dev/v1alpha1

Operations

List RateLimitPolicy

GET/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/ratelimitpolicies

List RateLimitPolicy

Response

  • 200: OK

List RateLimitPolicy

GET/apis/clrk.apoxy.dev/v1alpha1/ratelimitpolicies

List RateLimitPolicy

Response

  • 200: OK

Create RateLimitPolicy

POST/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/ratelimitpolicies

Create a RateLimitPolicy

Request Body

Spec fields (RateLimitSpec):

FieldTypeDescription
requestsinteger (int32)(required)
scopestring
windowstring(required)

Response

  • 200: OK
  • 201: Created
  • 202: Accepted

Delete All RateLimitPolicy

DELETE/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/ratelimitpolicies

Delete collection of RateLimitPolicy

Response

  • 200: OK

Get RateLimitPolicy

GET/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/ratelimitpolicies/{name}

Get the specified RateLimitPolicy

Response

  • 200: OK

Replace RateLimitPolicy

PUT/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/ratelimitpolicies/{name}

Replace the specified RateLimitPolicy

Request Body

Spec fields (RateLimitSpec):

FieldTypeDescription
requestsinteger (int32)(required)
scopestring
windowstring(required)

Response

  • 200: OK
  • 201: Created

Update RateLimitPolicy

PATCH/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/ratelimitpolicies/{name}

Partially update the specified RateLimitPolicy

Response

  • 200: OK
  • 201: Created

Delete RateLimitPolicy

DELETE/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/ratelimitpolicies/{name}

Delete a RateLimitPolicy

Response

  • 200: OK
  • 202: Accepted