How do I call a load plan rest API via a python script?

amit_kothari — Thu, 11 Apr 2024 20:35:10 GMT

I have a need to execute and monitor a load plan via rest APIs using a python script, how do I do that?

Re: How do I call a load plan rest API via a python script?

amit_kothari — Thu, 12 Feb 2026 22:36:59 GMT

Here is a sample python script to execute a load plan and monitor the run via rest apis. Refer to this article too.

Enable Access for an Individual User

As an Incorta Super User or a user with the SuperRole, sign in to the Incorta.
In the Navigation bar, select Security.
In the Action bar, select Users.
Select the checkbox next to the user you want to enable public API access.
Select Edit (pen icon) in the upper right corner of the Security page.
In the Edit User drawer, select the Security tab.
In the Developer Tool section, toggle Enable Public API.

Create a Personal Access Security Token

Select 'Create a Personal Access Token'
Give the token a name and an expiration date
Copy the token and save it. This token can not be viewed at a later time. Instead, a new one will need to be created.

To check for the API payload, on your browser login to incorta first and then go to <incorta host>/incorta/api

#execute incorta load plans via rest api - https://docs.incorta.com/cloud/references-public-api-v2
#Use python 3

import requests
import time

#update  this as per your cluster
prod_connection_dict = {
    'tenant': "default",
    'incorta_domain': "xx.cloud4.incorta.com",
    'incorta_token': "personal access token string"
}

process_start_timestamp = time.time()
connection_dict = prod_connection_dict
incorta_headers = {"Authorization": f"Bearer {connection_dict['incorta_token']}"}
body = {"loadPlanName": "Test_Load_Plan"}

try:
       api_url = f"https://{connection_dict['incorta_domain']}/incorta/api/v2/{connection_dict['tenant']}/load-plan/execute"
       #print(api_url)
       response = requests.post(api_url, headers=incorta_headers, json=body)
       data = response.json()
       #print(data)
       api_url = f"https://{connection_dict['incorta_domain']}/incorta/api/v2/{connection_dict['tenant']}/load-plan/status/{data['loadPlanExecutionId']}?level=1"
       response = requests.get(api_url, headers=incorta_headers)
       data = response.json()
       jobStatus = data["status"]["jobStatus"]
       while jobStatus not in ('Success', 'Finished With Errors'😞
              print("Load plan is still running")
              time.sleep(30)
              response = requests.get(api_url, headers=incorta_headers)
              data = response.json()
              jobStatus = data["status"]["jobStatus"]
              print(jobStatus)
       print("Finished Load Plan")
       print(data["status"]["jobStatus"])
except:
         print("An exception occurred")

topic Re: How do I call a load plan rest API via a python script? in Data & Schema Discussions

How do I call a load plan rest API via a python script?

Re: How do I call a load plan rest API via a python script?

Enable Access for an Individual User

Create a Personal Access Security Token