Jump to

• Request
• Response

Get Besu Instance Details

get

/api/v1/besu/instance/{id}

Get details for a particular Besu instance.

Request

Path Parameters

• id(required): string
  Unique Besu instance identifier

Header Parameters

• Authorization(required): string
  Bearer access token. Supply as: Bearer .

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : BesuInstanceDetails

Full Besu instance details.

Match All

Full Besu instance details.

Full Besu instance details.

Show Source

• object BesuInstanceSummary
  Besu Instance summary.
• object BesuInstanceDetails-allOf[1]

{
    "description":"Full Besu instance details.",
    "allOf":[
        {
            "$ref":"#/definitions/BesuInstanceSummary"
        },
        {
            "type":"object",
            "properties":{
                "components":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/BesuComponent"
                    }
                },
                "ldapAuthConfig":{
                    "$ref":"#/definitions/LdapConfigDetail"
                },
                "richHistoryConfigId":{
                    "type":"string"
                },
                "richHistoryConfigName":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : BesuInstanceSummary

Type: object

Besu Instance summary.

Show Source

• authProviderName: string
• autoRenewCertsAt: string
• chainId: integer(int32)
• configuration: string
  Allowed Values: [ "Developer", "Enterprise", "Digital Assets" ]
• createActivityId: string
• createdBy: string
• displayName: string
• domainName: string
• earliestCertExpiry: string(date-time)
• id: string
• instanceAccessGroup: string
• lifecycleState: string
  Allowed Values: [ "Creating", "Active", "Inactive", "Updating", "Scaling", "Terminating", "Terminated", "Starting", "Stopping", "Stopped", "UpdatingCertificates", "Scaling Out", "Scaling In", "Unknown", "Pending Creation", "Failed" ]
• platformRole: string
  Allowed Values: [ "founder", "participant" ]
• serviceEndpoint: string
• stateMessage: string
• status: string
  Allowed Values: [ "Healthy", "Unhealthy", "Down", "Unknown", "Stopped" ]
• statusDisplayName: string
• timeCreated: string(date-time)
• timeUpdated: string(date-time)
• version: string

{
    "description":"Besu Instance summary.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "createActivityId":{
            "type":"string"
        },
        "platformRole":{
            "type":"string",
            "enum":[
                "founder",
                "participant"
            ]
        },
        "configuration":{
            "type":"string",
            "enum":[
                "Developer",
                "Enterprise",
                "Digital Assets"
            ]
        },
        "status":{
            "type":"string",
            "enum":[
                "Healthy",
                "Unhealthy",
                "Down",
                "Unknown",
                "Stopped"
            ]
        },
        "lifecycleState":{
            "type":"string",
            "enum":[
                "Creating",
                "Active",
                "Inactive",
                "Updating",
                "Scaling",
                "Terminating",
                "Terminated",
                "Starting",
                "Stopping",
                "Stopped",
                "UpdatingCertificates",
                "Scaling Out",
                "Scaling In",
                "Unknown",
                "Pending Creation",
                "Failed"
            ]
        },
        "version":{
            "type":"string"
        },
        "domainName":{
            "type":"string"
        },
        "instanceAccessGroup":{
            "type":"string"
        },
        "chainId":{
            "type":"integer",
            "format":"int32"
        },
        "authProviderName":{
            "type":"string"
        },
        "stateMessage":{
            "type":"string"
        },
        "serviceEndpoint":{
            "type":"string"
        },
        "earliestCertExpiry":{
            "type":"string",
            "format":"date-time"
        },
        "autoRenewCertsAt":{
            "type":"string"
        },
        "statusDisplayName":{
            "type":"string"
        }
    }
}

Nested Schema : BesuInstanceDetails-allOf[1]

Type: object

Show Source

• components: array components
• ldapAuthConfig: object LdapConfigDetail
  LDAP Configuration details
• richHistoryConfigId: string
• richHistoryConfigName: string

{
    "type":"object",
    "properties":{
        "components":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BesuComponent"
            }
        },
        "ldapAuthConfig":{
            "$ref":"#/definitions/LdapConfigDetail"
        },
        "richHistoryConfigId":{
            "type":"string"
        },
        "richHistoryConfigName":{
            "type":"string"
        }
    }
}

Nested Schema : components

Type: array

Show Source

• Array of: object BesuComponent
  Besu component details.

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

Nested Schema : LdapConfigDetail

Type: object

LDAP Configuration details

Show Source

• backupHosts: array backupHosts
  Maximum Number of Items: 2

  List of backup domain controllers for AD
• bpmUserGroup: string
  Users with membership to this group can login and have full access Blockchain Platform Manager (this console) and perform life cycle operations on the Blockchain instances. Required only for AD
• caAdminGroup: string
  Users part of this group will have the authority to register other users. CA Administrator privilege is also needed to create a new Blockchain instance. Required only for AD
• connectTimeout: integer
• groupClassName: string
• groupMembershipAttribute: string
• groupNameAttribute: string
• idbClientId: string
  IDB client id. Populated only for the default LDAP configuration.
• idbClientSecret: string
  IDB client secret. Populated only for the default LDAP configuration.
• instanceAdminGroup: string
  Users with membership to this group can have full access to an instance console and perform all the operations on it via UI or REST APIs. Required only for AD
• instanceUserGroup: string
  Users with membership to this group can view an instances console via UI or REST. They will not be able to perform any other operations. Required only for AD
• ldapBaseDN: string
• ldapBindDN: string
• ldapBindPassword: string(password)
  Returned masked.
• ldapHost: string
• ldapId: string
• ldapName: string
• ldapPort: integer
• ldapTLSCACert: string
• ldapTLSEnabled: boolean
• ldapType: string
• restProxyGroup: string
  Users with membership to this group can interact with the instance using Rest Proxy APIs. Required only for AD
• tlsRootCACertFileName: string
  Existing LDAP TLS root CA certificate filename, when present.
• userClassName: string
• userNameAttribute: string

{
    "description":"LDAP Configuration details",
    "type":"object",
    "properties":{
        "ldapId":{
            "type":"string"
        },
        "ldapName":{
            "type":"string"
        },
        "ldapType":{
            "type":"string"
        },
        "ldapHost":{
            "type":"string"
        },
        "ldapPort":{
            "type":"integer"
        },
        "ldapTLSEnabled":{
            "type":"boolean"
        },
        "ldapTLSCACert":{
            "type":"string"
        },
        "ldapBaseDN":{
            "type":"string"
        },
        "ldapBindDN":{
            "type":"string"
        },
        "ldapBindPassword":{
            "type":"string",
            "format":"password",
            "description":"Returned masked."
        },
        "userNameAttribute":{
            "type":"string"
        },
        "userClassName":{
            "type":"string"
        },
        "groupNameAttribute":{
            "type":"string"
        },
        "groupMembershipAttribute":{
            "type":"string"
        },
        "groupClassName":{
            "type":"string"
        },
        "connectTimeout":{
            "type":"integer"
        },
        "bpmUserGroup":{
            "type":"string",
            "description":"Users with membership to this group can login and have full access Blockchain Platform Manager (this console) and perform life cycle operations on the Blockchain instances. Required only for AD"
        },
        "caAdminGroup":{
            "type":"string",
            "description":"Users part of this group will have the authority to register other users. CA Administrator privilege is also needed to create a new Blockchain instance. Required only for AD"
        },
        "instanceUserGroup":{
            "type":"string",
            "description":"Users with membership to this group can view an instances console via UI or REST. They will not be able to perform any other operations. Required only for AD"
        },
        "instanceAdminGroup":{
            "type":"string",
            "description":"Users with membership to this group can have full access to an instance console and perform all the operations on it via UI or REST APIs. Required only for AD"
        },
        "restProxyGroup":{
            "type":"string",
            "description":"Users with membership to this group can interact with the instance using Rest Proxy APIs. Required only for AD"
        },
        "backupHosts":{
            "type":"array",
            "description":"List of backup domain controllers for AD",
            "maxItems":2,
            "items":{
                "type":"string"
            }
        },
        "tlsRootCACertFileName":{
            "type":"string",
            "description":"Existing LDAP TLS root CA certificate filename, when present."
        },
        "idbClientId":{
            "type":"string",
            "description":"IDB client id. Populated only for the default LDAP configuration."
        },
        "idbClientSecret":{
            "type":"string",
            "description":"IDB client secret. Populated only for the default LDAP configuration."
        }
    }
}

Nested Schema : BesuComponent

Type: object

Besu component details.

Show Source

• alias: string
• name: string
• replicas: integer
• status: string
  Allowed Values: [ "PENDING", "PROVISIONED", "FAILED", "TERMINATING", "TERMINATED" ]
• type: string
  Allowed Values: [ "validator", "bootnode", "archivenode", "rpc", "rpcproxy", "serviceconsole", "archive" ]
• version: string

{
    "description":"Besu component details.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "validator",
                "bootnode",
                "archivenode",
                "rpc",
                "rpcproxy",
                "serviceconsole",
                "archive"
            ]
        },
        "status":{
            "type":"string",
            "enum":[
                "PENDING",
                "PROVISIONED",
                "FAILED",
                "TERMINATING",
                "TERMINATED"
            ]
        },
        "replicas":{
            "type":"integer"
        },
        "alias":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    }
}

Nested Schema : backupHosts

Type: array

Maximum Number of Items: 2

List of backup domain controllers for AD

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of backup domain controllers for AD",
    "maxItems":2,
    "items":{
        "type":"string"
    }
}

400 Response

Bad Request

Body ()

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

401 Response

Unauthorized

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

403 Response

Forbidden. The authenticated caller lacks a required global role, instance-access-group membership, or a valid CSRF token.

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

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

Internal Server Error

Body ()

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

Back to Top