CRcriblio
packs

Upgrade a Pack

Changed on

Upgrade the specified Pack.<br/><br/>If the Pack includes any user-modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.<br/><br/>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.

patch/packs/{id}

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

idstring required

The <code>id</code> of the Pack to upgrade. Use the <code>id</code> field from the list response.

Request body

allowCustomFunctionsboolean

If <code>true</code> or omitted, allow the Pack to use custom JavaScript functions. If <code>false</code>, reject Packs that use custom JavaScript functions.

minorboolean

If <code>true</code>, allow the upgrade to install a minor (non-breaking) version. Otherwise, <code>false</code>.

sourcestring required

Source of the upgraded Pack. Use the <code>source</code> value returned by <code>PUT /packs</code> for an uploaded file, or provide a direct URL to a <code>.crbl</code> file or a <code>git+<repo-url></code> Git repository URL.

specstring

Semver range constraint to apply when resolving the Pack version to install.

Response

The upgraded Pack object in a single-item list.

countinteger required

Number of items returned in the items array.

Example response

{
  "items": [
    {
      "tags": {
        "domain": [
          "security",
          "observability"
        ],
        "technology": [
          "aws",
          "splunk"
        ]
      },
      "version": "1.0.0"
    }
  ]
}

Changes

  • fd542bb248a2Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 3816b6fddba1Revision changes
    • info

      added the non-success 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