Sterling Secure Proxy

Beta

Sterling Secure Proxy

+ Day(s) remaining in the trial

Overview

IBM Sterling Secure Proxy acts as an application proxy between Sterling Connect:Direct nodes or between a client application and a Sterling B2B Integrator server. It provides a high level of data protection between external connections and your internal network. The IBM Sterling Secure Proxy REST API allows clients to perform create, read, update, and delete operations on configuration objects, and initiate configuration related tasks.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

Sterling Secure Proxy:

/accepter/export-GET
Exports all accepters defined within the SSP CM.

GET   /accepter/export

			https://localhost:8443/sspcmrest/sspcm/rest/accepter/export
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/accepter/export") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/accepter/getAccepter/{accepterName}-GET
Get the XML corresponding to the Accepter defined with in the IBM Sterling Secure Proxy Configuration Manager.

GET   /accepter/getAccepter/{accepterName}

			https://localhost:8443/sspcmrest/sspcm/rest/accepter/getAccepter/{accepterName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

accepterName

URL , required

The name of the accepter. Valid values are Secure or NonSecure.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/accepter/getAccepter/%7BaccepterName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

port

INTEGER , optional

enabled

BOOLEAN , optional

timeOut

INTEGER , optional

secureConnection

STRING , optional

name

STRING , optional

ipAddress

STRING , optional

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								{
  "port" : integer,
  "enabled" : boolean,
  "timeOut" : integer,
  "secureConnection" : string,
  "name" : string,
  "ipAddress" : string
}
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/accepter/import-PUT
Imports all exported accepters into the SSP CM.

PUT   /accepter/import

			https://localhost:8443/sspcmrest/sspcm/rest/accepter/import
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/accepter/import") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/accepter/updateAccepter/{accepterName}-PUT
Updates the existing Accepter with the XML provided.

PUT   /accepter/updateAccepter/{accepterName}

			https://localhost:8443/sspcmrest/sspcm/rest/accepter/updateAccepter/{accepterName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

accepterName

URL , required

The name of the accepter. Valid values are Secure or NonSecure.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/accepter/updateAccepter/%7BaccepterName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Request model

port

INTEGER , optional

enabled

BOOLEAN , optional

timeOut

INTEGER , optional

secureConnection

STRING , optional

name

STRING , optional

ipAddress

STRING , optional

Request example
{
  "port": integer,
  "enabled": boolean,
  "timeOut": integer,
  "secureConnection": string,
  "name": string,
  "ipAddress": string
}
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/adapter/createAdapter-POST
Creates an adapter on the Sterling Secure Proxy Configuration Manager. The schema below describes an http adapter, the schema objects will be slightly different for other protocols.

POST   /adapter/createAdapter

			https://localhost:8443/sspcmrest/sspcm/rest/adapter/createAdapter
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/sspcmrest/sspcm/rest/adapter/createAdapter") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Request model

standardRoute

STRING , optional

protocol

STRING , optional

engines

ARRAY , optional

maxSessions

STRING , optional

properties

ARRAY , optional

uri

STRING , optional

htmlUrlRewrite

STRING , optional

sessionTimeout

STRING , optional

pingResponse

STRING , optional

urlRoutingType

STRING , optional

psOutPortrange

STRING , optional

listenPort

STRING , optional

netmap

STRING , optional

logLevel

STRING , optional

description

STRING , optional

ssoConfig

STRING , optional

name

STRING , optional

netmapKey

STRING , optional

startupMode

STRING , optional

useEA

STRING , optional

psOutName

STRING , optional

engineName

STRING , optional

eaPSName

STRING , optional

eaServerName

STRING , optional

psInName

STRING , optional

name

STRING , optional

value

STRING , optional

Request example
{
  "standardRoute": string,
  "protocol": string,
  "engines": [{
    "startupMode": string,
    "useEA": string,
    "psOutName": string,
    "engineName": string,
    "eaPSName": string,
    "eaServerName": string,
    "psInName": string
  }],
  "maxSessions": string,
  "properties": [{
    "name": string,
    "value": string
  }],
  "uri": string,
  "htmlUrlRewrite": string,
  "sessionTimeout": string,
  "pingResponse": string,
  "urlRoutingType": string,
  "psOutPortrange": string,
  "listenPort": string,
  "netmap": string,
  "logLevel": string,
  "description": string,
  "ssoConfig": string,
  "name": string,
  "netmapKey": string
}
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/adapter/deleteAdapter/{adapterName}-DELETE
Deletes the adapter from the Sterling Secure Proxy Configuration Manager.

DELETE   /adapter/deleteAdapter/{adapterName}

			https://localhost:8443/sspcmrest/sspcm/rest/adapter/deleteAdapter/{adapterName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

adapterName

URL , required

Then name of the adapter.

Request code
								
HttpResponse<String> response = Unirest.delete("https://api.ibm.com/sspcmrest/sspcm/rest/adapter/deleteAdapter/%7BadapterName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/adapter/export-GET
Exports all adapters defined within the SSP CM.

GET   /adapter/export

			https://localhost:8443/sspcmrest/sspcm/rest/adapter/export
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/adapter/export") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/adapter/getAdapter/{adapterName}-GET
Gets the XML corresponding to the adapter defined with in the Sterling Secure Proxy Configuration Manager. The schema below describes an http adapter, the schema objects will be slightly different for other protocols.

GET   /adapter/getAdapter/{adapterName}

			https://localhost:8443/sspcmrest/sspcm/rest/adapter/getAdapter/{adapterName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

adapterName

URL , required

Then name of the adapter.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/adapter/getAdapter/%7BadapterName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

standardRoute

STRING , optional

protocol

STRING , optional

engines [engine]

ARRAY , optional

maxSessions

STRING , optional

properties [property]

ARRAY , optional

uri

STRING , optional

htmlUrlRewrite

STRING , optional

sessionTimeout

STRING , optional

pingResponse

STRING , optional

urlRoutingType

STRING , optional

psOutPortrange

STRING , optional

listenPort

STRING , optional

netmap

STRING , optional

logLevel

STRING , optional

description

STRING , optional

ssoConfig

STRING , optional

name

STRING , optional

netmapKey

STRING , optional

startupMode

STRING , optional

useEA

STRING , optional

psOutName

STRING , optional

engineName

STRING , optional

eaPSName

STRING , optional

eaServerName

STRING , optional

psInName

STRING , optional

name

STRING , optional

value

STRING , optional

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								{
  "standardRoute" : string,
  "protocol" : string,
  "engines" : [{
    "startupMode" : string,
    "useEA" : string,
    "psOutName" : string,
    "engineName" : string,
    "eaPSName" : string,
    "eaServerName" : string,
    "psInName" : string
  }],
  "maxSessions" : string,
  "properties" : [{
    "name" : string,
    "value" : string
  }],
  "uri" : string,
  "htmlUrlRewrite" : string,
  "sessionTimeout" : string,
  "pingResponse" : string,
  "urlRoutingType" : string,
  "psOutPortrange" : string,
  "listenPort" : string,
  "netmap" : string,
  "logLevel" : string,
  "description" : string,
  "ssoConfig" : string,
  "name" : string,
  "netmapKey" : string
}
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/adapter/getAllAdapters-GET
Gets the IDs(names) corresponding to the adapters defined with in the Sterling Secure Proxy Configuration Manager.

GET   /adapter/getAllAdapters

			https://localhost:8443/sspcmrest/sspcm/rest/adapter/getAllAdapters
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/adapter/getAllAdapters") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/adapter/import-PUT
Imports all exported adapters into the SSP CM.

PUT   /adapter/import

			https://localhost:8443/sspcmrest/sspcm/rest/adapter/import
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/adapter/import") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/adapter/startAdapter-POST
Starts an adapter defined with in the Sterling Secure Proxy Configuration Manager.

POST   /adapter/startAdapter

			https://localhost:8443/sspcmrest/sspcm/rest/adapter/startAdapter
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

adapterName

STRING , required

The name of the adapter.

engineName

STRING , required

The name of the engine.

Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/sspcmrest/sspcm/rest/adapter/startAdapter?adapterName=SOME_STRING_VALUE&engineName=SOME_STRING_VALUE") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/adapter/stopAdapter-POST
Stops an adapter on the Sterling Secure Proxy Configuration Manager.

POST   /adapter/stopAdapter

			https://localhost:8443/sspcmrest/sspcm/rest/adapter/stopAdapter
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

adapterName

STRING , required

The name of the adapter.

engineName

STRING , required

The name of the engine.

Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/sspcmrest/sspcm/rest/adapter/stopAdapter?adapterName=SOME_STRING_VALUE&engineName=SOME_STRING_VALUE") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/adapter/updateAdapter/{adapterName}-PUT
Updates the existing adapter with the XML provided. The schema below describes an http adapter, the schema objects will be slightly different for other protocols.

PUT   /adapter/updateAdapter/{adapterName}

			https://localhost:8443/sspcmrest/sspcm/rest/adapter/updateAdapter/{adapterName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

adapterName

URL , required

Then name of the adapter.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/adapter/updateAdapter/%7BadapterName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Request model

standardRoute

STRING , optional

protocol

STRING , optional

engines

ARRAY , optional

maxSessions

STRING , optional

properties

ARRAY , optional

uri

STRING , optional

htmlUrlRewrite

STRING , optional

sessionTimeout

STRING , optional

pingResponse

STRING , optional

urlRoutingType

STRING , optional

psOutPortrange

STRING , optional

listenPort

STRING , optional

netmap

STRING , optional

logLevel

STRING , optional

description

STRING , optional

ssoConfig

STRING , optional

name

STRING , optional

netmapKey

STRING , optional

startupMode

STRING , optional

useEA

STRING , optional

psOutName

STRING , optional

engineName

STRING , optional

eaPSName

STRING , optional

eaServerName

STRING , optional

psInName

STRING , optional

name

STRING , optional

value

STRING , optional

Request example
{
  "standardRoute": string,
  "protocol": string,
  "engines": [{
    "startupMode": string,
    "useEA": string,
    "psOutName": string,
    "engineName": string,
    "eaPSName": string,
    "eaServerName": string,
    "psInName": string
  }],
  "maxSessions": string,
  "properties": [{
    "name": string,
    "value": string
  }],
  "uri": string,
  "htmlUrlRewrite": string,
  "sessionTimeout": string,
  "pingResponse": string,
  "urlRoutingType": string,
  "psOutPortrange": string,
  "listenPort": string,
  "netmap": string,
  "logLevel": string,
  "description": string,
  "ssoConfig": string,
  "name": string,
  "netmapKey": string
}
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/configUser/createConfigUser-POST
Creates a new Config User on the Sterling Secure Proxy Configuration Manager.

POST   /configUser/createConfigUser

			https://localhost:8443/sspcmrest/sspcm/rest/configUser/createConfigUser
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/sspcmrest/sspcm/rest/configUser/createConfigUser") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Request model

hashedName

STRING , optional

description

STRING , optional

passwordPolicyId

STRING , optional

name

STRING , optional

role

STRING , optional

properties

ARRAY , optional

authProfile

STRING , optional

password

STRING , optional

eaServerName

STRING , optional

userAuthentication

STRING , optional

name

STRING , optional

value

STRING , optional

Request example
{
  "hashedName": string,
  "description": string,
  "passwordPolicyId": string,
  "name": string,
  "role": string,
  "properties": [{
    "name": string,
    "value": string
  }],
  "authProfile": string,
  "password": string,
  "eaServerName": string,
  "userAuthentication": string
}
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/configUser/deleteConfigUser/{configUserName}-DELETE
Deletes the Config User from the IBM Sterling Secure Proxy Configuration Manager

DELETE   /configUser/deleteConfigUser/{configUserName}

			https://localhost:8443/sspcmrest/sspcm/rest/configUser/deleteConfigUser/{configUserName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

configUserName

URL , required

The name of the CM user.

Request code
								
HttpResponse<String> response = Unirest.delete("https://api.ibm.com/sspcmrest/sspcm/rest/configUser/deleteConfigUser/%7BconfigUserName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/configUser/export-GET
Exports all CM users defined within the SSP CM.

GET   /configUser/export

			https://localhost:8443/sspcmrest/sspcm/rest/configUser/export
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/configUser/export") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/configUser/getAllConfigUsers-GET
Get the names of all Config User objects defined with in the IBM Sterling Secure Proxy Configuration Manager.

GET   /configUser/getAllConfigUsers

			https://localhost:8443/sspcmrest/sspcm/rest/configUser/getAllConfigUsers
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/configUser/getAllConfigUsers") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/configUser/getConfigUser/{configUserName}-GET
Get the XML corresponding to the Config User defined with in the IBM Sterling Secure Proxy Configuration Manager.

GET   /configUser/getConfigUser/{configUserName}

			https://localhost:8443/sspcmrest/sspcm/rest/configUser/getConfigUser/{configUserName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

configUserName

URL , required

The name of the CM user.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/configUser/getConfigUser/%7BconfigUserName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

hashedName

STRING , optional

description

STRING , optional

passwordPolicyId

STRING , optional

name

STRING , optional

role

STRING , optional

properties [property]

ARRAY , optional

authProfile

STRING , optional

password

STRING , optional

eaServerName

STRING , optional

userAuthentication

STRING , optional

name

STRING , optional

value

STRING , optional

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								{
  "hashedName" : string,
  "description" : string,
  "passwordPolicyId" : string,
  "name" : string,
  "role" : string,
  "properties" : [{
    "name" : string,
    "value" : string
  }],
  "authProfile" : string,
  "password" : string,
  "eaServerName" : string,
  "userAuthentication" : string
}
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/configUser/import-PUT
Imports all exported CM users into the SSP CM.

PUT   /configUser/import

			https://localhost:8443/sspcmrest/sspcm/rest/configUser/import
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/configUser/import") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/configUser/updateConfigUser/{configUserName}-PUT
Updates the existing Config User with the XML provided.

PUT   /configUser/updateConfigUser/{configUserName}

			https://localhost:8443/sspcmrest/sspcm/rest/configUser/updateConfigUser/{configUserName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

configUserName

URL , required

The name of the CM user.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/configUser/updateConfigUser/%7BconfigUserName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Request model

hashedName

STRING , optional

description

STRING , optional

passwordPolicyId

STRING , optional

name

STRING , optional

role

STRING , optional

properties

ARRAY , optional

authProfile

STRING , optional

password

STRING , optional

eaServerName

STRING , optional

userAuthentication

STRING , optional

name

STRING , optional

value

STRING , optional

Request example
{
  "hashedName": string,
  "description": string,
  "passwordPolicyId": string,
  "name": string,
  "role": string,
  "properties": [{
    "name": string,
    "value": string
  }],
  "authProfile": string,
  "password": string,
  "eaServerName": string,
  "userAuthentication": string
}
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/eaServer/createEaServer-POST
Creates a new EA Server on the Sterling Secure Proxy Configuration Manager.

POST   /eaServer/createEaServer

			https://localhost:8443/sspcmrest/sspcm/rest/eaServer/createEaServer
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/sspcmrest/sspcm/rest/eaServer/createEaServer") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Request model

sslInfo

object , optional

serverAddress

STRING , optional

secureConnection

STRING , optional

serverPort

STRING , optional

name

STRING , optional

outboundPortRange

STRING , optional

eaServerDef

STRING , optional

addresses

ARRAY , optional

keyStoreName

STRING , optional

trustStoreName

STRING , optional

protocol

STRING , optional

trustedCertNames

ARRAY , optional

cipherSuites

ARRAY , optional

keyCertName

STRING , optional

clientAuthentication

STRING , optional

port

STRING , optional

host

STRING , optional

nodeName

STRING , optional

Request example
{
  "sslInfo": {
    "keyStoreName": string,
    "trustStoreName": string,
    "protocol": string,
    "trustedCertNames": [],
    "cipherSuites": [],
    "keyCertName": string,
    "clientAuthentication": string
  },
  "serverAddress": string,
  "secureConnection": string,
  "serverPort": string,
  "name": string,
  "outboundPortRange": string,
  "eaServerDef": string,
  "addresses": [{
    "port": string,
    "host": string,
    "nodeName": string
  }]
}
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/eaServer/deleteEaServer/{eaServerName}-DELETE
Deletes the EA Server from the IBM Sterling Secure Proxy Configuration Manager

DELETE   /eaServer/deleteEaServer/{eaServerName}

			https://localhost:8443/sspcmrest/sspcm/rest/eaServer/deleteEaServer/{eaServerName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

eaServerName

URL , required

The name of the EA Server.

Request code
								
HttpResponse<String> response = Unirest.delete("https://api.ibm.com/sspcmrest/sspcm/rest/eaServer/deleteEaServer/%7BeaServerName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/eaServer/export-GET
Exports all EA servers defined within the SSP CM.

GET   /eaServer/export

			https://localhost:8443/sspcmrest/sspcm/rest/eaServer/export
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/eaServer/export") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/eaServer/getAllEaServers-GET
Get the names of all EA Server objects defined with in the IBM Sterling Secure Proxy Configuration Manager.

GET   /eaServer/getAllEaServers

			https://localhost:8443/sspcmrest/sspcm/rest/eaServer/getAllEaServers
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/eaServer/getAllEaServers") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/eaServer/getEaServer/{eaServerName}-GET
Get the XML corresponding to the EA Server defined with in the IBM Sterling Secure Proxy Configuration Manager.

GET   /eaServer/getEaServer/{eaServerName}

			https://localhost:8443/sspcmrest/sspcm/rest/eaServer/getEaServer/{eaServerName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

eaServerName

URL , required

The name of the EA Server.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/eaServer/getEaServer/%7BeaServerName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

sslInfo [sslInfo]

object , optional

serverAddress

STRING , optional

secureConnection

STRING , optional

serverPort

STRING , optional

name

STRING , optional

outboundPortRange

STRING , optional

eaServerDef

STRING , optional

addresses [address]

ARRAY , optional

keyStoreName

STRING , optional

trustStoreName

STRING , optional

protocol

STRING , optional

trustedCertNames

ARRAY , optional

cipherSuites

ARRAY , optional

keyCertName

STRING , optional

clientAuthentication

STRING , optional

port

STRING , optional

host

STRING , optional

nodeName

STRING , optional

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								{
  "sslInfo" : {
    "keyStoreName" : string,
    "trustStoreName" : string,
    "protocol" : string,
    "trustedCertNames" : [array],
    "cipherSuites" : [array],
    "keyCertName" : string,
    "clientAuthentication" : string
  },
  "serverAddress" : string,
  "secureConnection" : string,
  "serverPort" : string,
  "name" : string,
  "outboundPortRange" : string,
  "eaServerDef" : string,
  "addresses" : [{
    "port" : string,
    "host" : string,
    "nodeName" : string
  }]
}
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/eaServer/import-PUT
Imports all exported EA servers into the SSP CM.

PUT   /eaServer/import

			https://localhost:8443/sspcmrest/sspcm/rest/eaServer/import
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/eaServer/import") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/eaServer/updateEaServer/{eaServerName}-PUT
Updates the existing EA Server with the XML provided.

PUT   /eaServer/updateEaServer/{eaServerName}

			https://localhost:8443/sspcmrest/sspcm/rest/eaServer/updateEaServer/{eaServerName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

eaServerName

URL , required

The name of the EA Server.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/eaServer/updateEaServer/%7BeaServerName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Request model

sslInfo

object , optional

serverAddress

STRING , optional

secureConnection

STRING , optional

serverPort

STRING , optional

name

STRING , optional

outboundPortRange

STRING , optional

eaServerDef

STRING , optional

addresses

ARRAY , optional

keyStoreName

STRING , optional

trustStoreName

STRING , optional

protocol

STRING , optional

trustedCertNames

ARRAY , optional

cipherSuites

ARRAY , optional

keyCertName

STRING , optional

clientAuthentication

STRING , optional

port

STRING , optional

host

STRING , optional

nodeName

STRING , optional

Request example
{
  "sslInfo": {
    "keyStoreName": string,
    "trustStoreName": string,
    "protocol": string,
    "trustedCertNames": [],
    "cipherSuites": [],
    "keyCertName": string,
    "clientAuthentication": string
  },
  "serverAddress": string,
  "secureConnection": string,
  "serverPort": string,
  "name": string,
  "outboundPortRange": string,
  "eaServerDef": string,
  "addresses": [{
    "port": string,
    "host": string,
    "nodeName": string
  }]
}
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/engine/createEngine-POST
Creates a new engine on the Sterling Secure Proxy Configuration Manager.

POST   /engine/createEngine

			https://localhost:8443/sspcmrest/sspcm/rest/engine/createEngine
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/sspcmrest/sspcm/rest/engine/createEngine") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Request model

port

STRING , optional

debugLogging

STRING , optional

localPSLogging

STRING , optional

host

STRING , optional

formatVer

STRING , optional

description

STRING , optional

name

STRING , optional

userStore

STRING , optional

localBindAddress

STRING , optional

adapter

ARRAY , optional

enableAuditLogRouting

STRING , optional

Request example
{
  "port": string,
  "debugLogging": string,
  "localPSLogging": string,
  "host": string,
  "formatVer": string,
  "description": string,
  "name": string,
  "userStore": string,
  "localBindAddress": string,
  "adapter": [],
  "enableAuditLogRouting": string
}
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/engine/deleteEngine/{engineName}-DELETE
Deletes the engine from the Sterling Secure Proxy Configuration Manager.

DELETE   /engine/deleteEngine/{engineName}

			https://localhost:8443/sspcmrest/sspcm/rest/engine/deleteEngine/{engineName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

engineName

URL , required

The name of the engine.

Request code
								
HttpResponse<String> response = Unirest.delete("https://api.ibm.com/sspcmrest/sspcm/rest/engine/deleteEngine/%7BengineName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/engine/export-GET
Exports all engines defined within the SSP CM.

GET   /engine/export

			https://localhost:8443/sspcmrest/sspcm/rest/engine/export
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/engine/export") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/engine/getAllEngines-GET
Gets the IDs(names) corresponding to the engines defined with in the Sterling Secure Proxy Configuration Manager.

GET   /engine/getAllEngines

			https://localhost:8443/sspcmrest/sspcm/rest/engine/getAllEngines
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/engine/getAllEngines") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/engine/getEngine/{engineName}-GET
Gets the XML corresponding to the engine defined with in the Sterling Secure Proxy Configuration Manager.

GET   /engine/getEngine/{engineName}

			https://localhost:8443/sspcmrest/sspcm/rest/engine/getEngine/{engineName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

engineName

URL , required

The name of the engine.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/engine/getEngine/%7BengineName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

port

STRING , optional

debugLogging

STRING , optional

localPSLogging

STRING , optional

host

STRING , optional

formatVer

STRING , optional

description

STRING , optional

name

STRING , optional

userStore

STRING , optional

localBindAddress

STRING , optional

adapter [adapter]

ARRAY , optional

enableAuditLogRouting

STRING , optional

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								{
  "port" : string,
  "debugLogging" : string,
  "localPSLogging" : string,
  "host" : string,
  "formatVer" : string,
  "description" : string,
  "name" : string,
  "userStore" : string,
  "localBindAddress" : string,
  "adapter" : [array],
  "enableAuditLogRouting" : string
}
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/engine/import-PUT
Imports all exported engines into the SSP CM.

PUT   /engine/import

			https://localhost:8443/sspcmrest/sspcm/rest/engine/import
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/engine/import") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/engine/updateEngine/{engineName}-PUT
Updates the existing engine with the XML provided.

PUT   /engine/updateEngine/{engineName}

			https://localhost:8443/sspcmrest/sspcm/rest/engine/updateEngine/{engineName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

engineName

URL , required

The name of the engine.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/engine/updateEngine/%7BengineName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Request model

port

STRING , optional

debugLogging

STRING , optional

localPSLogging

STRING , optional

host

STRING , optional

formatVer

STRING , optional

description

STRING , optional

name

STRING , optional

userStore

STRING , optional

localBindAddress

STRING , optional

adapter

ARRAY , optional

enableAuditLogRouting

STRING , optional

Request example
{
  "port": string,
  "debugLogging": string,
  "localPSLogging": string,
  "host": string,
  "formatVer": string,
  "description": string,
  "name": string,
  "userStore": string,
  "localBindAddress": string,
  "adapter": [],
  "enableAuditLogRouting": string
}
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/keyStore/createKeyDefEntries/{keyStoreName}-POST
Creates a new keyDef entry within a predefined key store on the Sterling Secure Proxy Configuration Manager.

POST   /keyStore/createKeyDefEntries/{keyStoreName}

			https://localhost:8443/sspcmrest/sspcm/rest/keyStore/createKeyDefEntries/{keyStoreName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

keyStoreName

URL , required

Then name of the key store or trust store.

Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/sspcmrest/sspcm/rest/keyStore/createKeyDefEntries/%7BkeyStoreName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/keyStore/createKeyStore-POST
Creates a new keyStore on the Sterling Secure Proxy Configuration Manager

POST   /keyStore/createKeyStore

			https://localhost:8443/sspcmrest/sspcm/rest/keyStore/createKeyStore
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/sspcmrest/sspcm/rest/keyStore/createKeyStore") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Request model

description

STRING , optional

name

STRING , optional

type

STRING , optional

elements

ARRAY , optional

enabled

STRING , optional

keyType

STRING , optional

description

STRING , optional

name

STRING , optional

keyInHSM

STRING , optional

keyData

STRING , optional

password

STRING , optional

Request example
{
  "description": string,
  "name": string,
  "type": string,
  "elements": [{
    "enabled": string,
    "keyType": string,
    "description": string,
    "name": string,
    "keyInHSM": string,
    "keyData": string,
    "password": string
  }]
}
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/keyStore/deleteKeyDefEntries/{keyStoreName}/{keyDefEntryName}-DELETE
Deletes an existing keyDef entry from an existing key store on the Sterling Secure Proxy Configuration Manager.

DELETE   /keyStore/deleteKeyDefEntries/{keyStoreName}/{keyDefEntryName}

			https://localhost:8443/sspcmrest/sspcm/rest/keyStore/deleteKeyDefEntries/{keyStoreName}/{keyDefEntryName}
		
Keys
Path and Query parameters

keyDefEntryName

URL , required

The name of the certificate.

keyStoreName

URL , required

Then name of the key store or trust store.

Request code
								
HttpResponse<String> response = Unirest.delete("https://api.ibm.com/sspcmrest/sspcm/rest/keyStore/deleteKeyDefEntries/%7BkeyStoreName%7D/%7BkeyDefEntryName%7D") .header("accept", "application/json") .header("content-type", "application/json") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/keyStore/deleteKeyStore/{keyStoreName}-DELETE
Deletes the keyStore from the Sterling Secure Proxy Configuration Manager.

DELETE   /keyStore/deleteKeyStore/{keyStoreName}

			https://localhost:8443/sspcmrest/sspcm/rest/keyStore/deleteKeyStore/{keyStoreName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

keyStoreName

URL , required

Then name of the key store or trust store.

Request code
								
HttpResponse<String> response = Unirest.delete("https://api.ibm.com/sspcmrest/sspcm/rest/keyStore/deleteKeyStore/%7BkeyStoreName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/keyStore/export-GET
Exports all key stores defined within the SSP CM.

GET   /keyStore/export

			https://localhost:8443/sspcmrest/sspcm/rest/keyStore/export
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/keyStore/export") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/keyStore/getAllKeyStores-GET
Gets the IDs(names) corresponding to the keyStores defined with in the Sterling Secure Proxy Configuration Manager.

GET   /keyStore/getAllKeyStores

			https://localhost:8443/sspcmrest/sspcm/rest/keyStore/getAllKeyStores
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/keyStore/getAllKeyStores") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/keyStore/getKeyStore/{keyStoreName}-GET
Gets the XML corresponding to the keyStore defined with in the Sterling Secure Proxy Configuration Manager.

GET   /keyStore/getKeyStore/{keyStoreName}

			https://localhost:8443/sspcmrest/sspcm/rest/keyStore/getKeyStore/{keyStoreName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

keyStoreName

URL , required

Then name of the key store or trust store.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/keyStore/getKeyStore/%7BkeyStoreName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

description

STRING , optional

name

STRING , optional

type

STRING , optional

elements [keyDef]

ARRAY , optional

enabled

STRING , optional

keyType

STRING , optional

description

STRING , optional

name

STRING , optional

keyInHSM

STRING , optional

keyData

STRING , optional

password

STRING , optional

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								{
  "description" : string,
  "name" : string,
  "type" : string,
  "elements" : [{
    "enabled" : string,
    "keyType" : string,
    "description" : string,
    "name" : string,
    "keyInHSM" : string,
    "keyData" : string,
    "password" : string
  }]
}
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/keyStore/import-PUT
Imports all exported key stores into the SSP CM.

PUT   /keyStore/import

			https://localhost:8443/sspcmrest/sspcm/rest/keyStore/import
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/keyStore/import") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/keyStore/modifyKeyDefEntries/{keyStoreName}-PUT
Modifies a keyDef entry within a predefined keyStore on the Sterling Secure Proxy Configuration Manager.

PUT   /keyStore/modifyKeyDefEntries/{keyStoreName}

			https://localhost:8443/sspcmrest/sspcm/rest/keyStore/modifyKeyDefEntries/{keyStoreName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

keyStoreName

URL , required

Then name of the key store or trust store.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/keyStore/modifyKeyDefEntries/%7BkeyStoreName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/keyStore/updateKeyStore/{keyStoreName}-PUT
Updates the existing keyStore with the XML provided.

PUT   /keyStore/updateKeyStore/{keyStoreName}

			https://localhost:8443/sspcmrest/sspcm/rest/keyStore/updateKeyStore/{keyStoreName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

keyStoreName

URL , required

Then name of the key store or trust store.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/keyStore/updateKeyStore/%7BkeyStoreName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Request model

description

STRING , optional

name

STRING , optional

type

STRING , optional

elements

ARRAY , optional

enabled

STRING , optional

keyType

STRING , optional

description

STRING , optional

name

STRING , optional

keyInHSM

STRING , optional

keyData

STRING , optional

password

STRING , optional

Request example
{
  "description": string,
  "name": string,
  "type": string,
  "elements": [{
    "enabled": string,
    "keyType": string,
    "description": string,
    "name": string,
    "keyInHSM": string,
    "keyData": string,
    "password": string
  }]
}
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/netmap/addNetmapNodes/{netmapName}-POST
Creates a new netmap entry within an existing netmap on the Sterling Secure Proxy Configuration Manager. The schema below describes http netmap inbound nodes, outbound nodes may also be included. The schema objects will be slightly different for other protocols.

POST   /netmap/addNetmapNodes/{netmapName}

			https://localhost:8443/sspcmrest/sspcm/rest/netmap/addNetmapNodes/{netmapName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

netmapName

URL , required

Then name of the netmap.

Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/sspcmrest/sspcm/rest/netmap/addNetmapNodes/%7BnetmapName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/netmap/createNetmap-POST
Creates a new netmap on the Sterling Secure Proxy Configuration Manager. The schema below describes an http netmap, the schema objects will be slightly different for other protocols.

POST   /netmap/createNetmap

			https://localhost:8443/sspcmrest/sspcm/rest/netmap/createNetmap
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/sspcmrest/sspcm/rest/netmap/createNetmap") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Request model

protocol

STRING , optional

inboundNodes

ARRAY , optional

description

STRING , optional

name

STRING , optional

urlRewriteConfig

object , optional

outboundNodes

ARRAY , optional

routingNode

STRING , optional

httpInSslInfo

object , optional

secureConnection

STRING , optional

policyId

STRING , optional

description

STRING , optional

name

STRING , optional

peerAddressPattern

STRING , optional

keyStoreName

STRING , optional

trustStoreName

STRING , optional

protocol

STRING , optional

trustedCertNames

ARRAY , optional

cipherSuites

ARRAY , optional

keyCertName

STRING , optional

clientAuthentication

STRING , optional

urlMap

object , optional

supportUrlRewrite

STRING , optional

urlMapEntries

ARRAY , optional

index

STRING , optional

proxyUriStr

STRING , optional

serverUriStr

STRING , optional

validDestinationPort

STRING , optional

sslInfo

ARRAY , optional

secureConnection

STRING , optional

logLevel

STRING , optional

description

STRING , optional

userId

STRING , optional

name

STRING , optional

addresses

ARRAY , optional

password

STRING , optional

destinationServiceName

STRING , optional

validDestination

STRING , optional

keyStoreName

STRING , optional

trustStoreName

STRING , optional

protocol

STRING , optional

trustedCertNames

ARRAY , optional

cipherSuites

ARRAY , optional

keyCertName

STRING , optional

clientAuthentication

STRING , optional

port

STRING , optional

host

STRING , optional

nodeName

STRING , optional

Request example
{
  "protocol": string,
  "inboundNodes": [{
    "routingNode": string,
    "httpInSslInfo": {
    "keyStoreName": string,
    "trustStoreName": string,
    "protocol": string,
    "trustedCertNames": [],
    "cipherSuites": [],
    "keyCertName": string,
    "clientAuthentication": string
  },
    "secureConnection": string,
    "policyId": string,
    "description": string,
    "name": string,
    "peerAddressPattern": string
  }],
  "description": string,
  "name": string,
  "urlRewriteConfig": {
    "urlMap": {
    "supportUrlRewrite": string,
    "urlMapEntries": [{
    "index": string,
    "proxyUriStr": string,
    "serverUriStr": string
  }]
  }
  },
  "outboundNodes": [{
    "validDestinationPort": string,
    "sslInfo": [{
    "keyStoreName": string,
    "trustStoreName": string,
    "protocol": string,
    "trustedCertNames": [],
    "cipherSuites": [],
    "keyCertName": string,
    "clientAuthentication": string
  }],
    "secureConnection": string,
    "logLevel": string,
    "description": string,
    "userId": string,
    "name": string,
    "addresses": [{
    "port": string,
    "host": string,
    "nodeName": string
  }],
    "password": string,
    "destinationServiceName": string,
    "validDestination": string
  }]
}
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/netmap/deleteNetmap/{netmapName}-DELETE
Deletes the netmap from the Sterling Secure Proxy Configuration Manager.

DELETE   /netmap/deleteNetmap/{netmapName}

			https://localhost:8443/sspcmrest/sspcm/rest/netmap/deleteNetmap/{netmapName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

netmapName

URL , required

Then name of the netmap.

Request code
								
HttpResponse<String> response = Unirest.delete("https://api.ibm.com/sspcmrest/sspcm/rest/netmap/deleteNetmap/%7BnetmapName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/netmap/deleteNetmapNodes/{netmapName}/{netmapEntryName}-DELETE
Deletes an existing netmap node entry from an existing netmap on the Sterling Secure Proxy Configuration Manager.

DELETE   /netmap/deleteNetmapNodes/{netmapName}/{netmapEntryName}

			https://localhost:8443/sspcmrest/sspcm/rest/netmap/deleteNetmapNodes/{netmapName}/{netmapEntryName}
		
Keys
Path and Query parameters

netmapEntryName

URL , required

The name of the node in the netmap.

netmapName

URL , required

Then name of the netmap.

Request code
								
HttpResponse<String> response = Unirest.delete("https://api.ibm.com/sspcmrest/sspcm/rest/netmap/deleteNetmapNodes/%7BnetmapName%7D/%7BnetmapEntryName%7D") .header("accept", "application/json") .header("content-type", "application/json") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/netmap/export-GET
Exports all netmaps defined within the SSP CM.

GET   /netmap/export

			https://localhost:8443/sspcmrest/sspcm/rest/netmap/export
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/netmap/export") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/netmap/getAllNetmaps-GET
Gets the IDs(names) corresponding to the netmaps defined with in the Sterling Secure Proxy Configuration Manager.

GET   /netmap/getAllNetmaps

			https://localhost:8443/sspcmrest/sspcm/rest/netmap/getAllNetmaps
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/netmap/getAllNetmaps") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

Response example

200

Success.

								
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							
/netmap/getNetmap/{netmapName}-GET
Gets the XML corresponding to the netmap defined with in the Sterling Secure Proxy Configuration Manager. The schema below describes an http netmap, the schema objects will be slightly different for other protocols.

GET   /netmap/getNetmap/{netmapName}

			https://localhost:8443/sspcmrest/sspcm/rest/netmap/getNetmap/{netmapName}
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Path and Query parameters

netmapName

URL , required

Then name of the netmap.

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/sspcmrest/sspcm/rest/netmap/getNetmap/%7BnetmapName%7D") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body

protocol

STRING , optional

inboundNodes [httpInboundNodeDef]

ARRAY , optional

description

STRING , optional

name

STRING , optional

urlRewriteConfig [urlRewriteConfig]

object , optional

outboundNodes [httpOutboundNodeDef]

ARRAY , optional

routingNode

STRING , optional

httpInSslInfo

object , optional

secureConnection

STRING , optional

policyId

STRING , optional

description

STRING , optional

name

STRING , optional

peerAddressPattern

STRING , optional

keyStoreName

STRING , optional

trustStoreName

STRING , optional

protocol

STRING , optional

trustedCertNames

ARRAY , optional

cipherSuites

ARRAY , optional

keyCertName

STRING , optional

clientAuthentication

STRING , optional

urlMap

object , optional

supportUrlRewrite

STRING , optional

urlMapEntries

ARRAY , optional

index

STRING , optional

proxyUriStr

STRING , optional

serverUriStr

STRING , optional

validDestinationPort

STRING , optional

sslInfo

ARRAY , optional

secureConnection

STRING , optional

logLevel

STRING , optional

description

STRING , optional

userId

STRING , optional

name

STRING , optional

addresses

ARRAY , optional

password

STRING , optional

destinationServiceName

STRING , optional

validDestination

STRING , optional

keyStoreName

STRING , optional

trustStoreName

STRING , optional

protocol

STRING , optional

trustedCertNames

ARRAY , optional

cipherSuites

ARRAY , optional

keyCertName

STRING , optional

clientAuthentication

STRING , optional

port

STRING , optional

host

STRING , optional

nodeName

STRING , optional

204

An error occured, check the cms log for details.

Body

400

An error occured, check the cms log for details.

Body

404

The system cound not find the specified parameter.

Body

Response example

200

Success.

								{
  "protocol" : string,
  "inboundNodes" : [{
    "routingNode" : string,
    "httpInSslInfo" : {
    "keyStoreName" : string,
    "trustStoreName" : string,
    "protocol" : string,
    "trustedCertNames" : [array],
    "cipherSuites" : [array],
    "keyCertName" : string,
    "clientAuthentication" : string
  },
    "secureConnection" : string,
    "policyId" : string,
    "description" : string,
    "name" : string,
    "peerAddressPattern" : string
  }],
  "description" : string,
  "name" : string,
  "urlRewriteConfig" : {
    "urlMap" : {
    "supportUrlRewrite" : string,
    "urlMapEntries" : [{
    "index" : string,
    "proxyUriStr" : string,
    "serverUriStr" : string
  }]
  }
  },
  "outboundNodes" : [{
    "validDestinationPort" : string,
    "sslInfo" : [{
    "keyStoreName" : string,
    "trustStoreName" : string,
    "protocol" : string,
    "trustedCertNames" : [array],
    "cipherSuites" : [array],
    "keyCertName" : string,
    "clientAuthentication" : string
  }],
    "secureConnection" : string,
    "logLevel" : string,
    "description" : string,
    "userId" : string,
    "name" : string,
    "addresses" : [{
    "port" : string,
    "host" : string,
    "nodeName" : string
  }],
    "password" : string,
    "destinationServiceName" : string,
    "validDestination" : string
  }]
}
							

204

An error occured, check the cms log for details.

								
							

400

An error occured, check the cms log for details.

								
							

404

The system cound not find the specified parameter.

								
							
/netmap/import-PUT
Imports all exported netmaps into the SSP CM.

PUT   /netmap/import

			https://localhost:8443/sspcmrest/sspcm/rest/netmap/import
		
Keys
Header parameters

X-Authentication

HEADER , required

The authentication token that is generated at login.

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/sspcmrest/sspcm/rest/netmap/import") .header("accept", "application/json") .header("content-type", "application/json") .header("x-authentication", "SOME_STRING_VALUE") .asString();
Response model

200

Success.

Body