Docs
  • Home
  • Antsle One Setup
  • Antsle Nano Setup
  • Antsle Two Setup
  • Get Started
    • edgeLinux Installation
      • Installing edgeLinux on Oracle VirtualBox
    • Log in to the edgeLinux OS
    • Name Your Antsle/Nano
    • Setting Up Your Tech Stack
      • WordPress
      • Gitlab
      • Jenkins
  • Antlets
    • Antlets Overview
    • Create and Manage an Antlet
    • Antlet Details
    • Access Antlets
    • Virtual Drives
    • Backing Up Antlets
      • Self-Managed Restoration (Beta)
  • Templates
    • Templates Overview
    • Install OS from .iso
    • Import VM Images
    • Using the LEMP-Stack
    • Using Nextcloud
    • Using OPNsense
  • Networking
    • Networking Overview
    • Configure IP Addresses
    • Bridged Networking / Virtual NIC
    • Wifi on the Antsle Nano
    • Port Forwarding
    • Load Balancing
    • SDN: Software Defined Networking
  • System
    • Antsle Distributed Storage - ADS
    • Multi-Node
    • Secure (HTTPS) Access to Antman
    • Secure FTP (SFTP) Access
    • USB Drives
    • Docker Support
    • LDAP/SSO
    • antMan REST API
    • The antMan Terraform Provider
    • Access Your HDD (or SSD) Add-on
    • Setting Up Shared Storage Volume
    • edgeLinux OS
    • Windows License
  • antHill and Account Management
  • Troubleshooting
    • Reset edgeLinux on a Pi or Antsle Nano
    • Known Issues
  • FAQs
  • Protector Mode
Powered by GitBook
On this page

Was this helpful?

  1. System

antMan REST API

PreviousLDAP/SSONextThe antMan Terraform Provider

Last updated 5 years ago

Was this helpful?

The antMan REST API may change at any time.

You can view the swagger-ui using the following url

http://myantsle.local/swagger-ui

If you have renamed your Antsle, replace 'myantsle' in the URL with the name of your antsle - or the antsles private IP address. The URL (localhost:4444) in the following images is unique to our lab setup. AntMan is actually listening on port 3000.

First you need to authenticate and receive an access token

Open the 'auth' section

And open the /api/login section Click in the 'Example Value' box to populate the 'Bodyxxx' field. Edit the values of the json object with your antlse's username and password. Click 'Try it out!'

This will give you an example cURL command to authenticate and retrieve an access token. The 'Response Body' field contains your access token

In subsequent calls you would add an 'Authorization' header to the cURL command with your access token.

--header 'Authorization: Token eyJhbGciO...'
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/octet-stream' --header 'Authorization: Token eyJhbGciO...'