• 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 in a DISA STIG compliant environment
      • Install in an airgapped environment
      • 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
      • Remove duplicate instances
    • 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
      • Manage repositories in an airgapped environment
      • Create tiered-repository mirrors
    • Web portal
      • Web portal (24.04 or later)
        • Manage administrators and roles
        • Manage access groups
        • Use annotations
        • Manage Livepatch and kernel updates
        • Sanitize instances
        • Use reboot profiles
        • Use script profiles
        • Use security profiles
        • Manage snaps
      • Classic web portal
        • Manage administrators and roles
        • Manage access groups
        • Manage computers
        • Manage packages
        • Manage snaps
        • Other tasks
    • IoT for devices
      • Install the snap
      • Configure the snap
      • Create an Ubuntu Core image that includes the snap
      • Use remote script execution
      • Use annotations
      • Secure removal
      • Manage snaps with validation sets
    • WSL integration
      • Configure Landscape Beta
      • Set up an environment
      • Register WSL hosts
      • Manage WSL instances
      • Use WSL profiles
      • Use a specific image source
      • Perform common tasks
      • Get support
    • Ubuntu installer
      • Configure a deployment for autoinstall provisioning
      • Set up autoinstall provisioning
      • Provision a workstation
    • Security
      • 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
    • Troubleshooting
      • Idle activities
  • Reference
    • API
      • REST API endpoints
        • Accounts
        • Activities
        • Administrators
        • Alerts
        • Beta-only
        • Child Instance Profiles
        • Computers
        • Credentials
        • GPG Key
        • Invitations
        • License Management
        • Livepatch
        • Login
        • Packages
        • Password
        • Person
        • Processes
        • Reboot Profiles
        • Repositories
        • Repository Profiles
        • Script Profiles
        • Scripts
        • Security Profiles
        • Snaps
        • Switch Account
        • Tokens
        • 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.10 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
    • Configuration
      • Immutable configuration settings
      • The service.conf file
    • Logs
      • Logs
    • Networking
      • Internal network requirements
      • 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
    • Database
    • Known issues
    • lsctl
  • Explanation
    • Landscape
      • About Landscape
      • Deployment models
      • Self-hosted Landscape
      • Landscape Server architecture
      • Landscape Client architecture
      • Licenses
    • Features
      • Activities
      • Repository mirroring
      • Package reporting
      • Remote script execution
    • Security
      • Security overview
      • Cryptographic technology
      • Disclosure and reporting
      • Data handling
      • AppArmor
      • Authentication and authorization
    • Related tools
      • Landscape and Ansible
  • Contribute to our documentation
Back to top

Rest API endpoints¶

  • Accounts
  • Activities
  • Administrators
  • Alerts
  • Beta-only
  • Child Instance Profiles
  • Computers
  • Credentials
  • GPG Key
  • Invitations
  • License Management
  • Livepatch
  • Login
  • Packages
  • Password
  • Person
  • Processes
  • Reboot Profiles
  • Repositories
  • Repository Profiles
  • Script Profiles
  • Scripts
  • Security Profiles
  • Snaps
  • Switch Account
  • Tokens
  • Users
  • WSL
Copyright © 2025 CC-BY-SA, Canonical Ltd.
Last updated on Nov 03, 2025
Manage your tracker settings
Ask a question on Discourse
Edit this page on GitHub
Contents
  • Rest API endpoints