{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"22e52c59-3fd4-4728-bb6f-293acd270316","name":"LoadMaster RESTful APIv1 Documentation","description":"This document describes the RESTful API Interface to the LoadMaster. It describes in detail how to configure the various features of the LoadMaster using the RESTful API.\n\nIn LoadMaster firmware version 7.2.50, functionality was added which allows you to specify API requests as a POST of a JSON object and receive a JSON-based API payload response. POST is not required for input data - the GET method can also be used for this.\n\nFor example requests and responses using the JSON-based format, refer to the following documentation: [https://loadmasterapiv2.docs.progress.com](https://loadmasterapiv2.docs.progress.com/)\n\nThis document provides example requests in cURL format and example responses in XML format.\n\nThis document does not explain each of the features or options in detail. For further information, refer to the relevant document on [https://docs.progress.com](https://docs.progress.com)\n\n## Intended Audience\n\nThis document is intended to help anyone who wants to configure the LoadMaster using the RESTful API.\n\n## Setting Collection-Level Variables\n\nClicking **Run in Postman** in the top-right of the LoadMaster API documentation allows you to import this collection into your Postman instance.\n\nA number of collection-level variables are used throughout the commands and you can set the values of these variables by following these steps in Postman:\n\n1. Click **Collections**.\n \n2. Click the **LoadMaster RESTful API Documentation** collection.\n \n3. Click **Variables**.\n \n4. Set the value of the variable.\n \n\nAfter setting the value of the relevant variables, you should be able to run the commands in the collection successfully against your LoadMaster.\n\n# The RESTful API Interface\n\nThis document describes an interface designed to allow remote applications access to the LoadMaster in a simple and consistent manner. The interface is a REST-like interface. REST (Representational State Transfer) is a style of software architecture for distributed systems and is one of the predominant web service design models\n\n## How the LoadMaster RESTful API Works\n\nThe LoadMaster RESTful API works in a RESTful manner, by allowing a user or application to pass HTTPS requests to the LoadMaster. The LoadMaster answers the request with an XML formatted response. The HTTPS request is in the format:\n\n```\nhttps:///access/?=value&=value\n\n ```\n\nYou can also run the commands using cURL. If you are using cURL, you may need to surround the URL in double quotes for it to work, for example:\n\n```\ncurl -k \"https://bal:@/access/set?param=backupmethod&value=sftp\"\n\n ```\n\nWhen you run commands using cURL, you may also need to include **\\-k** or **\\--insecure** if you are using the self-signed LoadMaster certificate.\n\nThe basic interface is a simple HTTPS GET operation where the command is specified by the URL. If any parameters are required by the operation, they are passed as QUERY parameters.\n\n> When using the API there is a maximum URL length of 1K. If you want to set a value which is longer than this, use a POST operation instead. \n \n\nThe following points should be noted regarding the formatting of the HTTPS request:\n\n- Only one command can be given at a time.\n \n- The '?' character signifies the end of a command.\n \n- The '&' character signifies the end of a parameter/value pair.\n \n- If there are any unnecessary parameter/value pairs, they will be ignored.\n \n- The order in which the parameter/value pairs appear does not matter\n \n- There cannot be any spaces within the query. Although some applications, like browsers, would convert spaces to HTML code prior to sending the string to the LoadMaster.\n \n- Multiple parameters can be modified within the same command.\n \n\nFor example, the following query will return the maximum cache size from a LoadMaster with the IP address of 10.11.0.20.\n\n```\nhttps://InsertIPAddress/access/get?param=cachesize\n\n ```\n\nThe response to the query, from the LoadMaster, is returned in an easily decoded XML format, for example:\n\n```\n\n \n \n \n 100\n \n \n \n\n\n ```\n\n> Not all commands in this document are allowed on all LoadMasters. Some \nfunctions are only available for certain LoadMaster licenses. \n \n> The connection drops if more than 30 calls are performed in less than 3 seconds over all API interfaces. \n \n\n## Security\n\nAn application can only access the LoadMaster using the standard IP address. Security is provided in exactly the same way as over the standard User Interface (UI), that is, valid credentials must be passed on every access when using Basic Authentication.\n\nThe user **bal** naturally has access to all functionality; other users have access to the subsystems that have been assigned to them using the LoadMaster permissions.\n\nCurrently there is no way to modify user permissions using this interface.\n\nDepending on security settings and whether the browser has ever connected to the WUI before adding login information may be required. In this case instead of a standard command format such as:\n\n```\nhttps:///access/?params\n\n ```\n\nthe login information would need to be included, for example:\n\n```\nhttps://:@/access/?params\n\n ```\n\nYou can also use certificate-based authentication or API keys.\n\nFor instructions on how to use certificate based authentication, refer to the **Configure Certificate-Based Authentication** section.\n\nFor instructions on how to use API keys, refer to the [How to Use API Keys](#a5982ecb-1e3a-4b1b-95b0-25a351a26c21) section.\n\n### Configure Certificate-Based Authentication\n\nFollow the steps in the sections below to configure certificate-based authentication.\n\nCertificate-based authentication is not supported in version 2 of the API (which is currently in beta).\n\nCertificate-based authentication will be deprecated for version 1 at some point in the future. Instead, use API keys. For further details, refer to the [How to Use API Keys ](#a5982ecb-1e3a-4b1b-95b0-25a351a26c21) section.\n\n#### Enable Session Management\n\nYou must enable **Session Management** before you can enable client certificate authentication. To enable Session Management, follow the steps below:\n\n1. In the main menu of the LoadMaster WUI, go to **Certificates & Security > Admin WUI Access**.\n \n2. Select the **Enable Session Management** check box. \n **Note:** After this check box is selected, you must log in to continue using the LoadMaster.\n \n3. Configure any other settings as needed.\n \n\n#### Create a User (If Needed)\n\nIt is not possible to use certificate-based authentication with the **bal** user. However, you can create a non-**bal** user and grant it **All Permissions**, or whatever permissions you want. If you do not already have another user created, you can add one by following these steps:\n\n1. In the main menu of the LoadMaster WUI, expand **System Configuration > System Administration** and click **User Management**.\n \n2. At the bottom of the screen, enter a username in the **User** text box.\n \n3. At this point, you can either set a **Password** for the new user, or select the **No Local Password** check box. \n **Note:** For further information on the **No Local Password** option and on certificate authentication in general, refer to the [User Management, Feature Description](https://docs.progress.com/bundle/loadmaster-feature-description-user-management-ga).\n \n4. Click **Add User**.\n \n\n#### Enable Client Certificate Authentication on the LoadMaster\n\nA number of different login methods are available to enable. For steps on how to set the **Admin Login Method**, along with a description of each of the available methods, refer to the steps below:\n\n1. In the main menu of the LoadMaster WUI, expand **Certificates & Security** and click **Remote Access**.\n \n2. Select the relevant **Admin Login Method**.\n \n\n> The **Pre-Auth Click Through Banner** in the **Admin WUI Access** screen must be set for all **Admin Login Method** options to be made available. \n \n> Using local certificates only works with API authentication. Because of this, it might be best to select the **Password or Client certificate** option. This enables API access using the client certificate and WUI access using the username/password. \n \n\nThe following login methods are available:\n\n- **Password Only Access (default):** This option provides access using the username and password only – there is no access using client certificates.\n \n- **Password or Client certificate:** You can log in either using the username/password or using a valid client certificate. If a valid client certificate is in place, the username and password is not required. The LoadMaster asks the client for a certificate. If a client certificate is available, the LoadMaster checks for a match. The LoadMaster checks if the certificate matches one of the local certificates, or checks if the Subject Alternative Name (SAN) or Common Name (CN) of the certificate is a match. The SAN is used in preference to the CN when performing a match. If there is a match, you are granted access to the LoadMaster. This works both using the API and user interface. An invalid certificate will not allow access.If no client certificate is supplied, the LoadMaster expects that a username and password is supplied (for the API) or will request a password using the standard WUI login page\n \n- **Client certificate required:** Access is only allowed with the use of a client certificate. It is not possible to log in using the username and password. SSH access is not affected by this (only the **bal** user can log in using SSH).\n \n- **Client certificate required (Verify via OCSP):** This is the same as the **Client certificate required** option, but the client certificate is verified using an OCSP service. You must configure the OCSP \n Server Settings for this to work. For further information on the OCSP Server Settings, refer to the [SSL Accelerated Services, Feature Description](https://docs.progress.com/bundle/loadmaster-feature-description-ssl-accelerated-services-ga).\n \n\nSome points to note regarding the client certificate methods are below:\n\n- The **bal** user does not have a client certificate. Therefore, it is not possible to log into the LoadMaster as **bal** using the **Client certificate required** methods. However, a non-**bal** user can be created and granted **All Permissions**. This will allow the same functionality as the **bal** user.\n \n- There is no log out option for users that are logged in to the WUI using client certificates, as it is not possible to log out (if the user did log out the next access would automatically log them back in again). The session terminates when the page is closed, or when the browser is restarted.\n \n\n#### Generate and Download the Client Certificate\n\nTo generate a local certificate, follow the steps below:\n\n> Users with **User Administration** permissions are able to manage local certificates for themselves and other users. \n \n\n1. In the main menu of the LoadMaster WUI, navigate to **System Configuration > System Administration > User Management**.\n \n2. Click **Modify** on the relevant user.\n \n3. Enter a **Passphrase** and click **Generate**. \n **Note:** Entering a passphrase is optional. If a passphrase is entered, it is used to encrypt the private key.\n \n4. Click **OK** to the pop-up message that appears.\n \n5. Click **Download**.\n \n\nYou can also regenerate from this screen.\n\n#### Specify the Certificate Details in the API\n\nAfter configuring all of the options as outlined in the above sections, you must specify the details of the certificate to run the API commands successfully. You must also run the command as a cURL command, for example:\n\n```\ncurl -k -E /.pem https://InsertIPAddress/access/get?param=version\n\n ```\n\n#### Create a PFX File (If Running Commands using a Web Browser)\n\nIf you are running the RESTful APIs from the command line – you can use the PEM file, as indicated in the **Specify the Certificate Details in the API** section. If you want to run RESTful API commands using a web browser, you need to create a PFX file and import that into the browser.\n\nYou can convert the .pem file to .pfx any way you like. For the purposes of this document, we have provided steps on how to do it using OpenSSL. If you are using Windows, you may need to install OpenSSL to run these steps.\n\nTo create a .pfx file using, follow the steps below:\n\n1. Open the .pem certificate.\n \n2. Copy from the start of the **\\-----BEGIN CERTIFICATE-----** section to the end of the **\\-----END CERTIFICATE-----** section.\n \n3. Paste this text into a new file.\n \n4. Save the file as **.cer**.\n \n5. Go to the .pem certificate file again.\n \n6. Copy from the start of the **\\-----BEGIN RSA PRIVATE KEY-----** section to the end of the **\\-----END RSA PRIVATE KEY-----** section.\n \n7. Paste this text into a new file.\n \n8. Save the file as **.key**.\n \n9. Use the **openssl** command to create the .pfx file: \n **openssl pkcs12 -export -out .pfx -inkey .key -in .cer**\n \n10. Import the certificate to the web browser.\n \n\n### API Keys\n\nWhen running API commands, you can authenticate using an API key. An API key is a unique identifier used to authenticate a user.\n\nRefer to the following section for details on how to list, generate, and delete API keys:\n\nHow to Use API Keys\n\nWhen you have an API key, you can perform any command as normal, but you no longer need the username or password.\n\n## Enabling the LoadMaster API Interface\n\nThe API interface is enabled or disabled using the LoadMaster UI. By default the interface is disabled.\n\nTo enable the RESTful API interface complete the following steps:\n\n1. Select the **Certificates & Security > Remote Access** menu option.\n \n2. Select the **Enable API Interface** check box.\n \n\n## Enable Session Management\n\nSession management must be enabled on the LoadMaster to use the JSON-based input and output. To enable session management, follow these steps in the LoadMaster UI:\n\n1. Go to **Certificates & Security > Admin WUI Access**.\n \n2. Select the **Enable Session Management** check box.\n \n\n### Disable Require Basic Authentication\n\nThe **Require Basic Authentication** check box must be disabled on the LoadMaster to use the JSON-based input and output. To disable this option, follow these steps in the LoadMaster UI:\n\n1. Go to **Certificates & Security > Admin WUI Access**.\n \n2. Deselect the **Require Basic Authentication** check box.\n \n\n## Error Reports\n\nIf an error occurs, for example where a request is missing a required parameter, an error report is generated, for example:\n\n```\n\nIncorrect ACME type specified\n\n\n ```\n\nThe HTTP status of the request also reflects the response code.\n\n## Notation\n\nThroughout the document the parameter types are defined as follows:\n\n

Type

Abbreviation

Typical Values

Boolean

B

Y or N; y or n; 1 or 0;

Integer

I

-

String

S

\"value\"

Address

A

IP address

File

F

Some type of file

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"1897577","team":3578882,"collectionId":"22e52c59-3fd4-4728-bb6f-293acd270316","publishedId":"2sAXqnfjxL","public":true,"publicUrl":"https://loadmasterapiv1.docs.progress.com","privateUrl":"https://go.postman.co/documentation/1897577-22e52c59-3fd4-4728-bb6f-293acd270316","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"This document describes the RESTful API Interface to the LoadMaster. It describes (in detail) how to configure the various features of the LoadMaster using the RESTful API."},{"name":"title","value":"LoadMaster RESTful APIv1 documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-09-29T14:36:33.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"LoadMaster RESTful APIv1 documentation","description":"This document describes the RESTful API Interface to the LoadMaster. It describes (in detail) how to configure the various features of the LoadMaster using the RESTful API."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/07c5fd21957548d86689051308371c511f44830f09ffb0d03c58885ee060f402","favicon":"https://progress.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://loadmasterapiv1.docs.progress.com/view/metadata/2sAXqnfjxL"}