Welcome to Landscape API’s documentation¶

The Landscape API is a powerful new feature of Landscape that can be used by experienced system administrators or programmers to drive Landscape in many new exciting ways.

Getting started with the API¶

To use the Landscape API in any way, you will need three pieces of information:

API access key
API secret key
API endpoint URL

The access and secret keys can be obtained by logging in on Landscape and clicking on your username in the top right corner.

The endpoint URL will be of the form https://server/api/ (replace server with the FQDN of the Landscape server you are accessing).

Once you have this information, all that is left is to decide how do you want to use the API:

command-line client: easy to use, shell-script friendly
Python module: more powerful, recommended if you want to drive the API via Python
low-level HTTP requests: in the case you want to know what is going on, or write a client for some other language

Available API methods¶

This is the list of available methods in the API by domain:

Table of contents

Next topic

Quick search