Apache Airavata API

For Airavata API documentation please visit Airavata 0.16 API Documentation

Airavata APIs for Experiments & Projects

Gateway Function/FeatureAiravata APIDescription
Create a ProjectcreateProjectLinked with Create Project in PGA.
Update ProjectupdateProjectTo update Project name and description.
Get a ProjectgetProjectRetrieve Project by providing the ID.
Search Project by NamesearchProjectsByProjectNameSearch for Project by giving part or full project name.
Search Project by DescsearchProjectsByProjectDescSearch for Project by giving part or full project description.
Get all user ProjectsgetUserProjectsRetrieve all Projects of a user.
Create an ExperimentcreateExperimentCreate an Experiment.
Update an ExperimentupdateExperimentUpdate ab Experiment. Experiments with CREATED exp-status can be updated.
Get an ExperimentgetExperimentRetrieve Experiment by providing the experiment ID.
Get Detailed ExperimentgetDetailedExperimentTreeRetrieve detailed Experiment by providing the experiment ID.
Clone an ExperimentcloneExperimentClone an existing Experiment. Experiment with any exp-status can be cloned by providing the ID.
Cancel an ExperimentterminateExperimentCancel an existing Experiment. Experiments with exp-statuses LAUNCHING or EXECUTING can be cancelled.
Search Experiment by NamesearchExperimentsByNameSearch Experiment by giving full or part of the name.
Search Experiment by DescsearchExperimentsByDescSearch Experiment by giving full or part of the description.
Search Experiments by Application NamesearchExperimentsByApplicationSearch Experiment by giving the application name.
Search Experiment by Creation TimesearchExperimentsByCreationTimeSearch Experiment by giving creationTime period.
Get all user ExperimentsgetUserExperimentsSearch for all the experiments of a single user.
Get Experiments for a ProjectgetExperimentsInProjectRetrieve all the experiments in a particular Project.

Airavata APIs for Admin Dashboard

Admin Function/FeatureAiravata APIDescription
Add Gateway
Add a gatewayaddGatewayAdding a new Gateway.
Credential Store
Generate a Token/SSH KeygenerateAndRegisterSSHKeysGenerate new SSH Key and Token.
Get all Credential Store TokensgetAllGatewaySSHPubKeysRetrieve all the generated keys of a Gateway.
Remove a Token/SSH KeydeleteSSHPubKeySelect and delete a particular SSH Key Token pair.
Compute Resource (CR)
Get all application deployed CRsgetAllApplicationDeploymentsGet all Application deployed Compute Resources.
Get a CRgetComputeResourceRetrieve Compute Resource information by providing the resource ID.
Register CRregisterComputeResourceRegister a new Compute Resource. This is Super Admin Feature.
Update CRupdateComputeResourceRetrieve an existing Compute Resource and update.
Enable and Disable CRgetComputeResource updateComputeResourceRetrieve the CR and enable or disable through update. This is a Super Admin feature.
Delete a QueuedeleteBatchQueueDelete a selected Queue from the Compute Resource.
Storage Resource (SR)
Get all SR NamesgetAllStorageResourceNamesRetrieve all storage resources of the gateway.
Get a SRgetStorageResourceFetch Storage Resource by providing the Storage ID.
Register a SRregisterStorageResourceRegister a new Storage Resource. This is a Super Admin Feature.
Update a SRupdateStorageResourceUpdate and existing Storage Resource.
Enable and Disable SRgetStorageResource updateStorageResourceRetrieve the SR and enable or disable through update. This is a Super Admin feature.
Delete SRdeleteStorageResourceSelect and delete and existing Storage Resource.
Delete Data Movement Interface of SRdeleteDataMovementInterfaceDelete a Data Movement Interface of a Storage Resource
Experiment Statistics
Get Experiment StatisticsgetExperimentStatisticsDisplays experiments grouped by the experiment status and derived for the given date time range.
Gateway Preferences
Add CR Preference for a gateway addGatewayComputeResourcePreference
Edit CR Preference addGatewayComputeResourcePreference
Delete a CR Preference
Add SR Preference for a gateway addGatewayStoragePreference
Edit SR Preference addGatewayStoragePreference
Delete a SR Preference
Get all NoticesnoticesViewView all existing Notices.

If any questions or clarification regarding the API documentation please contact us through;
Airavata Mailing List