Jump to

• Request
• Response
• Examples

Update a Blockchain Platform Instance

put

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

Update a Blockchain Platform instance.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Unique platform instance identifier

Body ()

Request payload in JSON

Root Schema : UpdatePayload

Type: object

Update a Blockchain Platform instance

Show Source

• updateLDAPConfig(optional): boolean
  Determines whether the instance should be updated with the active LDAP configuration.

{
    "type":"object",
    "description":"Update a Blockchain Platform instance",
    "properties":{
        "updateLDAPConfig":{
            "type":"boolean",
            "description":"Determines whether the instance should be updated with the active LDAP configuration."
        }
    }
}

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

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

/blockchainPlatforms/instances/{id}
curl -X PUT \
  http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/e1f7bcfe-cc7e-4d19-97fb-772b231fcf99 \
  -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \
  -H 'Content-Type: application/json'
    

Example of the Request Body

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

{
  "updateLDAPConfig": true
}

Example of the Response Body

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

202 Accepted

Back to Top