Admin APIs

Edit online

This section describes the Admin APIs used in Connect:Direct Web Services.

IBM Connect:Direct Web Services (CDWS) enables other external applications to invoke commands or integrate with Connect:Direct (CD) nodes through RESTful Application Programming Interface (APIs). The REST API Admin supports create, query, update, and delete operations on resources by using standard HTTP GET, POST, PUT, and DELETE methods and provides resource data in JavaScript Object Notation (JSON) format. Connect:Direct Web Services (CDWS) provide APIs for different Admin functions such as Admin System, Trust Certificate, Key Certificate. These APIs can be directly invoked through different CLIs, customized scripts, browser interfaces, and can be seamlessly integrated with business applications.

Prerequisite

Users should sign on using the APIs below before accessing any admin function APIs.

Admin Sign-on: This API is used to verify the admin user credentials and securely login while accessing rest of the admin function API's.

Method URI
POST
Attention: Users should sign on using the APIs below before accessing any admin function APIs.

https://<CDWS Host Name/IP Address>:<CDWS Port Number>/
The following example shows the HTTP User Request:
{
 			 "ipAddress":"172.20.186.203",
        		          "port":1363,
 "protocol":"NONE"
                     }
The following example shows the Sample Response:
 {
                 "messageCode":200,
                 "message":"Admin is successfully logged in",
                 "version":null,
                 "cdVersion":null,
                 "nodeMachineName":null,
                 "osType":null,
                 "protocol":null,
                "nodeName":null
              }