ContainerSSH 0.4.1: Bugfixing Audit & Proxy is now available! Read more »
You're not viewing the latest version. Click here to go to latest.
logo
ContainerSSH: Launch containers on demand
About the API
Initializing search
    GitHub
    • Home
    • Use cases
    • Getting started
    • Guides
    • Downloads
    • Reference manual
    • Development
    • Blog
    GitHub
    • Home
      • Lab
      • Debugging a production system
      • Web hosting
      • Learning environments
      • Honeypots
      • Security
      • Quick Start
      • Architecture
      • Installation
      • Configuration
      • Authentication Server
        • Selecting a Backend
        • The Docker Backend
        • The Kubernetes Backend
        • The SSH Proxy Backend
      • FAQ
      • Getting Help
      • Overview
      • Honeypot
      • Logging to the ELK stack with Docker and Fluentd
    • Downloads
      • Overview
      • Installation
        • Configuration
        • Supported features
        • Backend selection
        • Docker
        • Kubernetes
        • SSH proxy
        • DockerRun (deprecated)
        • KubeRun (deprecated)
        • Authentication
        • Configuration server
        • API
        • Creating Guest Images
        • Logging
        • Audit logging
        • Metrics
        • Restrictions
        • Hardening guide
        • Troubleshooting guide
        • Message codes
          • Overview
          • Installation
            • Configuration
            • Supported features
            • Connection forwarding
            • Backend selection
            • Docker
            • Kubernetes
            • SSH proxy
            • Overview
            • Webhook
            • oAuth2
            • Kerberos
            • Configuration server
            • Creating Guest Images
            • Logging
            • Audit logging
            • Health checks
            • Metrics
            • Restrictions
            • Hardening guide
          • HTTP client and server
            • Troubleshooting guide
            • Message codes
          • Overview
          • Installation
            • Configuration
            • Supported features
            • Backend selection
            • Docker
            • Kubernetes
            • SSH proxy
            • DockerRun (deprecated)
            • KubeRun (deprecated)
            • Authentication
            • Configuration server
            • API
            • Creating Guest Images
            • Logging
            • Audit logging
            • Metrics
            • Restrictions
            • Hardening guide
            • Troubleshooting guide
            • Message codes
          • Overview
          • Installation
            • Backend selection
            • DockerRun
            • KubeRun
            • Authentication
            • Configuration server
            • API
            • Logging
            • Metrics
            • Hardening guide
            • Creating a guest image
      • Overview
      • Getting Started
      • Dashboard
      • Coding Style
        • Overview
        • Installing GPG (optional)
        • Installing Golang
        • Installing the QA tools
        • Installing Docker
        • Installing Kubernetes
        • Setting up your IDE
        • Setting up the website
        • Overview
        • Understanding SSH
        • Writing your first SSH server
        • Internal Architecture
        • Overview
        • Libraries
        • Binaries
        • Overview
        • GitHub
        • Terraform
        • Snyk
        • Docker
      • ContainerSSH 0.4.1: Bugfixing Audit & Proxy
      • DevLog: SSH authentication via OAuth2
      • ContainerSSH 0.4: Audit & Proxy
      • We messed up
      • Announcing the ContainerSSH Guest Agent
      • The Road to ContainerSSH 0.4

    About the API

    ContainerSSH itself does not have an API apart from exposing the metrics. However, it requires two external APIs: the authentication server for user authentication and the config server for supplying a user-specific container configuration.

    We are providing an OpenAPI document for both.

    Access the OpenAPI docs »

    Copyright © The ContainerSSH Contributors | About Us | Packages | Security | Deprecations | License | Brand assets | Privacy Policy | Imprint

    Cloud Native Computing Foundation
    We are a Cloud Native Computing Foundation sandbox project.

    The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see Trademark Usage. Docker and the Docker logo are trademarks of Docker, Inc.
    Made with Material for MkDocs