Get Control Plane Configuration
get
/api/v1/configuration/cpConfig/{configName}
Gets the specified control plane configuration.
Request
Supported Media Types
- application/json
Path Parameters
-
configName: string
Unique control plane configuration identifier
Response
Supported Media Types
- application/json
200 Response
OK
400 Response
Bad Request
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
401 Response
Unauthorized
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
500 Response
Internal Server Error
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
Examples
This endpoint is used to get the details of a specific control plane configuration in your Blockchain platform.
The following example shows how to generate the control plane configuration report by submitting a GET request on the REST resource using cURL.
curl -X GET \ 'http://<hostname>:<port>/api/v1/configuration/cpConfig/?configName=<unique LDAP config identifier>'
For example,
curl -X GET \ 'http://localhost:17070/api/v1/configuration/cpConfig/?configName=a455c6ab-dc36-4553-90c4-bbbb3532bc50'
Example of the Response Body
The following example shows the contents of the response body in JSON format:
{ "activeLdapId": "a455c6ab-dc36-4553-90c4-bbbb3532bc50", "controlPlaneId": "MyBPM", "defaultUserDisabled": "false" }