This API Guide provides detailed instructions for using the REST services included with FlexDeploy. See the FlexDeploy Installation Guide for information related to installation. See also the FlexDeploy Plugin Guides for detailed instructions for configuring and using the FlexDeploy plugins.

Most API are setup to use Basic Authentication except where noted. In order to use Basic Authentication with WebLogic, please set enforce-valid-basic-auth-credentials to false in domain.

You can add following after <node-manager-password-encrypted> in <security-configuration> tag.

<enforce-valid-basic-auth-credentials>false</enforce-valid-basic-auth-credentials>

It should be in this order:


<security-configuration>
......
<enforce-valid-basic-auth-credentials>false</enforce-valid-basic-auth-
credentials>
<use-kss-for-demo>true</use-kss-for-demo>
</security-configuration>


Or, use wlst to set the property:


connect('weblogicUser','weblogicPassword','t3://host:port)
edit()
startEdit()
cd('SecurityConfiguration/Your_Domain')
set('EnforceValidBasicAuthCredentials','false')
save()
activate()




Version 1 API Details

Version 1 APIs use Basic Authentication.

Administration

Change Management Systems API
Issue Tracking Systems API
Plugins API
Resource Types API
Group API
User API
Test Type Rest API
Testing Tool API
WorkflowWorkflow API
Topology





Endpoint API
Environment API
Instance API
Environment Instance API
Source Control Management Instance API
Test Instance API
Change Management System Instance API
Issue Tracking System Instance API
Project






Project API
Execute Utility Project API
Folder API
Application API
Project Properties API
Project Stream API
Project Versions API
Download of Artifacts API
Tasks

Approval Tasks API


Scheduled Tasks API
ReleaseRelease Snapshot APICreate new snapshot, get existing snapshot, promote existing project version to create new snapshot.

Version 0 API Details

In version 0, credentials are passed in JSON input.

ReleaseReleases API
Workflow Execution




Build Project
Deploy Project
Build Application
Deploy Application
Get Application Request Status
Get Workflow Request Status
Get Workflow Request
Tasks (Deprecated)




Approve Application
Approve Project
Reject Application
Reject Project

Update Properties (Deprecated)

Update Properties API (version 0)