{ "openapi": "3.1.0", "info": { "title": "Lockpick API", "version": "1.0.0-beta", "description": "The API the Lockpick CLI and MCP server use. Beta: operations may change before v1 is final." }, "security": [ { "key": [] } ], "components": { "securitySchemes": { "key": { "type": "http", "scheme": "bearer", "description": "A Lockpick key (`lpk_…`) from `lockpick login`, with the permissions you approved." } } }, "paths": { "/api/cli/v1/projects/{projectId}/local-assessments/authorize": { "post": { "operationId": "authorizeLocalAssessment", "summary": "Authorize a local assessment before repository inspection. No source or results are uploaded.", "description": "Needs a key with the `undefined` permission.", "x-lockpick-scopes": [ "local" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cliVersion": { "type": "string", "maxLength": 40, "pattern": "^\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9.-]+)?$" }, "scannerVersion": { "type": "string", "maxLength": 40, "pattern": "^\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9.-]+)?$" }, "rulesetVersion": { "type": "string", "maxLength": 40, "pattern": "^\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9.-]+)?$" }, "reportSchemaVersion": { "type": "string", "maxLength": 40, "pattern": "^\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9.-]+)?$" }, "checks": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "string", "enum": [ "tracked-secrets", "public-environment", "browser-artifacts", "supabase-client", "supabase-migrations", "git-history", "docker-files", "docker-values", "actions-injection", "source-maps" ] } } }, "required": [ "cliVersion", "scannerVersion", "rulesetVersion", "reportSchemaVersion", "checks" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "admissionId": { "type": "string", "minLength": 1, "maxLength": 100 }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "workspaceId": { "type": "string", "minLength": 1, "maxLength": 100 }, "policyVersion": { "type": "string", "maxLength": 40, "pattern": "^\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9.-]+)?$" }, "startBy": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "checks": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "tracked-secrets", "public-environment", "browser-artifacts", "supabase-client", "supabase-migrations", "git-history", "docker-files", "docker-values", "actions-injection", "source-maps" ] }, "allowed": { "type": "boolean" }, "reason": { "type": "string", "enum": [ "available", "unsupported", "disabled" ] } }, "required": [ "id", "allowed", "reason" ], "additionalProperties": false } } }, "required": [ "admissionId", "projectId", "workspaceId", "policyVersion", "startBy", "checks" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/device/code": { "post": { "operationId": "deviceCode", "summary": "Start a device sign-in and get a code for the person to approve in the browser.", "description": "Part of device sign-in; needs no key.", "x-lockpick-scopes": [], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clientName": { "default": "Lockpick CLI", "type": "string", "minLength": 1, "maxLength": 80 }, "hostname": { "type": "string", "maxLength": 120 }, "platform": { "type": "string", "maxLength": 40 }, "version": { "type": "string", "maxLength": 40 }, "scopes": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "pulse", "sites", "deep", "local" ] } } } } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deviceCode": { "type": "string" }, "userCode": { "type": "string" }, "verificationUri": { "type": "string", "format": "uri" }, "verificationUriComplete": { "type": "string", "format": "uri" }, "expiresIn": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "interval": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "deviceCode", "userCode", "verificationUri", "verificationUriComplete", "expiresIn", "interval" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/device/token": { "post": { "operationId": "deviceToken", "summary": "Poll a device sign-in until the person approves it, then receive the key.", "description": "Part of device sign-in; needs no key.", "x-lockpick-scopes": [], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceCode": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "deviceCode" ] } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "const": "pending" }, "interval": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "status", "interval" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "slow_down" }, "interval": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "status", "interval" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "denied" } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "expired" } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "approved" }, "key": { "type": "string" }, "expiresAt": { "type": "string" }, "scopes": {}, "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false } }, "required": [ "status", "key", "expiresAt", "scopes", "workspace" ], "additionalProperties": false } ] }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/me": { "get": { "operationId": "whoAmI", "summary": "The person, workspace and key behind this credential.", "description": "Needs a key with the `read` permission.", "x-lockpick-scopes": [ "read" ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ], "additionalProperties": false }, "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "key": { "type": "object", "properties": { "id": { "type": "string" }, "prefix": { "type": "string" }, "label": { "type": "string" }, "scopes": {}, "expiresAt": { "type": "string" }, "projectId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "prefix", "label", "scopes", "expiresAt" ], "additionalProperties": false } }, "required": [ "user", "workspace", "key" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } }, "delete": { "operationId": "revokeKey", "summary": "Revoke the presented key.", "description": "Needs any valid key.", "x-lockpick-scopes": [], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "revoked": { "type": "boolean", "const": true } }, "required": [ "revoked" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/projects": { "get": { "operationId": "listProjects", "summary": "Sites (projects) with their latest Pulse and Deep scans.", "description": "Needs a key with the `read` permission.", "x-lockpick-scopes": [ "read" ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "baseDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latestPulse": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath" ], "additionalProperties": false }, { "type": "null" } ] }, "latestDeep": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath" ], "additionalProperties": false }, { "type": "null" } ] }, "latestBox": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath" ], "additionalProperties": false }, { "type": "null" } ] }, "webPath": { "type": "string" }, "webUrl": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "status", "baseDomain", "latestPulse", "latestBox", "webPath" ], "additionalProperties": false } }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/projects/{projectId}/status": { "get": { "operationId": "projectStatus", "summary": "One site's latest results and what changed.", "description": "Needs a key with the `read` permission.", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "project": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "baseDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latestPulse": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath" ], "additionalProperties": false }, { "type": "null" } ] }, "latestDeep": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath" ], "additionalProperties": false }, { "type": "null" } ] }, "latestBox": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath" ], "additionalProperties": false }, { "type": "null" } ] }, "webPath": { "type": "string" }, "webUrl": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "status", "baseDomain", "latestPulse", "latestBox", "webPath" ], "additionalProperties": false }, "latestPulse": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] }, "baselineRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "object", "properties": { "critical": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "high": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "medium": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "low": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "info": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "critical", "high", "medium", "low", "info" ], "additionalProperties": false }, "findingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "requests": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "message", "percent", "pages", "requests" ], "additionalProperties": false }, { "type": "null" } ] }, "coverage": { "type": "object", "properties": { "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "percent", "limitations" ], "additionalProperties": false }, "caveats": { "type": "array", "items": { "type": "string" } }, "outcome": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "enum": [ "full", "headers-only", "blocked", "transport", "unreachable", "terminal-failure" ] }, "coverage": { "type": "string", "enum": [ "page", "headers-and-records", "records-only", "none" ] }, "reason": { "type": "string", "enum": [ "no-address", "dns-error", "private-address", "refused", "no-answer", "connection-closed", "certificate", "old-tls", "large-headers", "invalid-response", "www", "other-site", "sign-in", "redirect-loop", "redirect", "bot-check", "denied", "rate-limited", "not-found", "gone", "client-error", "server-error", "maintenance", "parked", "empty", "not-html", "app-shell", "interrupted", "not-delivered" ] }, "vendor": { "type": "string", "enum": [ "cloudflare", "vercel", "other" ] }, "blockedBy": { "type": "string", "maxLength": 40, "pattern": "^[a-z0-9-]+$" }, "homepageStatus": { "type": "integer", "minimum": 100, "maximum": 599 }, "redirectOrigin": { "type": "string", "maxLength": 300 }, "contacted": { "type": "boolean" } }, "required": [ "level", "coverage" ], "additionalProperties": false }, { "type": "null" } ] }, "exposureCheck": { "anyOf": [ { "type": "object", "properties": { "state": { "type": "string", "enum": [ "clear", "found", "not-run", "partial", "could-not-run" ] }, "limits": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "no-source-map", "source-map-unread", "robots-excluded", "budget", "deadline", "slowdown", "rate-limited", "bot-check", "cancelled", "stopped" ] } }, "sourceMap": { "type": "string", "enum": [ "published", "none", "not-checked" ] } }, "required": [ "state", "limits", "sourceMap" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "baselineRunId", "open", "findingCount", "progress", "coverage", "caveats" ], "additionalProperties": false }, { "type": "null" } ] }, "latestDeep": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] }, "baselineRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "object", "properties": { "critical": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "high": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "medium": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "low": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "info": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "critical", "high", "medium", "low", "info" ], "additionalProperties": false }, "findingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "requests": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "message", "percent", "pages", "requests" ], "additionalProperties": false }, { "type": "null" } ] }, "coverage": { "type": "object", "properties": { "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "percent", "limitations" ], "additionalProperties": false }, "caveats": { "type": "array", "items": { "type": "string" } }, "outcome": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "enum": [ "full", "headers-only", "blocked", "transport", "unreachable", "terminal-failure" ] }, "coverage": { "type": "string", "enum": [ "page", "headers-and-records", "records-only", "none" ] }, "reason": { "type": "string", "enum": [ "no-address", "dns-error", "private-address", "refused", "no-answer", "connection-closed", "certificate", "old-tls", "large-headers", "invalid-response", "www", "other-site", "sign-in", "redirect-loop", "redirect", "bot-check", "denied", "rate-limited", "not-found", "gone", "client-error", "server-error", "maintenance", "parked", "empty", "not-html", "app-shell", "interrupted", "not-delivered" ] }, "vendor": { "type": "string", "enum": [ "cloudflare", "vercel", "other" ] }, "blockedBy": { "type": "string", "maxLength": 40, "pattern": "^[a-z0-9-]+$" }, "homepageStatus": { "type": "integer", "minimum": 100, "maximum": 599 }, "redirectOrigin": { "type": "string", "maxLength": 300 }, "contacted": { "type": "boolean" } }, "required": [ "level", "coverage" ], "additionalProperties": false }, { "type": "null" } ] }, "exposureCheck": { "anyOf": [ { "type": "object", "properties": { "state": { "type": "string", "enum": [ "clear", "found", "not-run", "partial", "could-not-run" ] }, "limits": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "no-source-map", "source-map-unread", "robots-excluded", "budget", "deadline", "slowdown", "rate-limited", "bot-check", "cancelled", "stopped" ] } }, "sourceMap": { "type": "string", "enum": [ "published", "none", "not-checked" ] } }, "required": [ "state", "limits", "sourceMap" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "baselineRunId", "open", "findingCount", "progress", "coverage", "caveats" ], "additionalProperties": false }, { "type": "null" } ] }, "latestBox": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] }, "baselineRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "object", "properties": { "critical": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "high": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "medium": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "low": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "info": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "critical", "high", "medium", "low", "info" ], "additionalProperties": false }, "findingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "requests": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "message", "percent", "pages", "requests" ], "additionalProperties": false }, { "type": "null" } ] }, "coverage": { "type": "object", "properties": { "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "percent", "limitations" ], "additionalProperties": false }, "caveats": { "type": "array", "items": { "type": "string" } }, "outcome": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "enum": [ "full", "headers-only", "blocked", "transport", "unreachable", "terminal-failure" ] }, "coverage": { "type": "string", "enum": [ "page", "headers-and-records", "records-only", "none" ] }, "reason": { "type": "string", "enum": [ "no-address", "dns-error", "private-address", "refused", "no-answer", "connection-closed", "certificate", "old-tls", "large-headers", "invalid-response", "www", "other-site", "sign-in", "redirect-loop", "redirect", "bot-check", "denied", "rate-limited", "not-found", "gone", "client-error", "server-error", "maintenance", "parked", "empty", "not-html", "app-shell", "interrupted", "not-delivered" ] }, "vendor": { "type": "string", "enum": [ "cloudflare", "vercel", "other" ] }, "blockedBy": { "type": "string", "maxLength": 40, "pattern": "^[a-z0-9-]+$" }, "homepageStatus": { "type": "integer", "minimum": 100, "maximum": 599 }, "redirectOrigin": { "type": "string", "maxLength": 300 }, "contacted": { "type": "boolean" } }, "required": [ "level", "coverage" ], "additionalProperties": false }, { "type": "null" } ] }, "exposureCheck": { "anyOf": [ { "type": "object", "properties": { "state": { "type": "string", "enum": [ "clear", "found", "not-run", "partial", "could-not-run" ] }, "limits": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "no-source-map", "source-map-unread", "robots-excluded", "budget", "deadline", "slowdown", "rate-limited", "bot-check", "cancelled", "stopped" ] } }, "sourceMap": { "type": "string", "enum": [ "published", "none", "not-checked" ] } }, "required": [ "state", "limits", "sourceMap" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "baselineRunId", "open", "findingCount", "progress", "coverage", "caveats" ], "additionalProperties": false }, { "type": "null" } ] }, "lastComparison": { "anyOf": [ { "type": "object", "properties": { "baselineRunId": { "type": "string" }, "new": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "persistent": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "absent": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "unknown": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "baselineRunId", "new", "persistent", "absent", "unknown" ], "additionalProperties": false }, { "type": "null" } ] }, "caveats": { "type": "array", "items": { "type": "string" } } }, "required": [ "project", "latestPulse", "latestBox", "lastComparison", "caveats" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/projects/{projectId}/pulse": { "post": { "operationId": "startPulse", "summary": "Start a Pulse on a site, or a recheck of its latest one.", "description": "Needs a key with the `pulse` permission.", "x-lockpick-scopes": [ "pulse" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "idempotencyKey" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] }, "baselineRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "object", "properties": { "critical": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "high": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "medium": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "low": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "info": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "critical", "high", "medium", "low", "info" ], "additionalProperties": false }, "findingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "requests": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "message", "percent", "pages", "requests" ], "additionalProperties": false }, { "type": "null" } ] }, "coverage": { "type": "object", "properties": { "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "percent", "limitations" ], "additionalProperties": false }, "caveats": { "type": "array", "items": { "type": "string" } }, "outcome": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "enum": [ "full", "headers-only", "blocked", "transport", "unreachable", "terminal-failure" ] }, "coverage": { "type": "string", "enum": [ "page", "headers-and-records", "records-only", "none" ] }, "reason": { "type": "string", "enum": [ "no-address", "dns-error", "private-address", "refused", "no-answer", "connection-closed", "certificate", "old-tls", "large-headers", "invalid-response", "www", "other-site", "sign-in", "redirect-loop", "redirect", "bot-check", "denied", "rate-limited", "not-found", "gone", "client-error", "server-error", "maintenance", "parked", "empty", "not-html", "app-shell", "interrupted", "not-delivered" ] }, "vendor": { "type": "string", "enum": [ "cloudflare", "vercel", "other" ] }, "blockedBy": { "type": "string", "maxLength": 40, "pattern": "^[a-z0-9-]+$" }, "homepageStatus": { "type": "integer", "minimum": 100, "maximum": 599 }, "redirectOrigin": { "type": "string", "maxLength": 300 }, "contacted": { "type": "boolean" } }, "required": [ "level", "coverage" ], "additionalProperties": false }, { "type": "null" } ] }, "exposureCheck": { "anyOf": [ { "type": "object", "properties": { "state": { "type": "string", "enum": [ "clear", "found", "not-run", "partial", "could-not-run" ] }, "limits": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "no-source-map", "source-map-unread", "robots-excluded", "budget", "deadline", "slowdown", "rate-limited", "bot-check", "cancelled", "stopped" ] } }, "sourceMap": { "type": "string", "enum": [ "published", "none", "not-checked" ] } }, "required": [ "state", "limits", "sourceMap" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "baselineRunId", "open", "findingCount", "progress", "coverage", "caveats" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/projects/{projectId}/deep": { "post": { "operationId": "startReleaseDeep", "summary": "Start a release's Deep scan with a CI key made for this site with Deep allowed.", "description": "Needs a key with the `deep` permission.", "x-lockpick-scopes": [ "deep" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "idempotencyKey" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] }, "baselineRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "object", "properties": { "critical": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "high": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "medium": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "low": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "info": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "critical", "high", "medium", "low", "info" ], "additionalProperties": false }, "findingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "requests": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "message", "percent", "pages", "requests" ], "additionalProperties": false }, { "type": "null" } ] }, "coverage": { "type": "object", "properties": { "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "percent", "limitations" ], "additionalProperties": false }, "caveats": { "type": "array", "items": { "type": "string" } }, "outcome": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "enum": [ "full", "headers-only", "blocked", "transport", "unreachable", "terminal-failure" ] }, "coverage": { "type": "string", "enum": [ "page", "headers-and-records", "records-only", "none" ] }, "reason": { "type": "string", "enum": [ "no-address", "dns-error", "private-address", "refused", "no-answer", "connection-closed", "certificate", "old-tls", "large-headers", "invalid-response", "www", "other-site", "sign-in", "redirect-loop", "redirect", "bot-check", "denied", "rate-limited", "not-found", "gone", "client-error", "server-error", "maintenance", "parked", "empty", "not-html", "app-shell", "interrupted", "not-delivered" ] }, "vendor": { "type": "string", "enum": [ "cloudflare", "vercel", "other" ] }, "blockedBy": { "type": "string", "maxLength": 40, "pattern": "^[a-z0-9-]+$" }, "homepageStatus": { "type": "integer", "minimum": 100, "maximum": 599 }, "redirectOrigin": { "type": "string", "maxLength": 300 }, "contacted": { "type": "boolean" } }, "required": [ "level", "coverage" ], "additionalProperties": false }, { "type": "null" } ] }, "exposureCheck": { "anyOf": [ { "type": "object", "properties": { "state": { "type": "string", "enum": [ "clear", "found", "not-run", "partial", "could-not-run" ] }, "limits": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "no-source-map", "source-map-unread", "robots-excluded", "budget", "deadline", "slowdown", "rate-limited", "bot-check", "cancelled", "stopped" ] } }, "sourceMap": { "type": "string", "enum": [ "published", "none", "not-checked" ] } }, "required": [ "state", "limits", "sourceMap" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "baselineRunId", "open", "findingCount", "progress", "coverage", "caveats" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/runs": { "get": { "operationId": "listRuns", "summary": "Pulse and Deep scans, newest first.", "description": "Needs a key with the `read` permission.", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "projectId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pulse", "box" ] } }, { "name": "assessmentLevel", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pulse", "standard", "deep" ] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath" ], "additionalProperties": false } }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/runs/{runId}": { "get": { "operationId": "getRun", "summary": "One run with its headline and counts.", "description": "Needs a key with the `read` permission.", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] }, "baselineRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "object", "properties": { "critical": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "high": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "medium": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "low": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "info": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "critical", "high", "medium", "low", "info" ], "additionalProperties": false }, "findingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "requests": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "message", "percent", "pages", "requests" ], "additionalProperties": false }, { "type": "null" } ] }, "coverage": { "type": "object", "properties": { "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "percent", "limitations" ], "additionalProperties": false }, "caveats": { "type": "array", "items": { "type": "string" } }, "outcome": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "enum": [ "full", "headers-only", "blocked", "transport", "unreachable", "terminal-failure" ] }, "coverage": { "type": "string", "enum": [ "page", "headers-and-records", "records-only", "none" ] }, "reason": { "type": "string", "enum": [ "no-address", "dns-error", "private-address", "refused", "no-answer", "connection-closed", "certificate", "old-tls", "large-headers", "invalid-response", "www", "other-site", "sign-in", "redirect-loop", "redirect", "bot-check", "denied", "rate-limited", "not-found", "gone", "client-error", "server-error", "maintenance", "parked", "empty", "not-html", "app-shell", "interrupted", "not-delivered" ] }, "vendor": { "type": "string", "enum": [ "cloudflare", "vercel", "other" ] }, "blockedBy": { "type": "string", "maxLength": 40, "pattern": "^[a-z0-9-]+$" }, "homepageStatus": { "type": "integer", "minimum": 100, "maximum": 599 }, "redirectOrigin": { "type": "string", "maxLength": 300 }, "contacted": { "type": "boolean" } }, "required": [ "level", "coverage" ], "additionalProperties": false }, { "type": "null" } ] }, "exposureCheck": { "anyOf": [ { "type": "object", "properties": { "state": { "type": "string", "enum": [ "clear", "found", "not-run", "partial", "could-not-run" ] }, "limits": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "no-source-map", "source-map-unread", "robots-excluded", "budget", "deadline", "slowdown", "rate-limited", "bot-check", "cancelled", "stopped" ] } }, "sourceMap": { "type": "string", "enum": [ "published", "none", "not-checked" ] } }, "required": [ "state", "limits", "sourceMap" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "baselineRunId", "open", "findingCount", "progress", "coverage", "caveats" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/runs/{runId}/findings": { "get": { "operationId": "listFindings", "summary": "Findings of a run.", "description": "Needs a key with the `read` permission.", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "severity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "attention", "information", "unknown", "pass" ] } }, { "name": "all", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "runId": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "severity": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, "state": { "type": "string", "enum": [ "attention", "information", "unknown", "pass" ] }, "category": { "type": "string" }, "title": { "type": "string" }, "meaning": { "type": "string" }, "fix": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "confidence": { "type": "string" }, "evidence": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "string" } }, "steps": { "type": "array", "items": { "type": "string" } }, "webPath": { "type": "string" }, "webUrl": { "type": "string", "format": "uri" }, "verdict": { "anyOf": [ { "type": "string", "enum": [ "confirmed", "needs_review", "not_actionable" ] }, { "type": "null" } ] }, "certainty": { "anyOf": [ { "type": "string", "enum": [ "high", "medium", "low" ] }, { "type": "null" } ] }, "exploitability": { "anyOf": [ { "type": "string", "enum": [ "direct", "conditional", "hygiene", "none" ] }, { "type": "null" } ] }, "proof": { "anyOf": [ { "type": "object", "properties": { "source": { "type": "string", "maxLength": 300 }, "control": { "type": "string", "maxLength": 300 }, "sink": { "type": "string", "maxLength": 300 }, "impact": { "type": "string", "maxLength": 300 } }, "required": [ "source", "control", "sink", "impact" ], "additionalProperties": false }, { "type": "null" } ] }, "proofGap": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgency": { "type": "string", "enum": [ "now", "week", "later", "none" ] }, "howSure": { "anyOf": [ { "type": "string", "enum": [ "confirmed", "likely", "possible" ] }, { "type": "null" } ] } }, "required": [ "id", "runId", "kind", "severity", "state", "category", "title", "meaning", "fix", "confidence", "evidence", "sources", "steps", "webPath" ], "additionalProperties": false } }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/runs/{runId}/findings/{findingId}": { "get": { "operationId": "getFinding", "summary": "One finding with its redacted evidence.", "description": "Needs a key with the `read` permission.", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "runId": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "severity": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, "state": { "type": "string", "enum": [ "attention", "information", "unknown", "pass" ] }, "category": { "type": "string" }, "title": { "type": "string" }, "meaning": { "type": "string" }, "fix": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "confidence": { "type": "string" }, "evidence": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "string" } }, "steps": { "type": "array", "items": { "type": "string" } }, "webPath": { "type": "string" }, "webUrl": { "type": "string", "format": "uri" }, "verdict": { "anyOf": [ { "type": "string", "enum": [ "confirmed", "needs_review", "not_actionable" ] }, { "type": "null" } ] }, "certainty": { "anyOf": [ { "type": "string", "enum": [ "high", "medium", "low" ] }, { "type": "null" } ] }, "exploitability": { "anyOf": [ { "type": "string", "enum": [ "direct", "conditional", "hygiene", "none" ] }, { "type": "null" } ] }, "proof": { "anyOf": [ { "type": "object", "properties": { "source": { "type": "string", "maxLength": 300 }, "control": { "type": "string", "maxLength": 300 }, "sink": { "type": "string", "maxLength": 300 }, "impact": { "type": "string", "maxLength": 300 } }, "required": [ "source", "control", "sink", "impact" ], "additionalProperties": false }, { "type": "null" } ] }, "proofGap": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgency": { "type": "string", "enum": [ "now", "week", "later", "none" ] }, "howSure": { "anyOf": [ { "type": "string", "enum": [ "confirmed", "likely", "possible" ] }, { "type": "null" } ] } }, "required": [ "id", "runId", "kind", "severity", "state", "category", "title", "meaning", "fix", "confidence", "evidence", "sources", "steps", "webPath" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/runs/{runId}/repair-brief": { "get": { "operationId": "repairBrief", "summary": "A run's fixes as one Markdown brief.", "description": "Needs a key with the `read` permission.", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "findingId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "agent", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "claude-code", "codex", "cursor", "vscode", "opencode", "lovable", "bolt", "replit", "v0" ] } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "runId": { "type": "string" }, "findingIds": { "type": "array", "items": { "type": "string" } }, "saved": { "type": "boolean" }, "markdown": { "type": "string" }, "webUrl": { "type": "string", "format": "uri" } }, "required": [ "runId", "findingIds", "saved", "markdown" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/runs/{runId}/comparison": { "get": { "operationId": "comparison", "summary": "What changed between a run and the one before it.", "description": "Needs a key with the `read` permission.", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "runId": { "type": "string" }, "baselineRunId": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "change": { "type": "string", "enum": [ "new", "persistent", "absent", "unknown" ] }, "area": { "type": "string", "enum": [ "configuration", "exposure" ] }, "title": { "type": "string" }, "severity": { "type": "string" }, "explanation": { "type": "string" }, "outcome": { "anyOf": [ { "type": "string", "enum": [ "fixed", "still_vulnerable", "inconclusive" ] }, { "type": "null" } ] } }, "required": [ "id", "change", "area", "title", "severity", "explanation" ], "additionalProperties": false } }, "webUrl": { "type": "string", "format": "uri" } }, "required": [ "runId", "baselineRunId", "error", "changes" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/me": { "get": { "operationId": "agentWhoami", "summary": "The person, workspace, scopes and expiry of this credential, and what it can start.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_whoami", "x-lockpick-scopes": [ "read" ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ], "additionalProperties": false }, "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "credential": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "cli_key", "oauth_connection" ] }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "read", "pulse", "sites", "deep", "local" ] } }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "id", "kind", "scopes", "expiresAt" ], "additionalProperties": false }, "capabilities": { "type": "object", "properties": { "pulse": { "type": "boolean" }, "deep": { "type": "boolean" }, "sites": { "type": "boolean" } }, "required": [ "pulse", "deep", "sites" ], "additionalProperties": false } }, "required": [ "user", "workspace", "credential", "capabilities" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/allowance": { "get": { "operationId": "agentAllowance", "summary": "Free scans left this month, their reset dates and credits.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_get_allowance", "x-lockpick-scopes": [ "read" ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "accessSource": { "type": "string", "enum": [ "community", "stripe", "pilot", "none" ] }, "accountingMode": { "type": "string", "enum": [ "pilot", "credits", "unmetered" ] }, "pulse": { "type": "object", "properties": { "remaining": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "resetsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] } }, "required": [ "remaining", "limit", "resetsAt" ], "additionalProperties": false }, "deep": { "type": "object", "properties": { "remaining": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "resetsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] } }, "required": [ "remaining", "limit", "resetsAt" ], "additionalProperties": false }, "creditBalance": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "freeSiteId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, { "type": "null" } ] }, "freeSiteVisible": { "type": "boolean" }, "canSwitchFreeSite": { "type": "boolean" } }, "required": [ "accessSource", "accountingMode", "pulse", "deep", "creditBalance", "freeSiteId", "freeSiteVisible", "canSwitchFreeSite" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/monitor": { "get": { "operationId": "agentMonitor", "summary": "Browse current security intelligence and explain matches for authorized sites.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_monitor", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "view", "in": "query", "required": false, "schema": { "default": "latest", "type": "string", "enum": [ "latest", "sites", "exploited", "following" ] } }, { "name": "kind", "in": "query", "required": false, "schema": { "default": "all", "type": "string", "enum": [ "all", "vulnerability", "malicious_package" ] } }, { "name": "q", "in": "query", "required": false, "schema": { "default": "", "type": "string", "maxLength": 160 } }, { "name": "ecosystem", "in": "query", "required": false, "schema": { "default": "all", "type": "string", "enum": [ "all", "npm", "pypi", "composer", "wordpress" ] } }, { "name": "severity", "in": "query", "required": false, "schema": { "default": "all", "type": "string", "enum": [ "all", "critical", "high", "medium", "low", "unknown" ] } }, { "name": "days", "in": "query", "required": false, "schema": { "default": 30, "type": "number" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 600 } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "siteId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 } }, { "name": "advisoryId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "source": { "type": "string" }, "kind": { "type": "string", "enum": [ "vulnerability", "malicious_package" ] }, "severity": { "type": "string", "enum": [ "critical", "high", "medium", "low", "unknown" ] }, "provenance": { "default": [], "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "externalId": { "type": "string" }, "observedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "attribution": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "references": { "type": "array", "items": { "type": "string" } } }, "required": [ "source", "externalId", "observedAt", "attribution", "references" ], "additionalProperties": false } }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "publishedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "exploited": { "type": "boolean" }, "ids": { "default": [], "type": "array", "items": { "type": "string" } }, "tech": { "default": [], "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" } }, "required": [ "key", "label" ], "additionalProperties": false } }, "epss": { "anyOf": [ { "type": "object", "properties": { "score": { "type": "number" }, "percentile": { "type": "number" }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "score", "percentile", "date" ], "additionalProperties": false }, { "type": "null" } ] }, "cvss": { "anyOf": [ { "type": "object", "properties": { "score": { "type": "number" }, "fromNvd": { "type": "boolean" } }, "required": [ "score", "fromNvd" ], "additionalProperties": false }, { "type": "null" } ] }, "attribution": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "references": { "type": "array", "items": { "type": "string" } }, "packages": { "type": "array", "items": { "type": "object", "properties": { "ecosystem": { "type": "string" }, "name": { "type": "string" }, "range": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "range", "fixed" ], "additionalProperties": false } }, "sites": { "type": "array", "items": { "type": "object", "properties": { "inventory": { "anyOf": [ { "type": "object", "properties": { "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "completeness": { "type": "string", "enum": [ "complete", "partial", "unknown" ] }, "stale": { "type": "boolean" } }, "required": [ "receivedAt", "completeness", "stale" ], "additionalProperties": false }, { "type": "null" } ] }, "id": { "type": "string" }, "host": { "type": "string" }, "handled": { "type": "boolean" }, "relevance": { "type": "string", "enum": [ "affected_dependency", "potentially_affected" ] }, "evidence": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "fixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "seenLive": { "type": "boolean" } }, "required": [ "name", "version", "fixed", "seenLive" ], "additionalProperties": false } } }, "required": [ "id", "host", "handled", "relevance", "evidence" ], "additionalProperties": false } } }, "required": [ "id", "title", "source", "kind", "severity", "provenance", "publishedAt", "exploited", "ids", "tech", "attribution", "references", "packages", "sites" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "items", "nextCursor", "limitations" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/sites": { "get": { "operationId": "agentListSites", "summary": "A page of sites with their latest scans.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_list_sites", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 1024 } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "items": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "name": { "type": "string" }, "status": { "type": "string" }, "baseDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latestPulse": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, { "type": "null" } ] }, "latestDeep": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, { "type": "null" } ] }, "latestBox": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, { "type": "null" } ] }, "webPath": { "type": "string" }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "id", "name", "status", "baseDomain", "latestPulse", "latestDeep", "latestBox", "webPath", "webUrl" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } }, "post": { "operationId": "agentAddSite", "summary": "Add a site, or return the one with that address.", "description": "Needs a key with the `sites` permission.", "x-lockpick-mcp-tool": "lockpick_add_site", "x-lockpick-scopes": [ "sites" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "idempotencyKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "url", "idempotencyKey" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "site": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "name": { "type": "string" }, "status": { "type": "string" }, "baseDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latestPulse": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, { "type": "null" } ] }, "latestDeep": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, { "type": "null" } ] }, "latestBox": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, { "type": "null" } ] }, "webPath": { "type": "string" }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "id", "name", "status", "baseDomain", "latestPulse", "latestDeep", "latestBox", "webPath", "webUrl" ], "additionalProperties": false }, "created": { "type": "boolean" } }, "required": [ "site", "created" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/sites/{siteId}/status": { "get": { "operationId": "agentSiteStatus", "summary": "One site's standing: its latest scans and what to do next.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_site_status", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "site": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "name": { "type": "string" }, "status": { "type": "string" }, "baseDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latestPulse": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, { "type": "null" } ] }, "latestDeep": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, { "type": "null" } ] }, "latestBox": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, { "type": "null" } ] }, "webPath": { "type": "string" }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "id", "name", "status", "baseDomain", "latestPulse", "latestDeep", "latestBox", "webPath", "webUrl" ], "additionalProperties": false }, "latestPulse": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] }, "baselineRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "object", "properties": { "critical": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "high": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "medium": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "low": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "info": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "critical", "high", "medium", "low", "info" ], "additionalProperties": false }, "findingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "requests": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "message", "percent", "pages", "requests" ], "additionalProperties": false }, { "type": "null" } ] }, "coverage": { "type": "object", "properties": { "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "percent", "limitations" ], "additionalProperties": false }, "caveats": { "type": "array", "items": { "type": "string" } }, "outcome": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "enum": [ "full", "headers-only", "blocked", "transport", "unreachable", "terminal-failure" ] }, "coverage": { "type": "string", "enum": [ "page", "headers-and-records", "records-only", "none" ] }, "reason": { "type": "string", "enum": [ "no-address", "dns-error", "private-address", "refused", "no-answer", "connection-closed", "certificate", "old-tls", "large-headers", "invalid-response", "www", "other-site", "sign-in", "redirect-loop", "redirect", "bot-check", "denied", "rate-limited", "not-found", "gone", "client-error", "server-error", "maintenance", "parked", "empty", "not-html", "app-shell", "interrupted", "not-delivered" ] }, "vendor": { "type": "string", "enum": [ "cloudflare", "vercel", "other" ] }, "blockedBy": { "type": "string", "maxLength": 40, "pattern": "^[a-z0-9-]+$" }, "homepageStatus": { "type": "integer", "minimum": 100, "maximum": 599 }, "redirectOrigin": { "type": "string", "maxLength": 300 }, "contacted": { "type": "boolean" } }, "required": [ "level", "coverage" ], "additionalProperties": false }, { "type": "null" } ] }, "exposureCheck": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "clear", "found", "not-run", "partial", "could-not-run" ] }, "limits": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "no-source-map", "source-map-unread", "robots-excluded", "budget", "deadline", "slowdown", "rate-limited", "bot-check", "cancelled", "stopped" ] } }, "sourceMap": { "type": "string", "enum": [ "published", "none", "not-checked" ] } }, "required": [ "state", "limits", "sourceMap" ], "additionalProperties": false } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds", "baselineRunId", "open", "findingCount", "progress", "coverage", "caveats", "outcome" ], "additionalProperties": false }, { "type": "null" } ] }, "latestDeep": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] }, "baselineRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "object", "properties": { "critical": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "high": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "medium": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "low": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "info": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "critical", "high", "medium", "low", "info" ], "additionalProperties": false }, "findingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "requests": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "message", "percent", "pages", "requests" ], "additionalProperties": false }, { "type": "null" } ] }, "coverage": { "type": "object", "properties": { "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "percent", "limitations" ], "additionalProperties": false }, "caveats": { "type": "array", "items": { "type": "string" } }, "outcome": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "enum": [ "full", "headers-only", "blocked", "transport", "unreachable", "terminal-failure" ] }, "coverage": { "type": "string", "enum": [ "page", "headers-and-records", "records-only", "none" ] }, "reason": { "type": "string", "enum": [ "no-address", "dns-error", "private-address", "refused", "no-answer", "connection-closed", "certificate", "old-tls", "large-headers", "invalid-response", "www", "other-site", "sign-in", "redirect-loop", "redirect", "bot-check", "denied", "rate-limited", "not-found", "gone", "client-error", "server-error", "maintenance", "parked", "empty", "not-html", "app-shell", "interrupted", "not-delivered" ] }, "vendor": { "type": "string", "enum": [ "cloudflare", "vercel", "other" ] }, "blockedBy": { "type": "string", "maxLength": 40, "pattern": "^[a-z0-9-]+$" }, "homepageStatus": { "type": "integer", "minimum": 100, "maximum": 599 }, "redirectOrigin": { "type": "string", "maxLength": 300 }, "contacted": { "type": "boolean" } }, "required": [ "level", "coverage" ], "additionalProperties": false }, { "type": "null" } ] }, "exposureCheck": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "clear", "found", "not-run", "partial", "could-not-run" ] }, "limits": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "no-source-map", "source-map-unread", "robots-excluded", "budget", "deadline", "slowdown", "rate-limited", "bot-check", "cancelled", "stopped" ] } }, "sourceMap": { "type": "string", "enum": [ "published", "none", "not-checked" ] } }, "required": [ "state", "limits", "sourceMap" ], "additionalProperties": false } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds", "baselineRunId", "open", "findingCount", "progress", "coverage", "caveats", "outcome" ], "additionalProperties": false }, { "type": "null" } ] }, "latestBox": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] }, "baselineRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "object", "properties": { "critical": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "high": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "medium": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "low": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "info": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "critical", "high", "medium", "low", "info" ], "additionalProperties": false }, "findingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "requests": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "message", "percent", "pages", "requests" ], "additionalProperties": false }, { "type": "null" } ] }, "coverage": { "type": "object", "properties": { "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "percent", "limitations" ], "additionalProperties": false }, "caveats": { "type": "array", "items": { "type": "string" } }, "outcome": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "enum": [ "full", "headers-only", "blocked", "transport", "unreachable", "terminal-failure" ] }, "coverage": { "type": "string", "enum": [ "page", "headers-and-records", "records-only", "none" ] }, "reason": { "type": "string", "enum": [ "no-address", "dns-error", "private-address", "refused", "no-answer", "connection-closed", "certificate", "old-tls", "large-headers", "invalid-response", "www", "other-site", "sign-in", "redirect-loop", "redirect", "bot-check", "denied", "rate-limited", "not-found", "gone", "client-error", "server-error", "maintenance", "parked", "empty", "not-html", "app-shell", "interrupted", "not-delivered" ] }, "vendor": { "type": "string", "enum": [ "cloudflare", "vercel", "other" ] }, "blockedBy": { "type": "string", "maxLength": 40, "pattern": "^[a-z0-9-]+$" }, "homepageStatus": { "type": "integer", "minimum": 100, "maximum": 599 }, "redirectOrigin": { "type": "string", "maxLength": 300 }, "contacted": { "type": "boolean" } }, "required": [ "level", "coverage" ], "additionalProperties": false }, { "type": "null" } ] }, "exposureCheck": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "clear", "found", "not-run", "partial", "could-not-run" ] }, "limits": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "no-source-map", "source-map-unread", "robots-excluded", "budget", "deadline", "slowdown", "rate-limited", "bot-check", "cancelled", "stopped" ] } }, "sourceMap": { "type": "string", "enum": [ "published", "none", "not-checked" ] } }, "required": [ "state", "limits", "sourceMap" ], "additionalProperties": false } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds", "baselineRunId", "open", "findingCount", "progress", "coverage", "caveats", "outcome" ], "additionalProperties": false }, { "type": "null" } ] }, "lastComparison": { "anyOf": [ { "type": "object", "properties": { "baselineRunId": { "type": "string" }, "new": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "persistent": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "absent": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "unknown": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "baselineRunId", "new", "persistent", "absent", "unknown" ], "additionalProperties": false }, { "type": "null" } ] }, "caveats": { "maxItems": 5, "type": "array", "items": { "type": "string", "maxLength": 300 } }, "relevant": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "affects_you", "may_affect_you", "seen_live", "actively_exploited", "fixed" ] }, "advisoryId": { "type": "string", "maxLength": 120 }, "title": { "type": "string", "maxLength": 300 }, "advisoryIds": { "maxItems": 10, "type": "array", "items": { "type": "string", "maxLength": 120 } }, "package": { "anyOf": [ { "type": "string", "maxLength": 214 }, { "type": "null" } ] }, "version": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] }, "fixedVersion": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] }, "findingId": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "appearedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "kind", "advisoryId", "title", "advisoryIds", "package", "version", "fixedVersion", "findingId", "appearedAt", "webUrl" ], "additionalProperties": false } }, "relevantTotal": { "type": "integer", "minimum": 0, "maximum": 50 } }, "required": [ "site", "latestPulse", "latestDeep", "latestBox", "lastComparison", "caveats" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/sites/{siteId}/dependencies": { "post": { "operationId": "agentSendDependencies", "summary": "Send the package names and exact versions a site pins, never code, and read which advisories affect them.", "description": "Needs a key with the `sites` permission.", "x-lockpick-mcp-tool": "lockpick_send_dependencies", "x-lockpick-scopes": [ "sites" ], "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "inventory": { "type": "object", "properties": { "completeness": { "default": "unknown", "type": "string", "enum": [ "complete", "partial", "unknown" ] }, "revision": { "type": "string", "maxLength": 200 }, "environment": { "default": "unknown", "type": "string", "enum": [ "production", "staging", "development", "unknown" ] } }, "additionalProperties": false }, "packages": { "maxItems": 10000, "type": "array", "items": { "type": "object", "properties": { "ecosystem": { "type": "string", "enum": [ "npm", "pypi" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 214, "pattern": "^[@A-Za-z0-9._~/-]+$" }, "version": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[0-9A-Za-z.+!_~-]+$" } }, "required": [ "ecosystem", "name", "version" ], "additionalProperties": false } }, "sources": { "maxItems": 6, "type": "array", "items": { "type": "string", "enum": [ "package-lock.json", "npm-shrinkwrap.json", "pnpm-lock.yaml", "yarn.lock", "requirements.txt", "poetry.lock" ] } }, "idempotencyKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "packages", "sources", "idempotencyKey" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "siteId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "receivedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "sources": { "maxItems": 6, "type": "array", "items": { "type": "string", "enum": [ "package-lock.json", "npm-shrinkwrap.json", "pnpm-lock.yaml", "yarn.lock", "requirements.txt", "poetry.lock" ] } }, "packageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "affectsYouCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "affectsYou": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "advisoryId": { "type": "string", "maxLength": 120 }, "title": { "type": "string", "maxLength": 300 }, "ecosystem": { "type": "string", "enum": [ "npm", "pypi" ] }, "name": { "type": "string", "maxLength": 214 }, "version": { "type": "string", "maxLength": 128 }, "fixedVersion": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] }, "severity": { "type": "string", "enum": [ "critical", "high", "medium", "low", "unknown" ] }, "exploited": { "type": "boolean" }, "urgency": { "type": "string", "enum": [ "exploited", "likely", "elevated", "standard" ] }, "seenLive": { "type": "boolean" }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "advisoryId", "title", "ecosystem", "name", "version", "fixedVersion", "severity", "exploited", "urgency", "seenLive", "webUrl" ], "additionalProperties": false } }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "siteId", "receivedAt", "sources", "packageCount", "affectsYouCount", "affectsYou", "webUrl" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/sites/{siteId}/pulse": { "post": { "operationId": "agentStartPulse", "summary": "Start a Pulse on a site.", "description": "Needs a key with the `pulse` permission.", "x-lockpick-mcp-tool": "lockpick_start_pulse", "x-lockpick-scopes": [ "pulse" ], "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "baselineScanId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" } }, "required": [ "idempotencyKey" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "scan": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] }, "baselineRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "object", "properties": { "critical": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "high": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "medium": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "low": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "info": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "critical", "high", "medium", "low", "info" ], "additionalProperties": false }, "findingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "requests": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "message", "percent", "pages", "requests" ], "additionalProperties": false }, { "type": "null" } ] }, "coverage": { "type": "object", "properties": { "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "percent", "limitations" ], "additionalProperties": false }, "caveats": { "type": "array", "items": { "type": "string" } }, "outcome": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "enum": [ "full", "headers-only", "blocked", "transport", "unreachable", "terminal-failure" ] }, "coverage": { "type": "string", "enum": [ "page", "headers-and-records", "records-only", "none" ] }, "reason": { "type": "string", "enum": [ "no-address", "dns-error", "private-address", "refused", "no-answer", "connection-closed", "certificate", "old-tls", "large-headers", "invalid-response", "www", "other-site", "sign-in", "redirect-loop", "redirect", "bot-check", "denied", "rate-limited", "not-found", "gone", "client-error", "server-error", "maintenance", "parked", "empty", "not-html", "app-shell", "interrupted", "not-delivered" ] }, "vendor": { "type": "string", "enum": [ "cloudflare", "vercel", "other" ] }, "blockedBy": { "type": "string", "maxLength": 40, "pattern": "^[a-z0-9-]+$" }, "homepageStatus": { "type": "integer", "minimum": 100, "maximum": 599 }, "redirectOrigin": { "type": "string", "maxLength": 300 }, "contacted": { "type": "boolean" } }, "required": [ "level", "coverage" ], "additionalProperties": false }, { "type": "null" } ] }, "exposureCheck": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "clear", "found", "not-run", "partial", "could-not-run" ] }, "limits": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "no-source-map", "source-map-unread", "robots-excluded", "budget", "deadline", "slowdown", "rate-limited", "bot-check", "cancelled", "stopped" ] } }, "sourceMap": { "type": "string", "enum": [ "published", "none", "not-checked" ] } }, "required": [ "state", "limits", "sourceMap" ], "additionalProperties": false } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds", "baselineRunId", "open", "findingCount", "progress", "coverage", "caveats", "outcome" ], "additionalProperties": false }, "charged": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "pilot_pulse", "pilot_deep", "credit", "none" ] }, "amount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "unit", "amount" ], "additionalProperties": false }, "allowance": { "type": "object", "properties": { "accessSource": { "type": "string", "enum": [ "community", "stripe", "pilot", "none" ] }, "accountingMode": { "type": "string", "enum": [ "pilot", "credits", "unmetered" ] }, "pulse": { "type": "object", "properties": { "remaining": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "resetsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] } }, "required": [ "remaining", "limit", "resetsAt" ], "additionalProperties": false }, "deep": { "type": "object", "properties": { "remaining": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "resetsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] } }, "required": [ "remaining", "limit", "resetsAt" ], "additionalProperties": false }, "creditBalance": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "freeSiteId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, { "type": "null" } ] }, "freeSiteVisible": { "type": "boolean" }, "canSwitchFreeSite": { "type": "boolean" } }, "required": [ "accessSource", "accountingMode", "pulse", "deep", "creditBalance", "freeSiteId", "freeSiteVisible", "canSwitchFreeSite" ], "additionalProperties": false }, "replayed": { "type": "boolean" } }, "required": [ "scan", "charged", "allowance", "replayed" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/sites/{siteId}/deep-verifications": { "post": { "operationId": "agentStartDeepVerification", "summary": "Issue a DNS or file ownership proof before a Deep scan.", "description": "Needs a key with the `deep` permission.", "x-lockpick-mcp-tool": "lockpick_start_deep_verification", "x-lockpick-scopes": [ "deep" ], "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "dns", "file", "meta" ] }, "idempotencyKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "method", "idempotencyKey" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "verificationId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "siteId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "origin": { "type": "string", "maxLength": 2048, "format": "uri" }, "method": { "type": "string", "enum": [ "dns", "file", "meta" ] }, "state": { "type": "string", "enum": [ "pending", "verified", "expired", "exhausted", "revoked" ] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "verifiedUntil": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "attemptsRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "retryAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "value": { "type": "string", "minLength": 1, "maxLength": 500 }, "location": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": [ "verificationId", "siteId", "origin", "method", "state", "expiresAt", "verifiedUntil", "attemptsRemaining", "retryAfterSeconds", "value", "location" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/sites/{siteId}/deep-verifications/{verificationId}/verify": { "post": { "operationId": "agentCheckDeepVerification", "summary": "Check a published ownership proof. Each check uses one of its attempts.", "description": "Needs a key with the `deep` permission.", "x-lockpick-mcp-tool": "lockpick_check_deep_verification", "x-lockpick-scopes": [ "deep" ], "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "verificationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "verificationId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "siteId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "origin": { "type": "string", "maxLength": 2048, "format": "uri" }, "method": { "type": "string", "enum": [ "dns", "file", "meta" ] }, "state": { "type": "string", "enum": [ "pending", "verified", "expired", "exhausted", "revoked" ] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "verifiedUntil": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "attemptsRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "retryAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "verificationId", "siteId", "origin", "method", "state", "expiresAt", "verifiedUntil", "attemptsRemaining", "retryAfterSeconds" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/sites/{siteId}/deep-operations": { "post": { "operationId": "agentPrepareDeep", "summary": "Prepare a Deep scan and get the link where the person approves it.", "description": "Needs a key with the `deep` permission.", "x-lockpick-mcp-tool": "lockpick_prepare_deep", "x-lockpick-scopes": [ "deep" ], "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "verificationId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "idempotencyKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "verificationId", "idempotencyKey" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "operationId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "siteId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "origin": { "type": "string", "maxLength": 2048, "format": "uri" }, "assessmentLevel": { "type": "string", "const": "deep" }, "verificationId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "cost": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "pilot_pulse", "pilot_deep", "credit", "none" ] }, "amount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "unit", "amount" ], "additionalProperties": false }, "allowance": { "type": "object", "properties": { "accessSource": { "type": "string", "enum": [ "community", "stripe", "pilot", "none" ] }, "accountingMode": { "type": "string", "enum": [ "pilot", "credits", "unmetered" ] }, "pulse": { "type": "object", "properties": { "remaining": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "resetsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] } }, "required": [ "remaining", "limit", "resetsAt" ], "additionalProperties": false }, "deep": { "type": "object", "properties": { "remaining": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "resetsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] } }, "required": [ "remaining", "limit", "resetsAt" ], "additionalProperties": false }, "creditBalance": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "freeSiteId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, { "type": "null" } ] }, "freeSiteVisible": { "type": "boolean" }, "canSwitchFreeSite": { "type": "boolean" } }, "required": [ "accessSource", "accountingMode", "pulse", "deep", "creditBalance", "freeSiteId", "freeSiteVisible", "canSwitchFreeSite" ], "additionalProperties": false }, "approvalState": { "type": "string", "enum": [ "pending", "approved", "expired", "denied" ] }, "approvalUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "operationId", "siteId", "origin", "assessmentLevel", "verificationId", "cost", "allowance", "approvalState", "approvalUrl", "expiresAt" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/deep-operations/{operationId}/start": { "post": { "operationId": "agentStartDeep", "summary": "Start a Deep scan the person approved.", "description": "Needs a key with the `deep` permission.", "x-lockpick-mcp-tool": "lockpick_start_deep", "x-lockpick-scopes": [ "deep" ], "parameters": [ { "name": "operationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "scan": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] }, "baselineRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "object", "properties": { "critical": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "high": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "medium": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "low": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "info": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "critical", "high", "medium", "low", "info" ], "additionalProperties": false }, "findingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "requests": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "message", "percent", "pages", "requests" ], "additionalProperties": false }, { "type": "null" } ] }, "coverage": { "type": "object", "properties": { "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "percent", "limitations" ], "additionalProperties": false }, "caveats": { "type": "array", "items": { "type": "string" } }, "outcome": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "enum": [ "full", "headers-only", "blocked", "transport", "unreachable", "terminal-failure" ] }, "coverage": { "type": "string", "enum": [ "page", "headers-and-records", "records-only", "none" ] }, "reason": { "type": "string", "enum": [ "no-address", "dns-error", "private-address", "refused", "no-answer", "connection-closed", "certificate", "old-tls", "large-headers", "invalid-response", "www", "other-site", "sign-in", "redirect-loop", "redirect", "bot-check", "denied", "rate-limited", "not-found", "gone", "client-error", "server-error", "maintenance", "parked", "empty", "not-html", "app-shell", "interrupted", "not-delivered" ] }, "vendor": { "type": "string", "enum": [ "cloudflare", "vercel", "other" ] }, "blockedBy": { "type": "string", "maxLength": 40, "pattern": "^[a-z0-9-]+$" }, "homepageStatus": { "type": "integer", "minimum": 100, "maximum": 599 }, "redirectOrigin": { "type": "string", "maxLength": 300 }, "contacted": { "type": "boolean" } }, "required": [ "level", "coverage" ], "additionalProperties": false }, { "type": "null" } ] }, "exposureCheck": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "clear", "found", "not-run", "partial", "could-not-run" ] }, "limits": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "no-source-map", "source-map-unread", "robots-excluded", "budget", "deadline", "slowdown", "rate-limited", "bot-check", "cancelled", "stopped" ] } }, "sourceMap": { "type": "string", "enum": [ "published", "none", "not-checked" ] } }, "required": [ "state", "limits", "sourceMap" ], "additionalProperties": false } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds", "baselineRunId", "open", "findingCount", "progress", "coverage", "caveats", "outcome" ], "additionalProperties": false }, "charged": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "pilot_pulse", "pilot_deep", "credit", "none" ] }, "amount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "unit", "amount" ], "additionalProperties": false }, "allowance": { "type": "object", "properties": { "accessSource": { "type": "string", "enum": [ "community", "stripe", "pilot", "none" ] }, "accountingMode": { "type": "string", "enum": [ "pilot", "credits", "unmetered" ] }, "pulse": { "type": "object", "properties": { "remaining": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "resetsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] } }, "required": [ "remaining", "limit", "resetsAt" ], "additionalProperties": false }, "deep": { "type": "object", "properties": { "remaining": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "resetsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] } }, "required": [ "remaining", "limit", "resetsAt" ], "additionalProperties": false }, "creditBalance": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "freeSiteId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, { "type": "null" } ] }, "freeSiteVisible": { "type": "boolean" }, "canSwitchFreeSite": { "type": "boolean" } }, "required": [ "accessSource", "accountingMode", "pulse", "deep", "creditBalance", "freeSiteId", "freeSiteVisible", "canSwitchFreeSite" ], "additionalProperties": false }, "replayed": { "type": "boolean" } }, "required": [ "scan", "charged", "allowance", "replayed" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/free-site-switch": { "post": { "operationId": "agentSwitchFreeSite", "summary": "Remove a site so this month's free Pulse can move to another.", "description": "Needs a key with the `sites` and `pulse` permission.", "x-lockpick-mcp-tool": "lockpick_switch_free_site", "x-lockpick-scopes": [ "sites", "pulse" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "removeSiteId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "checkId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "idempotencyKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "confirmRemoval": { "type": "boolean", "const": true } }, "required": [ "removeSiteId", "idempotencyKey", "confirmRemoval" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "removedSiteId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "removedSiteHost": { "type": "string", "minLength": 1, "maxLength": 253 }, "replacementSiteId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, { "type": "null" } ] }, "allowance": { "type": "object", "properties": { "accessSource": { "type": "string", "enum": [ "community", "stripe", "pilot", "none" ] }, "accountingMode": { "type": "string", "enum": [ "pilot", "credits", "unmetered" ] }, "pulse": { "type": "object", "properties": { "remaining": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "resetsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] } }, "required": [ "remaining", "limit", "resetsAt" ], "additionalProperties": false }, "deep": { "type": "object", "properties": { "remaining": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "resetsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] } }, "required": [ "remaining", "limit", "resetsAt" ], "additionalProperties": false }, "creditBalance": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "freeSiteId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, { "type": "null" } ] }, "freeSiteVisible": { "type": "boolean" }, "canSwitchFreeSite": { "type": "boolean" } }, "required": [ "accessSource", "accountingMode", "pulse", "deep", "creditBalance", "freeSiteId", "freeSiteVisible", "canSwitchFreeSite" ], "additionalProperties": false }, "restoreUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "startedScanId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, { "type": "null" } ] }, "charged": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "pilot_pulse", "pilot_deep", "credit", "none" ] }, "amount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "unit", "amount" ], "additionalProperties": false }, "replayed": { "type": "boolean" } }, "required": [ "removedSiteId", "removedSiteHost", "replacementSiteId", "allowance", "restoreUrl", "startedScanId", "charged", "replayed" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/scans": { "get": { "operationId": "agentListScans", "summary": "A page of scans, newest first, with filters.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_list_scans", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "siteId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" } }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pulse", "box" ] } }, { "name": "assessmentLevel", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pulse", "standard", "deep" ] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 1024 } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "items": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/scans/{scanId}": { "get": { "operationId": "agentGetScan", "summary": "One scan with its status and headline.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_get_scan", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "target": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "cancelling", "succeeded", "incomplete", "failed", "cancelled" ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "autonomous", "authenticated", "active" ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webPath": { "type": "string" }, "assessmentLevel": { "anyOf": [ { "type": "string", "enum": [ "pulse", "standard", "deep" ] }, { "type": "null" } ] }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] }, "letter": { "anyOf": [ { "type": "string", "enum": [ "A", "B", "C", "D" ] }, { "type": "null" } ] } }, "required": [ "score", "grade", "letter" ], "additionalProperties": false }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] }, "baselineRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "object", "properties": { "critical": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "high": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "medium": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "low": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "info": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "critical", "high", "medium", "low", "info" ], "additionalProperties": false }, "findingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "requests": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "message", "percent", "pages", "requests" ], "additionalProperties": false }, { "type": "null" } ] }, "coverage": { "type": "object", "properties": { "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "limitations": { "type": "array", "items": { "type": "string" } } }, "required": [ "percent", "limitations" ], "additionalProperties": false }, "caveats": { "type": "array", "items": { "type": "string" } }, "outcome": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "enum": [ "full", "headers-only", "blocked", "transport", "unreachable", "terminal-failure" ] }, "coverage": { "type": "string", "enum": [ "page", "headers-and-records", "records-only", "none" ] }, "reason": { "type": "string", "enum": [ "no-address", "dns-error", "private-address", "refused", "no-answer", "connection-closed", "certificate", "old-tls", "large-headers", "invalid-response", "www", "other-site", "sign-in", "redirect-loop", "redirect", "bot-check", "denied", "rate-limited", "not-found", "gone", "client-error", "server-error", "maintenance", "parked", "empty", "not-html", "app-shell", "interrupted", "not-delivered" ] }, "vendor": { "type": "string", "enum": [ "cloudflare", "vercel", "other" ] }, "blockedBy": { "type": "string", "maxLength": 40, "pattern": "^[a-z0-9-]+$" }, "homepageStatus": { "type": "integer", "minimum": 100, "maximum": 599 }, "redirectOrigin": { "type": "string", "maxLength": 300 }, "contacted": { "type": "boolean" } }, "required": [ "level", "coverage" ], "additionalProperties": false }, { "type": "null" } ] }, "exposureCheck": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "clear", "found", "not-run", "partial", "could-not-run" ] }, "limits": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "no-source-map", "source-map-unread", "robots-excluded", "budget", "deadline", "slowdown", "rate-limited", "bot-check", "cancelled", "stopped" ] } }, "sourceMap": { "type": "string", "enum": [ "published", "none", "not-checked" ] } }, "required": [ "state", "limits", "sourceMap" ], "additionalProperties": false } }, "required": [ "id", "kind", "projectId", "target", "status", "mode", "createdAt", "finishedAt", "webPath", "assessmentLevel", "headline", "webUrl", "suggestedPollAfterSeconds", "baselineRunId", "open", "findingCount", "progress", "coverage", "caveats", "outcome" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/scans/{scanId}/findings": { "get": { "operationId": "agentListFindings", "summary": "A page of findings of a scan.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_list_findings", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "attention", "information", "unknown", "pass" ] } }, { "name": "severity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] } }, { "name": "all", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 1024 } }, { "name": "x-lockpick-agent-features", "in": "header", "required": false, "description": "Send `x-lockpick-agent-features: finding-code` to receive each finding's `code` (`LP-` and six characters, as the web report shows it). Without the header the answer has no `code`, the shape older clients expect.", "schema": { "type": "string", "examples": [ "finding-code" ] } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "items": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string", "pattern": "^LP-[0-9A-HJKMNP-TV-Z]{6}$" }, "runId": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "severity": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, "state": { "type": "string", "enum": [ "attention", "information", "unknown", "pass" ] }, "category": { "type": "string" }, "title": { "type": "string" }, "meaning": { "type": "string" }, "fix": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "confidence": { "type": "string" }, "evidence": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "string" } }, "steps": { "type": "array", "items": { "type": "string" } }, "webPath": { "type": "string" }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "evidenceTrust": { "type": "string", "const": "untrusted_scanned_content" }, "evidenceTruncated": { "type": "boolean" }, "verdict": { "anyOf": [ { "type": "string", "enum": [ "confirmed", "needs_review", "not_actionable" ] }, { "type": "null" } ] }, "certainty": { "anyOf": [ { "type": "string", "enum": [ "high", "medium", "low" ] }, { "type": "null" } ] }, "exploitability": { "anyOf": [ { "type": "string", "enum": [ "direct", "conditional", "hygiene", "none" ] }, { "type": "null" } ] }, "proof": { "anyOf": [ { "type": "object", "properties": { "source": { "type": "string", "maxLength": 300 }, "control": { "type": "string", "maxLength": 300 }, "sink": { "type": "string", "maxLength": 300 }, "impact": { "type": "string", "maxLength": 300 } }, "required": [ "source", "control", "sink", "impact" ], "additionalProperties": false }, { "type": "null" } ] }, "proofGap": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgency": { "type": "string", "enum": [ "now", "week", "later", "none" ] }, "howSure": { "anyOf": [ { "type": "string", "enum": [ "confirmed", "likely", "possible" ] }, { "type": "null" } ] } }, "required": [ "id", "runId", "kind", "severity", "state", "category", "title", "meaning", "fix", "confidence", "evidence", "sources", "steps", "webPath", "webUrl", "evidenceTrust", "evidenceTruncated" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/scans/{scanId}/findings/{findingId}": { "get": { "operationId": "agentGetFinding", "summary": "One finding with its redacted evidence.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_get_finding", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-lockpick-agent-features", "in": "header", "required": false, "description": "Send `x-lockpick-agent-features: finding-code` to receive each finding's `code` (`LP-` and six characters, as the web report shows it). Without the header the answer has no `code`, the shape older clients expect.", "schema": { "type": "string", "examples": [ "finding-code" ] } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string", "pattern": "^LP-[0-9A-HJKMNP-TV-Z]{6}$" }, "runId": { "type": "string" }, "kind": { "type": "string", "enum": [ "pulse", "box" ] }, "severity": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, "state": { "type": "string", "enum": [ "attention", "information", "unknown", "pass" ] }, "category": { "type": "string" }, "title": { "type": "string" }, "meaning": { "type": "string" }, "fix": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "confidence": { "type": "string" }, "evidence": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "string" } }, "steps": { "type": "array", "items": { "type": "string" } }, "webPath": { "type": "string" }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "evidenceTrust": { "type": "string", "const": "untrusted_scanned_content" }, "evidenceTruncated": { "type": "boolean" }, "verdict": { "anyOf": [ { "type": "string", "enum": [ "confirmed", "needs_review", "not_actionable" ] }, { "type": "null" } ] }, "certainty": { "anyOf": [ { "type": "string", "enum": [ "high", "medium", "low" ] }, { "type": "null" } ] }, "exploitability": { "anyOf": [ { "type": "string", "enum": [ "direct", "conditional", "hygiene", "none" ] }, { "type": "null" } ] }, "proof": { "anyOf": [ { "type": "object", "properties": { "source": { "type": "string", "maxLength": 300 }, "control": { "type": "string", "maxLength": 300 }, "sink": { "type": "string", "maxLength": 300 }, "impact": { "type": "string", "maxLength": 300 } }, "required": [ "source", "control", "sink", "impact" ], "additionalProperties": false }, { "type": "null" } ] }, "proofGap": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgency": { "type": "string", "enum": [ "now", "week", "later", "none" ] }, "howSure": { "anyOf": [ { "type": "string", "enum": [ "confirmed", "likely", "possible" ] }, { "type": "null" } ] } }, "required": [ "id", "runId", "kind", "severity", "state", "category", "title", "meaning", "fix", "confidence", "evidence", "sources", "steps", "webPath", "webUrl", "evidenceTrust", "evidenceTruncated" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/scans/{scanId}/repair-brief": { "get": { "operationId": "agentRepairBrief", "summary": "One part of a scan's repair brief.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_get_repair_brief", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "findingId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\x21-\\x7e]+$" } }, { "name": "agent", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "claude-code", "codex", "cursor", "vscode", "opencode", "lovable", "bolt", "replit", "v0" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 1024 } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "scanId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "findingIds": { "maxItems": 100, "type": "array", "items": { "type": "string" } }, "saved": { "type": "boolean" }, "markdown": { "type": "string" }, "nextCursor": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] }, "complete": { "type": "boolean" }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "scanId", "findingIds", "saved", "markdown", "nextCursor", "complete", "webUrl" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/scans/{scanId}/comparison": { "get": { "operationId": "agentCompareScans", "summary": "What changed between a scan and the one it rechecks.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_compare_scans", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-lockpick-agent-features", "in": "header", "required": false, "description": "Send `x-lockpick-agent-features: finding-code` to receive each finding's `code` (`LP-` and six characters, as the web report shows it). Without the header the answer has no `code`, the shape older clients expect.", "schema": { "type": "string", "examples": [ "finding-code" ] } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "runId": { "type": "string" }, "baselineRunId": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string", "pattern": "^LP-[0-9A-HJKMNP-TV-Z]{6}$" }, "change": { "type": "string", "enum": [ "new", "persistent", "absent", "unknown" ] }, "area": { "type": "string", "enum": [ "configuration", "exposure" ] }, "title": { "type": "string" }, "severity": { "type": "string" }, "explanation": { "type": "string" }, "outcome": { "anyOf": [ { "type": "string", "enum": [ "fixed", "still_vulnerable", "inconclusive" ] }, { "type": "null" } ] } }, "required": [ "id", "change", "area", "title", "severity", "explanation" ], "additionalProperties": false } }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "runId", "baselineRunId", "error", "changes", "webUrl" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/scans/{scanId}/dns-rechecks": { "post": { "operationId": "agentRecheckDns", "summary": "Run the free DNS check again for a scan. Sends nothing to the site.", "description": "Needs a key with the `pulse` permission.", "x-lockpick-mcp-tool": "lockpick_recheck_dns", "x-lockpick-scopes": [ "pulse" ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "findingId": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\x21-\\x7e]+$" }, "idempotencyKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "findingId", "idempotencyKey" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "scanId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "findingIds": { "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\x21-\\x7e]+$" } }, "pending": { "anyOf": [ { "type": "object", "properties": { "findingId": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\x21-\\x7e]+$" }, "requestedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "findingId", "requestedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "outcomes": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "findingId": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\x21-\\x7e]+$" }, "outcome": { "type": "string", "enum": [ "fixed", "still_vulnerable", "inconclusive" ] }, "explanation": { "type": "string", "maxLength": 500 } }, "required": [ "findingId", "outcome", "explanation" ], "additionalProperties": false } }, "nextAllowedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "failedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "originalGradeUnchanged": { "type": "boolean", "const": true } }, "required": [ "scanId", "findingIds", "pending", "checkedAt", "outcomes", "nextAllowedAt", "failedAt", "originalGradeUnchanged" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/scans/{scanId}/dns-rechecks/latest": { "get": { "operationId": "agentGetDnsRecheck", "summary": "A scan's latest DNS check again.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_get_dns_recheck", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "scanId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "scanId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "findingIds": { "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\x21-\\x7e]+$" } }, "pending": { "anyOf": [ { "type": "object", "properties": { "findingId": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\x21-\\x7e]+$" }, "requestedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "findingId", "requestedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "outcomes": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "findingId": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\x21-\\x7e]+$" }, "outcome": { "type": "string", "enum": [ "fixed", "still_vulnerable", "inconclusive" ] }, "explanation": { "type": "string", "maxLength": 500 } }, "required": [ "findingId", "outcome", "explanation" ], "additionalProperties": false } }, "nextAllowedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "failedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "originalGradeUnchanged": { "type": "boolean", "const": true } }, "required": [ "scanId", "findingIds", "pending", "checkedAt", "outcomes", "nextAllowedAt", "failedAt", "originalGradeUnchanged" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/quick-checks": { "post": { "operationId": "agentQuickCheck", "summary": "Start a free quick check of a homepage.", "description": "Needs a key with the `pulse` permission.", "x-lockpick-mcp-tool": "lockpick_quick_check", "x-lockpick-scopes": [ "pulse" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "idempotencyKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "url", "idempotencyKey" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "checkId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "status": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed" ] }, "reused": { "type": "boolean" }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] } }, "required": [ "score", "grade" ], "additionalProperties": false }, "summary": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "checks": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "title": { "type": "string", "maxLength": 200 }, "outcome": { "type": "string", "enum": [ "attention", "pass", "unknown", "information" ] }, "explanation": { "type": "string", "maxLength": 500 } }, "required": [ "id", "title", "outcome", "explanation" ], "additionalProperties": false } }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "checkId", "status", "reused", "headline", "summary", "checks", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/repository-checks": { "post": { "operationId": "agentCheckRepository", "summary": "Check a public GitHub repository (a skill, plugin, MCP server or app) before installing it.", "description": "Needs a key with the `pulse` permission.", "x-lockpick-mcp-tool": "lockpick_check_repository", "x-lockpick-scopes": [ "pulse" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "minLength": 3, "maxLength": 2048 }, "mode": { "type": "string", "enum": [ "skill", "app" ] }, "depth": { "type": "string", "enum": [ "free", "deep" ] }, "idempotencyKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "url", "idempotencyKey" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "checkId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "status": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed" ] }, "reused": { "type": "boolean" }, "repository": { "type": "object", "properties": { "slug": { "type": "string", "maxLength": 140 }, "path": { "type": "string", "maxLength": 1024 }, "sha": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{40}$" }, { "type": "null" } ] }, "url": { "type": "string", "maxLength": 1500 } }, "required": [ "slug", "path", "sha", "url" ], "additionalProperties": false }, "mode": { "anyOf": [ { "type": "string", "enum": [ "skill", "app" ] }, { "type": "null" } ] }, "kind": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "verdict": { "anyOf": [ { "type": "string", "enum": [ "safe", "caution", "do_not_install" ] }, { "type": "null" } ] }, "appRisk": { "anyOf": [ { "type": "string", "enum": [ "low", "elevated", "high" ] }, { "type": "null" } ] }, "score": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "summary": { "anyOf": [ { "type": "string", "maxLength": 600 }, { "type": "null" } ] }, "plainSummary": { "anyOf": [ { "type": "string", "maxLength": 400 }, { "type": "null" } ] }, "findings": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "rule": { "type": "string", "maxLength": 80 }, "severity": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, "verdict": { "type": "string", "enum": [ "confirmed", "needs_review" ] }, "location": { "type": "string", "maxLength": 1100 }, "title": { "type": "string", "maxLength": 300 }, "fix": { "type": "string", "maxLength": 600 }, "urgency": { "type": "string", "enum": [ "now", "week", "later", "none" ] } }, "required": [ "rule", "severity", "verdict", "location", "title", "fix" ], "additionalProperties": false } }, "moreFindings": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coverage": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "complete", "partial", "failed" ] }, "gaps": { "maxItems": 5, "type": "array", "items": { "type": "string", "maxLength": 400 } } }, "required": [ "status", "gaps" ], "additionalProperties": false }, { "type": "null" } ] }, "failure": { "anyOf": [ { "type": "string", "enum": [ "not-found", "ref-not-found", "empty", "too-large", "rate-limited", "unavailable", "timeout", "engine-error" ] }, { "type": "null" } ] }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "checkId", "status", "reused", "repository", "mode", "kind", "verdict", "appRisk", "score", "summary", "plainSummary", "findings", "moreFindings", "coverage", "failure", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/repository-checks/{checkId}": { "get": { "operationId": "agentGetRepositoryCheck", "summary": "A repository check and its findings.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_get_repository_check", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "checkId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "status": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed" ] }, "reused": { "type": "boolean" }, "repository": { "type": "object", "properties": { "slug": { "type": "string", "maxLength": 140 }, "path": { "type": "string", "maxLength": 1024 }, "sha": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{40}$" }, { "type": "null" } ] }, "url": { "type": "string", "maxLength": 1500 } }, "required": [ "slug", "path", "sha", "url" ], "additionalProperties": false }, "mode": { "anyOf": [ { "type": "string", "enum": [ "skill", "app" ] }, { "type": "null" } ] }, "kind": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "verdict": { "anyOf": [ { "type": "string", "enum": [ "safe", "caution", "do_not_install" ] }, { "type": "null" } ] }, "appRisk": { "anyOf": [ { "type": "string", "enum": [ "low", "elevated", "high" ] }, { "type": "null" } ] }, "score": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "summary": { "anyOf": [ { "type": "string", "maxLength": 600 }, { "type": "null" } ] }, "plainSummary": { "anyOf": [ { "type": "string", "maxLength": 400 }, { "type": "null" } ] }, "findings": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "rule": { "type": "string", "maxLength": 80 }, "severity": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, "verdict": { "type": "string", "enum": [ "confirmed", "needs_review" ] }, "location": { "type": "string", "maxLength": 1100 }, "title": { "type": "string", "maxLength": 300 }, "fix": { "type": "string", "maxLength": 600 }, "urgency": { "type": "string", "enum": [ "now", "week", "later", "none" ] } }, "required": [ "rule", "severity", "verdict", "location", "title", "fix" ], "additionalProperties": false } }, "moreFindings": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coverage": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "complete", "partial", "failed" ] }, "gaps": { "maxItems": 5, "type": "array", "items": { "type": "string", "maxLength": 400 } } }, "required": [ "status", "gaps" ], "additionalProperties": false }, { "type": "null" } ] }, "failure": { "anyOf": [ { "type": "string", "enum": [ "not-found", "ref-not-found", "empty", "too-large", "rate-limited", "unavailable", "timeout", "engine-error" ] }, { "type": "null" } ] }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "checkId", "status", "reused", "repository", "mode", "kind", "verdict", "appRisk", "score", "summary", "plainSummary", "findings", "moreFindings", "coverage", "failure", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/quick-checks/{checkId}": { "get": { "operationId": "agentGetQuickCheck", "summary": "A quick check and its result.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_get_quick_check", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "checkId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "status": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed" ] }, "reused": { "type": "boolean" }, "headline": { "type": "object", "properties": { "score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string", "enum": [ "locked-tight", "mostly-shut", "door-ajar", "wide-open" ] }, { "type": "null" } ] } }, "required": [ "score", "grade" ], "additionalProperties": false }, "summary": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "checks": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "title": { "type": "string", "maxLength": 200 }, "outcome": { "type": "string", "enum": [ "attention", "pass", "unknown", "information" ] }, "explanation": { "type": "string", "maxLength": 500 } }, "required": [ "id", "title", "outcome", "explanation" ], "additionalProperties": false } }, "webUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "suggestedPollAfterSeconds": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 60 }, { "type": "null" } ] } }, "required": [ "checkId", "status", "reused", "headline", "summary", "checks", "webUrl", "suggestedPollAfterSeconds" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/docs/search": { "get": { "operationId": "agentSearchDocs", "summary": "Search Lockpick's public docs.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_search_docs", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 8, "type": "integer", "minimum": 1, "maximum": 20 } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "query": { "type": "string", "maxLength": 200 }, "results": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "maxLength": 300 }, "title": { "type": "string", "maxLength": 200 }, "section": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "heading": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "snippet": { "type": "string", "maxLength": 600 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "markdownUrl": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "path", "title", "section", "heading", "snippet", "url", "markdownUrl" ], "additionalProperties": false } } }, "required": [ "query", "results" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } }, "/api/cli/v1/agent/docs/page": { "get": { "operationId": "agentReadDoc", "summary": "One public docs page as Markdown, in parts when it is long.", "description": "Needs a key with the `read` permission.", "x-lockpick-mcp-tool": "lockpick_read_doc", "x-lockpick-scopes": [ "read" ], "parameters": [ { "name": "path", "in": "query", "required": false, "schema": { "default": "", "type": "string", "maxLength": 300, "pattern": "^[a-z0-9/._#:-]*$" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 1024 } } ], "responses": { "200": { "description": "It worked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "path": { "type": "string", "maxLength": 300 }, "title": { "type": "string", "maxLength": 200 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "markdownUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "markdown": { "type": "string" }, "nextCursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 1024 }, { "type": "null" } ] }, "complete": { "type": "boolean" } }, "required": [ "path", "title", "description", "url", "markdownUrl", "markdown", "nextCursor", "complete" ], "additionalProperties": false }, "error": { "type": "null" } }, "required": [ "data", "error" ] } } } }, "default": { "description": "It did not work: a missing or expired key (401), a missing permission (403), something not found (404), a limit reached (429) or bad input (400).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "null" }, "error": { "type": "string", "description": "What went wrong, in plain words." }, "errorCode": { "type": "string" } }, "required": [ "data", "error" ] } } } } } } } } }