canonical: https://jentic.com/apis/versioneye.com/versioneye

# Versioneye API V1

versioneye.com/main version v1. The API exposes 3 endpoints secured with apiKey authentication.

## For AI agents

Programmatically retrieves all scans, retrieves a project scan result. Covers 3 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Retrieves all scans
- Manage developer tools data programmatically
- Integrate API V1 into automated workflows
- Query and filter API V1 records by parameters
- Monitor API V1 operational status and events

## Use cases

### Developer Tools Operations

Use the API V1 to perform developer tools operations programmatically. The API provides 3 endpoints covering core functionality including retrieves all scans, retrieves a project scan result, retrieves a file object, containing information about dependencies in the file.

Example prompt: Call GET `/api/v1/scans` to retrieves all scans

### Automated Scans Management

Automate scans operations by combining multiple API V1 endpoints. Agents can retrieves a project scan result and then retrieves a file object, containing information about dependencies in the file in a single workflow.

Example prompt: Call GET `/api/v1/scans/{id}` to retrieves a project scan result, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call API V1 endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'retrieves all scans', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/v1/scans` | Retrieves all scans |
| GET | `/api/v1/scans/{id}` | Retrieves a project scan result |
| GET | `/api/v1/scans/{id}/files/{file_id}` | Retrieves a file object, containing information about dependencies in the file |

## Key resources

- **Scans** — Operations for scans

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 40 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 87 / 100
  - Developer Experience & Jentic Compatibility: 68 / 100
  - AI-Readiness & Agent Experience: 18 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 50 / 100
- **View full report:** https://jentic.com/apis/versioneye.com/versioneye/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the VersionEye API V1 by hand means passing its apiKey header, pointing at your configured host, and coding each scan and file lookup yourself. Through Jentic you install once, import the API V1 from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** VersionEye puts the scan id in the URL path (`/api/v1/scans/{id}`) and is read-only, so a rule can pin your agent to reading one scan and its files. You choose the operations it may call, and only those reads run.
- **Credential handling:** Your VersionEye API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'retrieve all scans' or 'get files for a scan', and Jentic returns the matching API V1 operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the API V1 use?

The API V1 uses an API key passed in the `apiKey` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I retrieves all scans with the API V1?

Yes. Use the GET `/api/v1/scans` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the API V1?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I retrieves all scans through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'retrieves all scans'. Jentic returns the matching API V1 operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the API V1 have?

The API V1 exposes 3 endpoints covering scans operations.

### Can I limit what my agent is allowed to do with the VersionEye API?

Yes. Jentic One is self-hosted by you, so your own rules decide which VersionEye operations and credentials the agent may use. Because the VersionEye API is read-only and puts the scan id in the URL path (`/api/v1/scans/{id}`), you can pin the agent to a single scan and its dependency files, or grant only listing scans via GET `/api/v1/scans.` Only the reads you allow will run, and the agent cannot reach any operation you have not enabled.
