CRcriblio
workers

Get detailed metadata for Worker, Edge, or Outpost Nodes

Changed on

Get detailed metadata for Worker, Edge, or Outpost Nodes for the specified Cribl product.

get/products/{product}/workers

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: https://login.cribl.cloud/oauth/token

Path parameters

product'stream' | 'edge' | 'outpost' required

Name of the Cribl product to get Worker, Edge, or Outpost Nodes for.

Query parameters

filterExpstring

Filter expression to evaluate against Nodes for inclusion in the response.

Example:group=="default"

Filter expression to evaluate against Nodes for inclusion in the response (for example, <code>status=='healthy'</code>).

sortExpstring

Sorting expression to evaluate against Nodes to specify the sort order for the response.

filterstring

JSON-stringified filter object to evaluate against Nodes for inclusion in the response.

Example:%7B%22field%22%3A%22group%22%2C%22op%22%3A%22is%22%2C%22value%22%3A%22default%22%7D

JSON-stringified filter object to evaluate against Nodes for inclusion in the response (for example, <code>{"field":"status","op":"eq","value":"healthy"}</code>).

sortstring

JSON-stringified sorting object to evaluate against Nodes to specify the sort order for the response.

limitinteger

Maximum number of Nodes to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches.

offsetinteger

Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches.

Response

List of MasterWorkerEntry objects.

countinteger required

Number of items returned in the items array.

offsetinteger

Pagination offset. Returned when offset/limit query parameters are provided.

limitinteger

Pagination limit. Returned when offset/limit query parameters are provided.

totalCountinteger

Total number of items available. Returned when offset/limit query parameters are provided.

Example response

{
  "items": [
    {
      "info": {
        "architecture": "x64",
        "cribl": {
          "distMode": "worker"
        },
        "platform": "linux"
      }
    }
  ]
}

Changes

  • 3816b6fddba1Revision changes
    • warning

      added the new dedicated-org-leader enum value to the //// response property for the response status

    • warning

      added the new org-leader enum value to the //// response property for the response status

    • info

      added the optional property //// to the response with the status

  • e9bef570d106Revision changes
    • breaking

      added to the /// response property oneOf list for the response status

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed from the /// response property oneOf list for the response status

    • info

      added the required property to the response with the status