Consent
Read Consent configuration summary
Last updated 30 October 2026
get
/v1/projects/{projectId}/consentIncludes session duration, plan capabilities, IAB and translation summaries, and discoverable paths for complete stored configuration. dataCompleteness is summary; policies.configComplete reports whether its embedded policy configuration is complete. Requires consent.read and projects.read. Organization API keys cannot call this operation.
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 |
|---|---|---|---|
projectId | string | Required | Project ID returned by list_projects. Scoped to the caller's current memberships. |
Responses
200
Success
Content type application/json
| Property | Type | Required | Description |
|---|---|---|---|
success | unknown | Required | — |
data | object | Required | — |
data.backendVersion | string | Required | — |
data.branding | "c15t" | "inth" | "none" | Required | — |
data.capabilities | object | Required | — |
data.capabilities.customPolicies | boolean | Required | — |
data.capabilities.iab | boolean | Required | — |
data.capabilities.policies | boolean | Required | — |
data.capabilities.removeBranding | boolean | Required | — |
data.capabilities.sessionDuration | boolean | Required | — |
data.capabilities.translations | boolean | Required | — |
data.id | string | Required | — |
data.instanceId | string | Required | — |
data.instanceName | string | Required | — |
data.instanceSlug | string | Required | — |
data.location | string | Required | — |
data.organizationId | string | Required | — |
data.organizationSlug | string | Required | — |
data.projectId | string | Required | — |
data.projectSlug | string | Required | — |
data.runtimeUrl | string | null | Required | — |
data.sessionDurationMinutes | 5 | 15 | 30 | 60 | 180 | 360 | 720 | 1440 | Required | — |
data.settings | object | Required | — |
data.settings.i18n | object | null | Required | — |
data.settings.iab | object | null | Required | — |
data.settings.policies | object | null | Required | — |
data.trustedOrigins | string[] | Required | — |
data.dataCompleteness | "summary" | Required | — |
data.configuration | object | Required | — |
data.configuration.i18n | string | Required | — |
data.configuration.iab | string | Required | — |
data.configuration.policies | string | Required | — |
View JSON schema
{ "type": "object", "required": [ "success", "data" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "backendVersion": { "type": "string" }, "branding": { "type": "string", "enum": [ "c15t", "inth", "none" ] }, "capabilities": { "type": "object", "properties": { "customPolicies": { "type": "boolean" }, "iab": { "type": "boolean" }, "policies": { "type": "boolean" }, "removeBranding": { "type": "boolean" }, "sessionDuration": { "type": "boolean" }, "translations": { "type": "boolean" } }, "required": [ "customPolicies", "iab", "policies", "removeBranding", "sessionDuration", "translations" ], "additionalProperties": false }, "id": { "type": "string" }, "instanceId": { "type": "string" }, "instanceName": { "type": "string" }, "instanceSlug": { "type": "string" }, "location": { "type": "string" }, "organizationId": { "type": "string" }, "organizationSlug": { "type": "string" }, "projectId": { "type": "string" }, "projectSlug": { "type": "string" }, "runtimeUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sessionDurationMinutes": { "type": "number", "enum": [ 5, 15, 30, 60, 180, 360, 720, 1440 ] }, "settings": { "type": "object", "properties": { "i18n": { "anyOf": [ { "type": "object", "properties": { "config": { "anyOf": [ { "type": "object", "properties": { "defaultProfile": { "type": "string", "maxLength": 128 }, "messages": { "type": "object", "additionalProperties": { "type": "object", "properties": { "fallbackLanguage": { "type": "string", "maxLength": 32 }, "translations": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } }, "required": [ "translations" ], "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "defaultProfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "fallbackLanguage": { "type": "string" }, "languages": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" } }, "required": [ "fallbackLanguage", "languages", "name" ], "additionalProperties": false } } }, "required": [ "defaultProfile", "profiles" ], "additionalProperties": false }, { "type": "null" } ] }, "iab": { "anyOf": [ { "type": "object", "properties": { "customVendorCount": { "type": "integer", "minimum": 0 }, "vendorIds": { "type": "array", "items": { "type": "integer", "minimum": 0 } }, "additionalConsentProviders": { "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0 } } }, "required": [ "customVendorCount", "vendorIds", "additionalConsentProviders" ], "additionalProperties": false }, { "type": "null" } ] }, "policies": { "anyOf": [ { "type": "object", "properties": { "activeCount": { "type": "integer", "minimum": 0 }, "configComplete": { "type": "boolean" }, "count": { "type": "integer", "minimum": 0 }, "config": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "model": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "prompt": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "categories": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "scopeMode": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "preselectedCategories": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "actions": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "rights": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "validity": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "privacySignals": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "copyRevision": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "legacyMaterial": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "review": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "consent": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "i18n": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "id": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "match": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "proof": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] }, "ui": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Suspend_" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Suspend_" } } ] } } ] } }, "additionalProperties": false } }, { "type": "null" } ] }, "hasIabPolicy": { "type": "boolean" }, "ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "activeCount", "configComplete", "count", "ids" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "i18n", "iab", "policies" ], "additionalProperties": false }, "trustedOrigins": { "type": "array", "items": { "type": "string" } }, "dataCompleteness": { "type": "string", "enum": [ "summary" ] }, "configuration": { "type": "object", "properties": { "i18n": { "type": "string" }, "iab": { "type": "string" }, "policies": { "type": "string" } }, "required": [ "i18n", "iab", "policies" ], "additionalProperties": false } }, "required": [ "backendVersion", "branding", "capabilities", "id", "instanceId", "instanceName", "instanceSlug", "location", "organizationId", "organizationSlug", "projectId", "projectSlug", "runtimeUrl", "sessionDurationMinutes", "settings", "trustedOrigins", "dataCompleteness", "configuration" ], "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." } } } } }
409
The request conflicts with the current resource state.
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." } } } } }
503
The capability is temporarily paused by an operator. Retry later.
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.