App Versions

REST endpoints for app versions. Bearer-auth required.

GET /api/app-versions

List app versions.

Query parameters

  • limit (optional): Page size (1–100, default 100).
  • after (optional): Keyset cursor — return the page after this row (next page).
  • before (optional): Keyset cursor — return the page before this row (prev page).
  • ids (optional): Comma-separated list of IDs. Narrows results to these IDs within the caller's accessible scope (does not bypass access checks).
  • filter (optional): Nested filter expression (<Entity>Filter): AND/OR/NOT + per-field comparison operators + relation traversal. JSON-encoded on the query string.
  • orderBy (optional): Multi-key sort (<Entity>OrderBy[]): array of { field: direction } applied in order. Directions: asc/desc plus the four explicit nulls variants. JSON-encoded on the query string.
  • app_id (optional): Optional app narrower. Admins see every version when omitted; non-admin callers must scope by app.
  • include_deleted (optional): Soft-deleted version visibility. false (default) — active rows only. true — active plus soft-deleted. only — soft-deleted only.
  • parent_id (optional): Shorthand: filter where parentId equals this value.
  • status (optional): Shorthand: filter where status equals this value.
  • created_by (optional): Shorthand: filter where createdBy equals this value.

Response

JSON
{
  "data": [
    {
      "id": "<...>",
      "appId": "<...>",
      "name": "<...>",
      "parentId": "<...>",
      "status": "<...>",
      "error": "<...>",
      "createdBy": "<...>",
      "createdAt": "<...>",
      "updatedAt": "<...>"
    }
  ],
  "pageInfo": {
    "total": "number",
    "hasNextPage": "boolean",
    "hasPreviousPage": "boolean",
    "startCursor": "string",
    "endCursor": "string"
  }
}

POST /api/app-versions

Create app version

Request body

JSON
{
  "appId": "string",
  "name?": "string",
  "parentId?": "string"
}

Response

JSON
{
  "id": "string",
  "appId": "string",
  "name": "string",
  "parentId": "string",
  "status": "pending | ready | failed",
  "error": "string",
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

GET /api/app-versions/{id}

Get an app version by ID.

Path parameters

  • id (required): App version to retrieve.

Response

JSON
{
  "id": "string",
  "appId": "string",
  "name": "string",
  "parentId": "string",
  "status": "pending | ready | failed",
  "error": "string",
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

DELETE /api/app-versions/{id}

Soft-delete an app version.

Path parameters

  • id (required): App version to soft-delete.

Response

JSON
{
  "success": "boolean"
}

DELETE /api/app-versions/{id}/purge

Permanently delete a soft-deleted app version.

Path parameters

  • id (required): Soft-deleted app version to permanently delete.

Response

JSON
{
  "success": "boolean"
}

POST /api/app-versions/{id}/restore

Restore a soft-deleted app version.

Path parameters

  • id (required): Soft-deleted app version to restore.

Response

JSON
{
  "id": "string",
  "appId": "string",
  "name": "string",
  "parentId": "string",
  "status": "pending | ready | failed",
  "error": "string",
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}