API
The Application Programming Interface (API) in Cobra lets you run one or more processes automatically and without user intervention, from beginning to end.
Execution Guidelines
When using the API, keep the following points in mind:
- Cobra supports up to 999 processes within a single API script.
- You can run API processes on batch servers, allowing for scheduled, unattended execution.
- An API script is a simple ASCII text file. To run a process, specify the script on the API command line.
- The Settings section in the script defines configurations that apply to all processes within that script.
- Cobra automatically saves all logs to the database, making it easier to retrieve information and troubleshoot errors.
- You need multiple Cobra licenses to run an API process. Running it while logged into Cobra with the same user ID will prevent execution.
- To run an API process, ensure you have access to both the API script file and any import files required.
Authentication Behavior
When using the API with Cobra configured for Windows Authentication, SYSADMIN users can also log in using Basic Authentication with their username and password credentials.
Attention: For more information on the authentication modes, see
Login and Authentication.
- Related Topics:
- Running Cobra with Command Line Parameters
You can use command line parameters that can be passed to Cobra applications and Cobra API. - API Log File
When you run processes via the Cobra API, Cobra creates an overall API process log where information about the API process is entered. - API Script
Use the API script to define settings that affect all API processes in a batch. The API script that Cobra uses to control the API process is a simple ASCII text file. - Project Template Creation
You can create a project from a project template by specifying information in an XML configuration file and using the Cobra API. - Procedures
Follow the procedures in this section to manage API scripts.
Parent Topic: Tools