Apptainer

Apptainer Instances API

Running container instance management

GitHub OpenAPI

Operations 2

GET /instances Apptainer - List Instances #
POST /instances Apptainer - Start Instance #

Documentation

📖
Documentation
https://apptainer.org/docs/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/apptainer/refs/heads/main/openapi/apptainer-instances-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/apptainer/apptainer

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apptainer/refs/heads/main/json-schema/container-image-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/apptainer/refs/heads/main/json-structure/container-image-structure.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/apptainer/refs/heads/main/examples/container-image-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/apptainer/refs/heads/main/json-ld/apptainer-context.jsonld
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/apptainer/refs/heads/main/rules/apptainer-spectral-rules.yml
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/apptainer/refs/heads/main/vocabulary/apptainer-vocabulary.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/apptainer-instances-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

apptainer-instances-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Apptainer Container Runtime Images Instances API
  description: API for the Apptainer container runtime, enabling programmatic management of HPC container images, instances, and execution for scientific computing workloads. Apptainer (formerly Singularity) is optimized for high-performance computing with support for Docker/OCI containers and HPC schedulers.
  version: 1.0.0
  contact:
    name: Apptainer Project
    url: https://apptainer.org/docs/
  license:
    name: BSD 3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
servers:
- url: https://api.apptainer.org/v1
  description: Apptainer API
security:
- bearerAuth: []
tags:
- name: Instances
  description: Running container instance management
paths:
  /instances:
    get:
      operationId: listInstances
      summary: Apptainer - List Instances
      description: Returns a list of running Apptainer container instances
      tags:
      - Instances
      responses:
        '200':
          description: A list of running instances
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ContainerInstance'
              examples:
                ListInstancesExample:
                  x-microcks-default: true
                  summary: Example instances list
                  value:
                    data:
                    - instanceId: inst-001
                      name: my-simulation
                      imageId: img-ubuntu-22.04-hpc
                      status: running
                      startedAt: '2026-04-19T09:00:00Z'
        '401':
          description: Unauthorized - invalid or missing authentication token
    post:
      operationId: startInstance
      summary: Apptainer - Start Instance
      description: Starts a new container instance from an Apptainer image
      tags:
      - Instances
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                imageId:
                  type: string
                  description: Image to run as a container instance
                name:
                  type: string
                  description: Name for the container instance
                command:
                  type: string
                  description: Optional command to run in the container
            examples:
              StartInstanceExample:
                x-microcks-default: true
                summary: Example instance start request
                value:
                  imageId: img-ubuntu-22.04-hpc
                  name: my-simulation
                  command: /bin/bash run_simulation.sh
      responses:
        '201':
          description: Instance started successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerInstance'
        '400':
          description: Invalid request body
        '401':
          description: Unauthorized - invalid or missing authentication token
components:
  schemas:
    ContainerInstance:
      title: ContainerInstance
      description: A running Apptainer container instance
      type: object
      properties:
        instanceId:
          type: string
          description: Unique instance identifier
        name:
          type: string
          description: Instance name
        imageId:
          type: string
          description: Container image the instance runs
        status:
          type: string
          enum:
          - running
          - stopped
          - error
          description: Instance status
        startedAt:
          type: string
          format: date-time
          description: Instance start timestamp
        stoppedAt:
          type: string
          format: date-time
          description: Instance stop timestamp
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT