Skip to main content

View sensitive paths

GET/api/projects/{projectId}/sensitive-paths
Signed-in memberRead-only

A Project can add its own patterns to this baseline, for example **/billing/**, but can never remove any of it. Follow Sensitive paths on a Project's card, or call GET /api/projects/{projectId}/sensitive-paths, which returns the baseline, the Project's additions, the effective list, and who last changed it. Every member can read them; only administrators change them, one pattern per line on the page or with PUT /api/projects/{projectId}/sensitive-paths and {"additions": [...]}. Patterns are trimmed, and blank lines and repeats are dropped. A Project can add at most 100 patterns of at most 256 characters; a pattern that does not compile, or too many or too long ones, return 400 invalid_sensitive_paths. New patterns apply to changes classified afterwards, including an AI retry; changes already classified keep their triggers. See ADR-0014.

Read more: Sensitive pathsSource: SensitivePathApiController#view(opens in new tab)

Path parameters​

NameTypeRequiredNotes
projectIdstring (uuid)Required

Response​

Success: 200

FieldTypeRequiredNotes
projectIdstring (uuid)Optional
baselinearray of stringOptional
additionsarray of stringOptional
effectivearray of stringOptional
updatedBystringOptional
updatedAtstring (date-time)Optional

Errors​

StatusCodeApplies to
400validation_faileda field is missing or out of rangeAny endpoint
400invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUIDAny endpoint
401authentication_requiredno sessionAny endpoint
404not_foundno such addressAny endpoint
405method_not_allowedthe address does not take that methodAny endpoint
415unsupported_media_typethe address does not read a body of that typeAny endpoint
500internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind itAny endpoint
400invalid_change_filterChanges area
400invalid_change_reviewChanges area
400invalid_sensitive_pathsChanges area
404change_not_foundChanges area
404duplicate_candidate_not_foundChanges area
409change_processingChanges area
409change_not_eligible_for_aiChanges area
409duplicate_candidate_decidedChanges area
409change_excludedChanges area
409change_in_releaseChanges area
502ai_classification_failedChanges area
503ai_classification_unavailableChanges area
404category_not_foundCategories area
404category_suggestion_not_foundCategories area
409category_code_takenCategories area
409category_systemCategories area
409category_suggestion_decidedCategories area

Request

bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
curl "http://localhost:8080/api/projects/$PROJECT_ID/sensitive-paths" \
-b cookies.txt -c cookies.txt

Response

200

Example

{
  "projectId": "<uuid>",
  "baseline": [
    "<string>"
  ],
  "additions": [
    "<string>"
  ],
  "effective": [
    "<string>"
  ],
  "updatedBy": "<string>",
  "updatedAt": "<date-time>"
}