REST API Reference

In addition to querying the graph via GraphQL, rescile provides a dedicated REST endpoint to list and filter all generated output artifacts. This is particularly useful for automation scripts or CI/CD pipelines that need to download specific generated files.

Endpoint: GET /api/outputs/index

This endpoint returns a flat JSON array of all available output artifacts. It scans the graph for all resources containing filename and mimetype properties and identifies their origin resource by following DESCRIBED_BY relationships backwards.

Query Parameters (Filters)

You can filter the returned artifacts using the following URL query parameters:

• origin_type: Filter by the type of the resource that generated the output (e.g., server, application).
• origin_name: Filter by the exact name (primary key) of the origin resource (e.g., server011).
• type: Filter by the type of the generated output resource (e.g., cloudinit).

Example Response

[
  {
    "type": "cloudinit",
    "name": "cloudinit-server011",
    "filename": "cloudinit-server011.yaml",
    "mimetype": "text/x-yaml",
    "hash": "sha256-...",
    "download_url": "/api/outputs/cloudinit/cloudinit-server011/cloudinit-server011.yaml",
    "origin": {
      "type": "server",
      "name": "server011"
    }
  }
]