The REST API for LGTM provides data so that you can customize how you integrate LGTM analysis into your workflow. It includes the following resources: * `/` ([API root](https://lgtm.com/help/lgtm/api/api-v1#LGTM-API-specification-API-root))—get version information or download the specificati
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://lgtm.com/api/v1.0
auth: b e a r
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
The REST API for LGTM provides data so that you can customize how you integrate LGTM analysis into your workflow. It includes the following resources: * `/` ([API root](https://lgtm.com/help/lgtm/api/api-v1#LGTM-API-specification-API-root))—get version information or download the specification in OpenAPI format. * `/projects` ([Projects](https://lgtm.com/help/lgtm/api/api-v1#LGTM-API-spe
| method | path | what the vendor says it does |
|---|---|---|
GET | / | Version information Get the version information of this API. API root |
GET | /analyses/{analysis-id} | Get analysis summary Get a summary of the analysis results for a specific analysis identifier. To find the an |
GET | /analyses/{analysis-id}/alerts | Get detailed alert information Download all the alerts found by an analysis. Use the `Accept:` request header |
POST | /analyses/{project-id} | Run analysis of a specific commit Trigger the analysis of a specific commit to a project. If a previous attemp |
GET | /analyses/{project-id}/commits/{commit-id} | Get analysis summary for a specific commit Get a summary of the analysis results for a specific commit, or the |
POST | /codereviews/{project-id} | Run code review for a patch Trigger the code review of a patch. This is available for projects with Git reposi |
GET | /codereviews/{review-id} | Get results of code review Get the results of a code review using the review identifier for the task. When yo |
GET | /issues/{project-id}/{alert-key} | Get detailed alert information for an issue Fetch the alert information for an issue in [SARIF](https://lgtm.c |
GET | /openapi | API specification Get the specification of this API in [OpenAPI](https://github.com/OAI/OpenAPI-Specification) |
GET | /operations/{operation-id} | Get operation status Track progress of a long-running operation using the operations identifier returned when |
GET | /projects | List projects List all the projects the current user has authorization to view. A maximum of 100 projects ar |
POST | /projects | Add a project to LGTM LGTM administrators can add a new project to LGTM by providing a repository URL. By defa |
GET | /projects/{project-id} | Get project by numeric identifier Get the latest summary for a specific project using the numeric project iden |
DELETE | /projects/{project-id} | Delete project by numeric identifier Delete a project with a particular numeric project identifier. In additio |
GET | /projects/{project-id}/settings/analysis-configuration | Get configuration for a project identified by numeric identifier Get the latest configuration for a specific p |
PUT | /projects/{project-id}/settings/analysis-configuration | Set the administrator configuration for a project identified by numeric identifier Set the administrator confi |
GET | /projects/{provider}/{org}/{name} | Get project by URL identifier Get the latest summary for a specific project using the project's URL identifier |
POST | /queryjobs | Run a CodeQL query on one or more projects Submit a query to run on one or more projects on LGTM. The query is |
GET | /queryjobs/{queryjob-id} | Get the status of a query job Get the status of a query job using the query job identifier for the task. When |
GET | /queryjobs/{queryjob-id}/results | Provide a summary of results for the projects in the query job This endpoint provides a summary of the results |
GET | /queryjobs/{queryjob-id}/results/{project-id} | Fetch the results of a query job for a specific project Fetch the results for a specific project. The endpoint |
POST | /snapshots/uploads/{session-id} | Complete snapshot upload session Completes the database upload by closing the upload session, upgrading the da |
PUT | /snapshots/uploads/{session-id} | Upload snapshot Upload a database representing a snapshot of a codebase. The database is sent in one or more |
DELETE | /snapshots/uploads/{session-id} | Abort database upload process Aborts the specified upload session and deletes any uploaded parts. After the se |
GET | /snapshots/{project-id}/{language} | Download a snapshot Download a CodeQL database from LGTM, representing a snapshot of the codebase, to run quer |
POST | /snapshots/{project-id}/{language} | Start snapshot upload session Start a session to upload an externally-built database (which represents a snaps |
GET | /system/health | Get a summary of the application's health Return an indication of whether the application is working as expect |
GET | /system/metrics | Get the identifiers and descriptions of the usage metrics LGTM administrators can use this endpoint to list th |
GET | /system/metrics/{metric-id} | Get the computed values of the specified metric LGTM administrators can download usage data using this endpoin |
specification origin: https://lgtm.com/api/v1.0/openapi
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.