Jump to

• Request
• Response

Get Broker Server Certificates

get

/api/broker/Servers/executeReadCerts

Gets the certificate and key files required to share trust between servers. This endpoint is intended for internal use by the Broker to share certificates between broker-managed servers. You must have the execute permission for servers to use this endpoint.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/brokerServersReadCerts"
                    }
                },
                "total":{
                    "description":"The total number of certificate and key files returned.",
                    "type":"integer",
                    "example":"2"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of certificate and key files returned.

  Example: 2

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/brokerServersReadCerts"
            }
        },
        "total":{
            "description":"The total number of certificate and key files returned.",
            "type":"integer",
            "example":"2"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object brokerServersReadCerts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/brokerServersReadCerts"
    }
}

Nested Schema : brokerServersReadCerts

Type: object

Show Source

• Content: string (byte)
  The base64-encoded file content.
• Filename: string
  The certificate or key file name.

  Example: Assure1CA.crt

{
    "type":"object",
    "properties":{
        "Filename":{
            "description":"The certificate or key file name.",
            "type":"string",
            "example":"Assure1CA.crt"
        },
        "Content":{
            "description":"The base64-encoded file content.",
            "type":"string",
            "format":"byte"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top