Jump to

• Request
• Response
• Examples

Delete Control Plane Configuration

delete

/api/v1/configuration/cpConfig/{configName}

Deletes 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

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 delete a specified control plane configuration in your Blockchain platform.

The following example shows how to delete a control plane configuration by submitting a DELETE request on the REST resource using cURL.

curl -X DELETE \
  http://<hostname>:<port>/api/v1/configuration/cpConfig/<unique control plane config identifier>

For example,

curl -X DELETE \
  http://localhost:17070/api/v1/configuration/cpConfig/myCPconfig

Example of the Response Body

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

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

Back to Top