Jump to

• Request
• Response
• Examples

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : CpConfigDetail

Type: object

Control plane configuration details

Show Source

• cpConfigName(optional): string
• cpConfigValue(optional): string

{
    "description":"Control plane configuration details",
    "type":"object",
    "properties":{
        "cpConfigName":{
            "type":"string"
        },
        "cpConfigValue":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

401 Response

Not authorized

500 Response

Service unavailable

Back to Top

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"
}

Back to Top