Jump to

• Request
• Response
• Examples

Create or Update Control Plane Configuration

post

/api/v1/configuration/cpConfig/list

Creates or updates all specified control plane configurations.

Request

Supported Media Types

• application/json

Body ()

Request payload in JSON

Root Schema : schema

Type: array

Show Source

• Array of: object CpConfigDetail
  Control plane configuration details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CpConfigDetail"
    }
}

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

400 Response

Bad Request

401 Response

Not authorized

409 Response

Operation conflict

Body ()

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

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

500 Response

Service unavailable

Back to Top

Examples

This endpoint is used to update the specified control plane configuration in your Blockchain platform.

The following example shows how to update the name of a control plane configuration by submitting a POST request on the REST resource using cURL.

curl -X POST \
  http://<hostname>:<port>/api/v1/configuration/cpConfig/list \
  -H 'Accept: */*' \
  -H 'Accept-Encoding: gzip, deflate' \
  -H 'Authorization: Basic b2JwdXNlcjphd2RyVEhVSzEh' \
  -H 'Connection: keep-alive' \
  -H 'Content-Length: 94' \
  -H 'Content-Type: application/json' \
  -H 'Host: localhost:17070' \
  -H 'User-Agent: PostmanRuntime/7.15.2' \
  -d '<Request Body>'

Example of the Request Body

The following example shows the contents of the request body in JSON format:

[
    {
        "cpConfigName": "testCPconfig",
        "cpConfigValue": "newCPconfig"
    }
]

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
    "status": "200",
    "message": "Configuration Saved successfully"
}

Back to Top