Website Audit
Review Website Audit evidence
Last updated 30 October 2026
post
/v1/website-audit/scans/{scanId}/reviewReviews an unidentified observation through its evidenceId. Supports dismiss, mark_as_ours and report_vendor under the Dashboard rules. Requires projects.read and website-audit.write and an organization admin or owner. New public writes are gated by rollout-agent-access-writes, default false.
Authentication
- bearerAuth
bearerAuth: http / bearer — Use an Inth API key or OAuth access token in the Authorization header. Product operations need a capability. Feedback intake only requires authentication. An OAuth access token carries the capabilities it was granted as scopes; an organization API key carries a fixed set (`organizations.read`, `projects.read`, `projects.write`, `api-keys.read`, `inbox.read`, `billing.read`), so writes that name the person who made them, such as `inbox.write` and `vendors.write`, need a user token. A credential without the capability an operation needs is answered with `403 INSUFFICIENT_SCOPE`. `GET /v1/me` reports the capabilities of the calling credential. OAuth scopes: - `organizations.read`: List the organizations you belong to. - `organizations.write`: Create organizations you will own. - `projects.read`: Read projects, their consent configuration, and the vendors seen on them. - `projects.write`: Create, update, and delete projects and their consent configuration. - `members.read`: Read member names, email addresses, profile images, roles, and pending invitation email addresses. - `members.write`: Invite members, change member roles, remove members, and cancel invitations. - `api-keys.read`: List organization API keys. - `api-keys.write`: Create, roll, and delete organization API keys. - `code-audit.read`: Read Code Audit scans, their findings, and connected repositories. - `code-audit.write`: Start Code Audit scans and unlock their reports. - `inbox.read`: Read Inbox findings. - `inbox.write`: Change Inbox status or assignment and open GitHub issues for findings. - `vendors.write`: Approve or ignore vendors detected on your projects, which resolves their Inbox findings. - `billing.read`: Read the plan and credit balance of an organization. - `billing.details.read`: Read invoices, billing profiles, and payment method summaries for organizations you own. - `consent.read`: Read consent records, analytics, configuration, and runtime status. - `consent.write`: Update consent settings, translations, IAB configuration, and policies. - `consent.keys.read`: Read consent runtime key metadata. Secret values are never returned. - `website-audit.read`: Read website audit targets, scans, reports, cookies, and evidence. - `website-audit.write`: Manage website audit targets, verify domains, review findings, and start scans. - `account.read`: Read your account profile. - `notifications.read`: Read your notification preferences and organization routing. - `organization-retention.read`: Read organization provider data retention policy. - `support.read`: Read support conversations you own or can access through sharing. - `support.write`: Create support conversations, send messages, share or close them, and upload support attachments. - `consent.lifecycle.write`: Update, upgrade or delete Consent runtimes. - `consent.keys.write`: Create, rotate and revoke Consent runtime keys. - `billing.write`: Preview and change plans, buy credits, manage billing details and subscriptions, and open hosted payment flows. - `account.security.read`: Read your active browser sessions and connected device grants. - `account.security.write`: Revoke your browser sessions and connected device grants. - `integrations.read`: Read connected integration accounts, repositories, provider properties and project links. - `integrations.write`: Connect and sync providers, manage repository settings, project links and paid pull request monitoring. - `account.write`: Update your name, avatar and PII masking preference. - `account.delete`: Permanently delete your account after ownership checks and confirmation. - `notifications.write`: Update your notification preferences. - `notifications.routing.write`: Manage organization notification routing. - `organization-retention.write`: Change organization provider data retention policy. - `organizations.settings.write`: Update organization name, logo and slug. - `organizations.delete`: Permanently delete organizations you own after confirmation. - `agents.read`: Read your Inth Agent chats and chats shared with your organization. - `agents.write`: Start Inth Agent chats, send messages, share your chats with the organization, and delete your chats. Agent replies use organization credits.
Request
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
scanId | string | Required | — |
Required
Content type application/json
View JSON schema
{ "anyOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "dismiss" ] }, "evidenceId": { "type": "string", "minLength": 1 } }, "required": [ "action", "evidenceId" ], "additionalProperties": false }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "mark_as_ours" ] }, "evidenceId": { "type": "string", "minLength": 1 } }, "required": [ "action", "evidenceId" ], "additionalProperties": false }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "report_vendor" ] }, "evidenceId": { "type": "string", "minLength": 1 } }, "required": [ "action", "evidenceId" ], "additionalProperties": false } ] }
Responses
200
Success
Content type application/json
| Property | Type | Required | Description |
|---|---|---|---|
success | unknown | Required | — |
data | object | Required | — |
data.action | "dismiss" | "mark_as_ours" | "report_vendor" | Required | — |
data.domain | string | null | Required | — |
data.evidenceId | string | Required | — |
data.reviewItemId | string | null | Required | — |
data.snapshot | object | Required | — |
data.snapshot.collection | "website-scan-results" | Required | — |
data.snapshot.organizationId | string | Required | — |
data.snapshot.projectionVersion | 1 | Required | — |
data.snapshot.results | object | null | Required | — |
data.snapshot.scanId | string | Required | — |
View JSON schema
{ "type": "object", "required": [ "success", "data" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "dismiss", "mark_as_ours", "report_vendor" ] }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "evidenceId": { "type": "string" }, "reviewItemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "snapshot": { "type": "object", "properties": { "collection": { "type": "string", "enum": [ "website-scan-results" ] }, "organizationId": { "type": "string" }, "projectionVersion": { "type": "number", "enum": [ 1 ] }, "results": { "anyOf": [ { "type": "object", "properties": { "changes": { "type": "object", "properties": { "availability": { "type": "string", "enum": [ "available", "no_comparable_scan" ] }, "newVendors": { "type": "array", "items": { "type": "object", "properties": { "consentCategory": { "anyOf": [ { "type": "string", "enum": [ "necessary", "measurement", "marketing", "functionality", "experience" ] }, { "type": "null" } ] }, "name": { "type": "string" }, "vendorId": { "type": "string" } }, "required": [ "consentCategory", "name", "vendorId" ], "additionalProperties": false } }, "noLongerDetectedVendors": { "type": "array", "items": { "type": "object", "properties": { "consentCategory": { "anyOf": [ { "type": "string", "enum": [ "necessary", "measurement", "marketing", "functionality", "experience" ] }, { "type": "null" } ] }, "name": { "type": "string" }, "vendorId": { "type": "string" } }, "required": [ "consentCategory", "name", "vendorId" ], "additionalProperties": false } } }, "required": [ "availability", "newVendors", "noLongerDetectedVendors" ], "additionalProperties": false }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "consentScenario": { "type": "string", "enum": [ "pre_consent", "pre_consent_gpc", "accept_all", "reject_all", "accept_measurement_only", "accept_marketing_only" ] }, "key": { "type": "string" }, "regionProfile": { "type": "string", "enum": [ "uk_gdpr", "eu_eea_gdpr", "us_ca_cpra", "us_tx_baseline", "custom" ] }, "runId": { "type": "string" } }, "required": [ "consentScenario", "key", "regionProfile", "runId" ], "additionalProperties": false } }, "cookies": { "type": "array", "items": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "type": "object", "properties": { "consentScenario": { "type": "string", "enum": [ "pre_consent", "pre_consent_gpc", "accept_all", "reject_all", "accept_measurement_only", "accept_marketing_only" ] }, "key": { "type": "string" }, "regionProfile": { "type": "string", "enum": [ "uk_gdpr", "eu_eea_gdpr", "us_ca_cpra", "us_tx_baseline", "custom" ] }, "runId": { "type": "string" } }, "required": [ "consentScenario", "key", "regionProfile", "runId" ], "additionalProperties": false } }, "evidence": { "type": "array", "items": { "type": "object", "properties": { "evidenceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "key": { "type": "string" }, "kind": { "type": "string", "enum": [ "script", "cookie", "storage", "network", "global_object", "package", "iframe", "header" ] }, "observationId": { "type": "string" }, "observedAt": { "type": "string" }, "pagePath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "runId": { "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "evidenceId", "key", "kind", "observationId", "observedAt", "pagePath", "runId", "url", "value" ], "additionalProperties": false } }, "evidenceIds": { "type": "array", "items": { "type": "string" } }, "lastSeenAt": { "type": "string" }, "observationCount": { "type": "integer", "minimum": 0 }, "pagePaths": { "type": "array", "items": { "type": "string" } }, "attributes": { "type": "object", "properties": { "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "varies" ] }, { "type": "null" } ] }, "httpOnly": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "varies" ] }, { "type": "null" } ] }, "lifetime": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "varies" ] }, { "type": "null" } ] }, "sameSite": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "varies" ] }, { "type": "null" } ] }, "secure": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "varies" ] }, { "type": "null" } ] }, "session": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "varies" ] }, { "type": "null" } ] } }, "required": [ "expiresAt", "httpOnly", "lifetime", "sameSite", "secure", "session" ], "additionalProperties": false }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "name": { "type": "string" }, "party": { "type": "string", "enum": [ "first_party", "third_party", "unknown" ] }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "vendors": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "projectVendorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewState": { "type": "string", "enum": [ "accepted", "suggested", "rejected", "needs_review" ] }, "vendorId": { "type": "string" } }, "required": [ "name", "projectVendorId", "reviewState", "vendorId" ], "additionalProperties": false } } }, "required": [ "conditions", "evidence", "evidenceIds", "lastSeenAt", "observationCount", "pagePaths", "attributes", "domain", "id", "name", "party", "path", "vendors" ], "additionalProperties": false } }, "coverage": { "type": "object", "properties": { "absenceClaimEligible": { "type": "boolean" }, "attemptedPageCount": { "type": "integer", "minimum": 0 }, "completedConditionCount": { "type": "integer", "minimum": 0 }, "completedPageCount": { "type": "integer", "minimum": 0 }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "attemptedPageCount": { "type": "integer", "minimum": 0 }, "completedPageCount": { "type": "integer", "minimum": 0 }, "failedPageCount": { "type": "integer", "minimum": 0 }, "key": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "completed", "failed" ] } }, "required": [ "attemptedPageCount", "completedPageCount", "failedPageCount", "key", "status" ], "additionalProperties": false } }, "failedPageCount": { "type": "integer", "minimum": 0 }, "pages": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "completed", "partial", "failed" ] }, "url": { "type": "string" } }, "required": [ "status", "url" ], "additionalProperties": false } }, "totalConditionCount": { "type": "integer", "minimum": 0 } }, "required": [ "absenceClaimEligible", "attemptedPageCount", "completedConditionCount", "completedPageCount", "conditions", "failedPageCount", "totalConditionCount" ], "additionalProperties": false }, "dataQuality": { "type": "object", "properties": { "changes": { "type": "string", "enum": [ "frozen_at_completion", "no_comparable_scan" ] }, "cookieAttributes": { "type": "string", "enum": [ "point_in_time_snapshot", "legacy_unavailable" ] } }, "required": [ "changes", "cookieAttributes" ], "additionalProperties": false }, "summary": { "type": "object", "properties": { "cookieCount": { "type": "integer", "minimum": 0 }, "firstPartyCookieCount": { "type": "integer", "minimum": 0 }, "observationCount": { "type": "integer", "minimum": 0 }, "pageCount": { "type": "integer", "minimum": 0 }, "thirdPartyCookieCount": { "type": "integer", "minimum": 0 }, "unidentifiedCount": { "type": "integer", "minimum": 0 }, "vendorCount": { "type": "integer", "minimum": 0 } }, "required": [ "cookieCount", "firstPartyCookieCount", "observationCount", "pageCount", "thirdPartyCookieCount", "unidentifiedCount", "vendorCount" ], "additionalProperties": false }, "unidentified": { "type": "array", "items": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "type": "object", "properties": { "consentScenario": { "type": "string", "enum": [ "pre_consent", "pre_consent_gpc", "accept_all", "reject_all", "accept_measurement_only", "accept_marketing_only" ] }, "key": { "type": "string" }, "regionProfile": { "type": "string", "enum": [ "uk_gdpr", "eu_eea_gdpr", "us_ca_cpra", "us_tx_baseline", "custom" ] }, "runId": { "type": "string" } }, "required": [ "consentScenario", "key", "regionProfile", "runId" ], "additionalProperties": false } }, "evidence": { "type": "array", "items": { "type": "object", "properties": { "evidenceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "key": { "type": "string" }, "kind": { "type": "string", "enum": [ "script", "cookie", "storage", "network", "global_object", "package", "iframe", "header" ] }, "observationId": { "type": "string" }, "observedAt": { "type": "string" }, "pagePath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "runId": { "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "evidenceId", "key", "kind", "observationId", "observedAt", "pagePath", "runId", "url", "value" ], "additionalProperties": false } }, "evidenceIds": { "type": "array", "items": { "type": "string" } }, "lastSeenAt": { "type": "string" }, "observationCount": { "type": "integer", "minimum": 0 }, "pagePaths": { "type": "array", "items": { "type": "string" } }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "evidenceKinds": { "type": "array", "items": { "type": "string", "enum": [ "script", "cookie", "storage", "network", "global_object", "package", "iframe", "header" ] } }, "id": { "type": "string" }, "label": { "type": "string" }, "party": { "type": "string", "enum": [ "first_party", "third_party", "unknown" ] } }, "required": [ "conditions", "evidence", "evidenceIds", "lastSeenAt", "observationCount", "pagePaths", "domain", "evidenceKinds", "id", "label", "party" ], "additionalProperties": false } }, "vendors": { "type": "array", "items": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "type": "object", "properties": { "consentScenario": { "type": "string", "enum": [ "pre_consent", "pre_consent_gpc", "accept_all", "reject_all", "accept_measurement_only", "accept_marketing_only" ] }, "key": { "type": "string" }, "regionProfile": { "type": "string", "enum": [ "uk_gdpr", "eu_eea_gdpr", "us_ca_cpra", "us_tx_baseline", "custom" ] }, "runId": { "type": "string" } }, "required": [ "consentScenario", "key", "regionProfile", "runId" ], "additionalProperties": false } }, "evidence": { "type": "array", "items": { "type": "object", "properties": { "evidenceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "key": { "type": "string" }, "kind": { "type": "string", "enum": [ "script", "cookie", "storage", "network", "global_object", "package", "iframe", "header" ] }, "observationId": { "type": "string" }, "observedAt": { "type": "string" }, "pagePath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "runId": { "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "evidenceId", "key", "kind", "observationId", "observedAt", "pagePath", "runId", "url", "value" ], "additionalProperties": false } }, "evidenceIds": { "type": "array", "items": { "type": "string" } }, "lastSeenAt": { "type": "string" }, "observationCount": { "type": "integer", "minimum": 0 }, "pagePaths": { "type": "array", "items": { "type": "string" } }, "categorySource": { "anyOf": [ { "type": "string", "enum": [ "global_default", "identifier_default", "project_override", "scan_inferred", "ai_suggested" ] }, { "type": "null" } ] }, "change": { "anyOf": [ { "type": "string", "enum": [ "new", "previously_detected" ] }, { "type": "null" } ] }, "confidence": { "type": "string", "enum": [ "high", "medium", "low" ] }, "consentCategory": { "anyOf": [ { "type": "string", "enum": [ "necessary", "measurement", "marketing", "functionality", "experience" ] }, { "type": "null" } ] }, "evidenceKinds": { "type": "array", "items": { "type": "string", "enum": [ "script", "cookie", "storage", "network", "global_object", "package", "iframe", "header" ] } }, "homepageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matchIds": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "privacyPolicyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "projectVendorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewState": { "type": "string", "enum": [ "accepted", "suggested", "rejected", "needs_review" ] }, "slug": { "type": "string" }, "state": { "anyOf": [ { "type": "string", "enum": [ "active", "not_seen_recently", "ignored", "approved", "blocked" ] }, { "type": "null" } ] }, "vendorId": { "type": "string" } }, "required": [ "conditions", "evidence", "evidenceIds", "lastSeenAt", "observationCount", "pagePaths", "categorySource", "change", "confidence", "consentCategory", "evidenceKinds", "homepageUrl", "matchIds", "name", "privacyPolicyUrl", "projectVendorId", "reviewState", "slug", "state", "vendorId" ], "additionalProperties": false } } }, "required": [ "changes", "conditions", "cookies", "coverage", "dataQuality", "summary", "unidentified", "vendors" ], "additionalProperties": false }, { "type": "null" } ] }, "scanId": { "type": "string" } }, "required": [ "collection", "organizationId", "projectionVersion", "results", "scanId" ], "additionalProperties": false } }, "required": [ "action", "domain", "evidenceId", "reviewItemId", "snapshot" ], "additionalProperties": false } } }
400
The request payload or parameters are invalid.
Content type application/json
| Property | Type | Required | Description |
|---|---|---|---|
success | boolean | Required | — |
error | object | Required | — |
error.code | "UNAUTHORIZED" | "FORBIDDEN" | "INSUFFICIENT_SCOPE" | "PLAN_LIMIT_REACHED" | "PLAN_REQUIRED" | "INVALID_ORIGIN" | "INVALID_REGION" | "INVALID_PAYLOAD" | "NOT_FOUND" | "CONFLICT" | "KEY_LIMIT_REACHED" | "INSUFFICIENT_CREDITS" | "SCAN_IN_PROGRESS" | "UNLOCK_REQUIRED" | "REPOSITORY_NOT_LINKED" | "PAYLOAD_TOO_LARGE" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_ERROR" | Required | — |
error.message | string | Required | — |
error.details | unknown | Optional | Optional structured error details. |
View JSON schema
{ "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } }
401
Authentication is missing, invalid, or expired.
Content type application/json
| Property | Type | Required | Description |
|---|---|---|---|
success | boolean | Required | — |
error | object | Required | — |
error.code | "UNAUTHORIZED" | "FORBIDDEN" | "INSUFFICIENT_SCOPE" | "PLAN_LIMIT_REACHED" | "PLAN_REQUIRED" | "INVALID_ORIGIN" | "INVALID_REGION" | "INVALID_PAYLOAD" | "NOT_FOUND" | "CONFLICT" | "KEY_LIMIT_REACHED" | "INSUFFICIENT_CREDITS" | "SCAN_IN_PROGRESS" | "UNLOCK_REQUIRED" | "REPOSITORY_NOT_LINKED" | "PAYLOAD_TOO_LARGE" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_ERROR" | Required | — |
error.message | string | Required | — |
error.details | unknown | Optional | Optional structured error details. |
View JSON schema
{ "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } }
403
The credential is valid but may not perform the operation. `INSUFFICIENT_SCOPE`: the credential was never granted the capability the operation needs. `details.requiredScope` names it, and the `WWW-Authenticate` header carries `Bearer error="insufficient_scope"`. An OAuth client fixes this by requesting the scope; an organization API key cannot gain it. `FORBIDDEN`: the capability is present but the membership behind the credential lacks the role, or the resource belongs to another organization.
Content type application/json
| Property | Type | Required | Description |
|---|---|---|---|
success | boolean | Required | — |
error | object | Required | — |
error.code | "UNAUTHORIZED" | "FORBIDDEN" | "INSUFFICIENT_SCOPE" | "PLAN_LIMIT_REACHED" | "PLAN_REQUIRED" | "INVALID_ORIGIN" | "INVALID_REGION" | "INVALID_PAYLOAD" | "NOT_FOUND" | "CONFLICT" | "KEY_LIMIT_REACHED" | "INSUFFICIENT_CREDITS" | "SCAN_IN_PROGRESS" | "UNLOCK_REQUIRED" | "REPOSITORY_NOT_LINKED" | "PAYLOAD_TOO_LARGE" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_ERROR" | Required | — |
error.message | string | Required | — |
error.details | unknown | Optional | Optional structured error details. |
View JSON schema
{ "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } }
Headers
| Name | Type | Description |
|---|---|---|
WWW-Authenticate | string | Present on `INSUFFICIENT_SCOPE`: `Bearer error="insufficient_scope", scope="<required scope>"`. |
404
The requested resource was not found.
Content type application/json
| Property | Type | Required | Description |
|---|---|---|---|
success | boolean | Required | — |
error | object | Required | — |
error.code | "UNAUTHORIZED" | "FORBIDDEN" | "INSUFFICIENT_SCOPE" | "PLAN_LIMIT_REACHED" | "PLAN_REQUIRED" | "INVALID_ORIGIN" | "INVALID_REGION" | "INVALID_PAYLOAD" | "NOT_FOUND" | "CONFLICT" | "KEY_LIMIT_REACHED" | "INSUFFICIENT_CREDITS" | "SCAN_IN_PROGRESS" | "UNLOCK_REQUIRED" | "REPOSITORY_NOT_LINKED" | "PAYLOAD_TOO_LARGE" | "RATE_LIMITED" | "SERVICE_UNAVAILABLE" | "INTERNAL_ERROR" | Required | — |
error.message | string | Required | — |
error.details | unknown | Optional | Optional structured error details. |
View JSON schema
{ "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } }
Related
- REST API overview: Every operation in this API.