Skip to content

Implement rate-limiting countermeasures #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jan-Hendrik Peters (nyanhp) wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Implement rate-limiting countermeasures #30

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39fa05b
Implement rate-limiting antimeasures
nyanhp Oct 26, 2026
e860192
Potential fix for pull request finding 'Handle X-RateLimit-NearLimit …
nyanhp Oct 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/functions/public/API/Invoke-ConfluenceRestMethod.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,29 @@ function Invoke-ConfluenceRestMethod {
}
}


# Requests are near rate limit or have surpassed the rate limit.
# Atlassian documents several response headers, https://developer.atlassian.com/cloud/confluence/rate-limiting/#rate-limit-related-headers
if (($responseHeaders['X-RateLimit-NearLimit'] | Select-Object -First 1) -eq 'true') {
# Less than 20% quota remains, wait 500ms pre-emptively
Write-Debug 'Requests are close to rate-limiting. Sleeping for 500ms.'
Start-Sleep -Milliseconds 500
}

if ($statusCode -eq 429) {
Write-Debug "Requests have been throttled. Sleeping for $($responseHeaders['Retry-After']) seconds"

# During testing, this header was always returned as an array
if ($responseHeaders['Retry-After'] -is [array]) {
Start-Sleep -Seconds ($responseHeaders['Retry-After'] | Select-Object -First 1)
} else {
Start-Sleep -Seconds $responseHeaders['Retry-After']
}

# Retry throttled request
$response = Invoke-RestMethod @request -Debug:$false
}

if ($statusCode -ge 400) {
$detail = if ($null -eq $response) {
''
Expand Down