Jump to

• Request
• Response

List Besu Instances

get

/api/v1/besu/instance

List all Besu instances visible to the caller's authorized instance-access groups.

Request

Query Parameters

• includePending: boolean
  Include pending instances in summary calculations.

  Default Value: false
• includeSummary: boolean
  Include instances summary.

  Default Value: false

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 : BesuInstancesSummaryWrapper

Type: object

Besu instances summary list wrapper.

Show Source

• instances: array instances
• summary: object BesuInstancesCountSummary
  Blockchain Platform Summary

{
    "description":"Besu instances summary list wrapper.",
    "type":"object",
    "properties":{
        "instances":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BesuInstanceSummary"
            }
        },
        "summary":{
            "$ref":"#/definitions/BesuInstancesCountSummary"
        }
    }
}

Nested Schema : instances

Type: array

Show Source

• Array of: object BesuInstanceSummary
  Besu Instance summary.

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

Nested Schema : BesuInstancesCountSummary

Type: object

Blockchain Platform Summary

Show Source

• developerCount: integer
  total number of developer instances
• digitalAssetsCount: integer
  total number of digital assets instances
• enterpriseCount: integer
  total number of enterprise instances
• founderCount: integer
  total number of founder instances
• instancesCount: integer
  total number of instances
• participantCount: integer
  total number of participant instances

{
    "description":"Blockchain Platform Summary",
    "type":"object",
    "properties":{
        "instancesCount":{
            "description":"total number of instances",
            "type":"integer"
        },
        "founderCount":{
            "description":"total number of founder instances",
            "type":"integer"
        },
        "participantCount":{
            "description":"total number of participant instances",
            "type":"integer"
        },
        "enterpriseCount":{
            "description":"total number of enterprise instances",
            "type":"integer"
        },
        "developerCount":{
            "description":"total number of developer instances",
            "type":"integer"
        },
        "digitalAssetsCount":{
            "description":"total number of digital assets instances",
            "type":"integer"
        }
    }
}

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

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

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