• Logo
    Landscape
  • ubuntu.com/landscape
  • More resources
    • Discourse
    • GitHub
Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Landscape documentation
Landscape documentation
  • Landscape Documentation
  • What is Landscape?
  • Tutorial
  • How-to guides
    • Landscape installation and set-up
      • Cloud Providers
        • Install on Google Cloud
        • Install on Microsoft Azure
        • Set up Ubuntu Amazon WorkSpaces
      • Quickstart installation
      • Manual installation
      • Juju installation
      • Juju HA installation
      • Install in a LXD container
      • Install on FIPS-compliant machines
      • Install Landscape Client
      • Configure Landscape Client
      • Configure RabbitMQ
      • Configure Postfix
    • Upgrade
      • Upgrade Landscape
      • Upgrade to Landscape 24.04 LTS
    • Backup and Maintenance
      • Backup and restore
      • Manage maintenance tasks
    • Ubuntu Pro
      • Attach Ubuntu Pro
      • Enable Landscape
    • External authentication
      • Active Directory
      • OIDC
      • PAM
    • Repository mirrors
      • Manage repositories in the web portal
      • Manage repositories with the API
      • Create tiered-repository mirrors
    • Web portal
      • Web portal (24.04 or later)
        • How to manage administrators and roles
        • How to manage access groups
        • How to use annotations
        • How to manage Livepatch and kernel updates from the Landscape web portal
        • How to sanitize instances
        • Scheduling restarts for Landscape Client instances with reboot profiles
        • How to use script profiles
      • Classic web portal
        • How to manage administrators and roles
        • How to manage access groups
        • How to manage computers
        • How to manage packages
        • How to manage snaps
        • Other tasks in the Landscape web portal
    • IoT for devices
      • Install the snap
      • Configure the snap
      • Create an Ubuntu Core image that includes the snap
      • Use remote script execution
      • Use annotations
    • WSL integration
      • Configure Landscape Beta
      • Set up an environment
      • Register WSL hosts
      • Manage WSL instances
      • Use a specific image source
      • Perform common tasks
      • Get support
    • Security
      • Install in an air-gapped environment
      • Manage repositories in an air-gapped environment
      • Harden your deployment
      • Apply security updates
    • API
      • Make a REST API request
      • Use the legacy API
      • Use the legacy API command-line client
      • Use the legacy API via HTTPS requests
      • Use the legacy API Python module
  • Reference
    • API
      • Rest API endpoints
        • Activities
        • Administrators
        • Alerts
        • Beta-only
        • Computers
        • Credentials
        • GPG Key
        • Invitations
        • Livepatch
        • Login
        • Packages
        • Password
        • Person
        • Processes
        • Reboot Profiles
        • Scripts
        • Snaps
        • Switch Account
        • Users
        • WSL
      • Legacy API endpoints
        • Activities
        • Administrators
        • Alerts
        • Computers
        • Event Log
        • GPG
        • Package Profiles
        • Packages
        • Removal Profiles
        • Reporting
        • Repositories
        • Role Based Access Control
        • Saved Searches
        • Scripts
        • Upgrade Profiles
        • WSL
    • Release notes
      • What’s new in beta
      • 24.04 LTS release notes
      • 25.04 release notes
      • 24.10 release notes
      • 23.10 release notes
      • 23.03 release notes
      • Older release notes
        • 19.10 release notes
        • 19.01 release notes
        • 18.03 release notes
        • 17.03 release notes
        • 16.06 release notes
        • 16.03 release notes
        • 15.11 release notes
        • 15.10 release notes
        • 15.01 release notes
        • 14.10 release notes
    • Logs
      • Logs
    • Networking
      • Network firewall
    • Terms
      • Access groups
      • Administrators
      • Alerts
      • Architecture
      • Components
      • Distribution
      • Package
      • Pocket
      • PPA
      • Repositories
      • Roles
      • Scripts
      • Series
      • SSL certificates
      • Suite
      • Tags
      • Profiles
        • Package profile
        • Removal profile
        • Upgrade profile
  • Explanation
    • Landscape
      • About Landscape
      • Deployment models
      • Self-hosted Landscape
      • Licenses
    • Security
      • Security overview
      • Cryptographic technology
      • Disclosure and reporting
      • Data handling
      • AppArmor
    • Repositories
      • Repository mirroring
  • Contribute to our documentation
Back to top
View this page

API¶

  • Rest API endpoints
    • Activities
    • Administrators
    • Alerts
    • Beta-only
    • Computers
    • Credentials
    • GPG Key
    • Invitations
    • Livepatch
    • Login
    • Packages
    • Password
    • Person
    • Processes
    • Reboot Profiles
    • Scripts
    • Snaps
    • Switch Account
    • Users
    • WSL
  • Legacy API endpoints
    • Activities
    • Administrators
    • Alerts
    • Computers
    • Event Log
    • GPG
    • Package Profiles
    • Packages
    • Removal Profiles
    • Reporting
    • Repositories
    • Role Based Access Control
    • Saved Searches
    • Scripts
    • Upgrade Profiles
    • WSL
Copyright © 2025 CC-BY-SA, Canonical Ltd.
Last updated on Jan 25, 2025
Show source
Thanks to our contributor!
  • YanisaHS
Ask a question on Discourse
Open a GitHub issue for this page
Edit this page on GitHub
Contents
  • API