Apptainer · Schema

ContainerImage

An Apptainer container image (SIF file) for HPC and scientific computing

ContainersHPCScientific ComputingOpen-SourceLinux Foundation

Properties

Name	Type	Description
imageId	string	Unique container image identifier
name	string	Container image name
version	string	Container image version
source	string	Source URI (docker://image, library://image, oras://, etc.)
format	string	Container image format
size	integer	Image size in bytes
createdAt	string	Image creation timestamp
sha256	string	SHA-256 hash of the image for verification

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apptainer/main/json-schema/container-image-schema.json",
  "title": "ContainerImage",
  "description": "An Apptainer container image (SIF file) for HPC and scientific computing",
  "type": "object",
  "properties": {
    "imageId": {
      "type": "string",
      "description": "Unique container image identifier"
    },
    "name": {
      "type": "string",
      "description": "Container image name"
    },
    "version": {
      "type": "string",
      "description": "Container image version"
    },
    "source": {
      "type": "string",
      "description": "Source URI (docker://image, library://image, oras://, etc.)"
    },
    "format": {
      "type": "string",
      "enum": [
        "SIF",
        "sandbox"
      ],
      "description": "Container image format"
    },
    "size": {
      "type": "integer",
      "description": "Image size in bytes"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Image creation timestamp"
    },
    "sha256": {
      "type": "string",
      "description": "SHA-256 hash of the image for verification"
    }
  },
  "required": [
    "imageId",
    "name",
    "format"
  ]
}