CRcriblio
pipelines

Update a Pipeline

Changed on

Update the specified Pipeline.<br/><br/>Provide a complete representation of the Pipeline that you want to update in the request body.<br/><br/>This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Pipeline.<br/><br/>Confirm that the configuration in your request body is correct before sending the request.<br/><br/>If the configuration is incorrect, the updated Pipeline might not function as expected.

patch/pipelines/{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 Pipeline to update.

Request body

idstring required

Unique identifier for the Pipeline.

Example request

{
  "conf": {
    "functions": [
      {
        "id": "aggregate_metrics"
      }
    ]
  }
}

Response

The updated Pipeline object in a single-item list.

countinteger required

Number of items returned in the items array.

Example response

{
  "items": [
    {
      "conf": {
        "functions": [
          {
            "id": "aggregate_metrics"
          }
        ]
      }
    }
  ]
}

Changes

  • fd542bb248a2Revision changes
    • breaking

      removed subschema #1 subschema #2 from the ///////// request property oneOf list

    • breaking

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

    • breaking

      added subschema #1 subschema #2 to the /////////// response property oneOf list for the response status

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added local_search_datatype_schema_mapper discriminator mapping keys to the // request property

    • info

      added to the // request property oneOf list

    • info

      added subschema #1 subschema #2 to the ///////// request property oneOf list

    • 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

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

    • info

      added local_search_datatype_schema_mapper discriminator mapping keys to the //// response property for the response status

    • info

      removed subschema #1 subschema #2 from the /////////// response property oneOf list for the response status

  • 3816b6fddba1Revision changes
    • breaking

      removed subschema #1 subschema #2 from the ///////// request property oneOf list

    • breaking

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

    • breaking

      added subschema #1 subschema #2 to the /////////// response property oneOf list for the response status

    • warning

      removed the request property /////////////////

    • warning

      removed the request property ////////////

    • warning

      removed the optional property /////////////////// from the response with the status

    • warning

      removed the optional property ////////////// from the response with the status

    • info

      added detection_rules lakehouse_engine_metrics_normalizer metrics_time_range_gate discriminator mapping keys to the // request property

    • info

      added to the // request property oneOf list

    • info

      added subschema #1 subschema #2 to the ///////// request property oneOf list

    • info

      added detection_rules lakehouse_engine_metrics_normalizer metrics_time_range_gate discriminator mapping keys to the //// response property for the response status

    • info

      removed subschema #1 subschema #2 from the /////////// response property oneOf list for the response status