Skip to main content

Your submission was sent successfully! Close

Thank you for signing up for our newsletter!
In these regular emails you will find the latest updates from Canonical and upcoming events where you can meet our team.Close

Thank you for contacting us. A member of our team will be in touch shortly. Close

An error occurred while submitting your form. Please try again or file a bug report. Close

API profile

In the MAAS CLI, an API profile represents a stored set of credentials and connection details for a specific MAAS server. Profiles enable users to manage multiple MAAS environments efficiently by maintaining separate authentication contexts.

Managing API profiles:

  • Login – Authenticate and create a profile using the login command.

  • List – Display all stored profiles with the list command.

  • Switch – Execute commands under a specific profile by prefixing the profile name to a command invocation.

  • Refresh – Update the CLI’s cached information about the MAAS server’s API with the refresh command.

  • Logout – Remove a profile and its credentials using the logout command.

Interact seamlessly with multiple MAAS environments by defining and managing profiles carefully.

Previous API login Next API reference

Last updated 7 months ago. Help improve this document in the forum.