Lineaje

API endpoints for Lineaje image patching operations. These endpoints allow users to patch OS vulnerabilities in container images and check the status of patching operations.

Patch OS Vulnerabilities in Container Image

post

Initiates an OS vulnerability patching operation for a specified container image. This endpoint leverages Copacetic to patch known vulnerabilities in container images without requiring a full image rebuild.

Use Cases

• Security Remediation: Automatically patch vulnerable OS packages in container images.

• Compliance: Ensure container images meet security compliance requirements by patching known CVEs.

• CI/CD Integration: Integrate image patching into your deployment pipeline for continuous security.

---

Process Details

1. The request is validated and forwarded to the patching service.

2. A unique UUID is returned to track the patching operation.

3. Use the status endpoint with the UUID to monitor progress.

---

Important Notes!

• Asynchronous Operation: Patching is performed asynchronously. Use the status endpoint to check progress.

• Image Registry: The image must be accessible from the configured registry.

• Supported Formats: Only OCI-compliant container images are supported.

Authorizations

bearerAuth

AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Body

application/json

imagestringRequired

The full container image reference including registry, repository, and tag.

Example: docker.io/library/nginx:1.21.0

registrystringOptional

The container registry URL (optional if included in image reference).

Example: docker.io

tagstringOptional

The target tag for the patched image.

Example: 1.21.0-patched

scannerTypestring · enumOptional

The vulnerability scanner type to use.

Default: trivyExample: trivyPossible values:

Responses

200

Patching operation initiated successfully

application/json

statusstringOptional

Status of the operation

Example: success

messagestringOptional

Descriptive message about the operation

Example: Image patching initiated successfully

uuidstringOptional

Unique identifier to track the patching operation

Example: 550e8400-e29b-41d4-a716-446655440000

400

Bad Request - Invalid or missing input data

application/json

401

Unauthorized - Authentication failed or insufficient permissions

application/json

500

Internal Server Error - Patching operation failed

application/json

post

/api/v2/lineaje/image/patch

HTTPcURLJavaScriptPython

POST /api/v2/lineaje/image/patch HTTP/1.1
Host: api.[organization].opsera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "image": "docker.io/library/nginx:1.21.0"
}

Basic image patchingPatch with custom output tag

{
  "status": "success",
  "message": "Image patching initiated successfully",
  "uuid": "550e8400-e29b-41d4-a716-446655440000"
}

Get Image Patching Operation Status

get

Retrieves the current status of an image patching operation using the UUID returned from the initial patch request.

Use Cases

• Progress Monitoring: Track the progress of an ongoing patching operation.

• Completion Verification: Confirm when patching is complete before deploying the patched image.

• Error Handling: Retrieve error details if the patching operation failed.

---

Status Values

• pending: The patching operation is queued and waiting to start.

• in_progress: The patching operation is currently running.

• completed: The patching operation completed successfully.

• failed: The patching operation encountered an error.

---

Important Notes!

• Polling: For long-running operations, poll this endpoint periodically to check status.

• UUID Expiry: Status information may be retained for a limited time after completion.

Authorizations

bearerAuth

AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Path parameters

uuidstring · uuidRequired

The unique identifier returned from the image patch initiation request.

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Successfully retrieved patching operation status

application/json

statusstringOptional

Overall response status

Example: success

patchStatusstring · enumOptional

Current status of the patching operation

Example: completedPossible values:

messagestringOptional

Descriptive message about the current status

Example: Image patching completed successfully

patchedImagestringOptional

The reference to the patched image (available when completed)

Example: docker.io/library/nginx:1.21.0-patched

progressinteger · max: 100Optional

Percentage of completion (0-100)

Example: 100

startedAtstring · date-timeOptional

Timestamp when the patching operation started

Example: 2026-01-19T10:30:00Z

completedAtstring · date-timeOptional

Timestamp when the patching operation completed (if finished)

Example: 2026-01-19T10:35:00Z

400

Bad Request - Invalid UUID format

application/json

401

Unauthorized - Authentication failed or insufficient permissions

application/json

404

Not Found - Patching operation not found for the given UUID

application/json

500

Internal Server Error - Failed to retrieve status

application/json

get

/api/v2/lineaje/image/patch/status/{uuid}

HTTPcURLJavaScriptPython

GET /api/v2/lineaje/image/patch/status/{uuid} HTTP/1.1
Host: api.[organization].opsera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "patchStatus": "completed",
  "message": "Image patching completed successfully",
  "patchedImage": "docker.io/library/nginx:1.21.0-patched",
  "progress": 100,
  "startedAt": "2026-01-19T10:30:00Z",
  "completedAt": "2026-01-19T10:35:00Z"
}