Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Teams
, (opens new window)

Confluence Command Line Interface (CLI)
Results will update as you type.
  • Client Reference Types
    • Agile Client Reference
    • CSV Client Reference
    • JSM Client Reference
    • System Client Reference
      • System Client Examples
      • System Client Action Categories
      • System Client Parameters
        • --timeout
        • --exclude
        • --force
        • --include
        • --secret
      • System Client Actions
      • System Client Action Types
    • Web Client Reference
  • User's Guide
  • Administrator's Guide
  • Release notes
    You‘re viewing this with anonymous access, so some content might be blocked.
    /
    System Client Parameters
    Published Nov 18, 2024

    System Client Parameters

    Parameters

    Parameters tell the CLI the specific details needed to perform an action.  Some actions work without any additional details, but most require one or more parameters and accept additional optional parameters to perform the task.

    The CLI requires at least one special parameter named action that tells what action to perform, without the action parameter, CLI displays help with some example actions. Parameters do not have prefixes like actions and are often specific to the app for the action. 

    For example, the action getServerInfo requires details about the app or server from where the information is retrieved. To obtain the required information, the server parameter is used.

    The getServerInfo action also accepts optional parameters such as outputFormat, dateFormat, file, append, and encoding.


    Need support? Create a request with our support team.

    Copyright © 2005 - 2025 Appfire | All rights reserved.

    {"serverDuration": 13, "requestCorrelationId": "704b23a43c614bef8b0f0e2f31da892e"}