Jump to

• Request
• Response
• Examples

Delete a Blockchain Platform Instance

delete

/api/v1/blockchainPlatforms/instances/{id}

Delete a Blockchain Platform instance.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Unique platform instance identifier

Query Parameters

• force: string
  Force Delete an instance: either true or false. Default is false.

  Allowed Values: [ true, false ]
• retainData: string
  Retain user data: either true or false. Default is true.

  Allowed Values: [ true, false ]

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Headers

• Location: string
  Location Header with a URL to query the status of the request.

401 Response

Not authorized

404 Response

Invalid parameters

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 particular Blockchain Platform instance.

The following example shows how to delete a particular Blockchain Platform instance by submitting a DELETE request on the REST resource using cURL.

curl -X DELETE \
  http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/93d26463-e4b9-4773-b1c1-9cda2c311b55 \
  -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ=='
  

Example of the Response Body

The following example shows the contents of the response body:

202 Accepted

Back to Top