REST API for Oracle Blockchain Platform Enterprise Edition

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

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: string
cpConfigValue: string

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

Response

Supported Media Types

application/json

200 Response

400 Response

Bad request

401 Response

Not authorized

409 Response

Operation conflict

Root Schema : Error

Type: object

Error information.

Show Source

errors: array errors

List of errors
message(required): string

A human-readable error string.
status(required): string

A short error status that defines the error, meant for programmatic parsing.
warnings: 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

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