Learn how to implement common use cases with the REST API.
The examples have been implemented for the following tools. See section for usage information:
For these tools to establish a secure connection to the server, you must install a custom HTTPS certificate. Alternatively, you can provide a disable HTTPS connection option to the tool you are using. This is described below for every tool.
For the following examples to work successfully:
usernamemust be your user name.
passwordmust be your password.
servermust be the hos tname of your root server.
portmust be the port of your root server. By default this is 52311.
--cacert option to specify the custom HTTPS certificate. To disable SSL verification, use the
$ pip install requests
Requests verifies SSL certifiates for HTTPS requests. This is enabled by default, and it will throw an SSL error if it's unable to verify the certificate. You can pass
verify the path to a CA certificate or a custom one. To ignore verifying SSL, set
verify to False.
>>> requests.get('https://bigfix.server:52311/api/help', verify=False) <Response >