RateLimiting

Get a rate limiting policy by ID.

get/ratelimitingpolicies/{id}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/ratelimitingpolicies/{id}
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

idstring required

ID of the rate limiting policy.

Response

A Rate Limiting Policy

AuditModeboolean required

When enabled, the policy logs requests that would be rate limited without rejecting them (no 429 response).

BurstLimitinteger required

Maximum capacity of the token bucket.

Idstring required

The ID of this policy.

IsBuiltInboolean required

Whether this is a built-in policy that cannot be deleted or have its name or scope changed.

IsEnabledboolean required

Whether this policy is actively enforced.

Namestring required

The display name of this policy.

RequestsPerMinuteinteger required

Number of requests permitted per minute.

ScopeTypestring required

The scope this policy applies to.

Example response

{
  "BurstLimit": 200,
  "Id": "RateLimitingPolicies-1",
  "Name": "Authenticated requests",
  "RequestsPerMinute": 600,
  "ScopeType": "AuthenticatedHuman"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.