core/v2/pipelines

IMPORTANT: The pipelines you can create and manage with this core/v2/pipelines API are observation event processing workflows made up of filters, mutators, and handlers.

Pipelines are different from the resources you can create and manage with the enterprise/pipeline/v1 API, which allows you to create and manage resources that can only be used in pipelines.

NOTE: Requests to core/v2/pipelines API endpoints require you to authenticate with a Sensu API key or access token. The code examples in this document use the environment variable $SENSU_API_KEY to represent a valid API key in API requests.

Get all pipelines

The /pipelines API endpoint provides HTTP GET access to pipeline data.

Example

The following example demonstrates a GET request to the /pipelines API endpoint:

curl -X GET \
http://127.0.0.1:8080/api/core/v2/namespaces/default/pipelines \
-H "Authorization: Key $SENSU_API_KEY"

The request results in a successful HTTP/1.1 200 OK response and a JSON array that contains the pipeline definitions in the default namespace:

[
  {
    "metadata": {
      "name": "labeled_emails",
      "namespace": "default",
      "created_by": "admin"
    },
    "workflows": [
      {
        "name": "default",
        "filters": [
          {
            "name": "is_incident",
            "type": "EventFilter",
            "api_version": "core/v2"
          },
          {
            "name": "state_change_only",
            "type": "EventFilter",
            "api_version": "core/v2"
          }
        ],
        "mutator": {
          "name": "add_labels",
          "type": "Mutator",
          "api_version": "core/v2"
        },
        "handler": {
          "name": "email",
          "type": "Handler",
          "api_version": "core/v2"
        }
      }
    ]
  },
  {
    "metadata": {
      "name": "slack_pipeline",
      "namespace": "default",
      "created_by": "admin"
    },
    "workflows": [
      {
        "name": "default",
        "filters": [
          {
            "name": "is_incident",
            "type": "EventFilter",
            "api_version": "core/v2"
          },
          {
            "name": "state_change_only",
            "type": "EventFilter",
            "api_version": "core/v2"
          }
        ],
        "mutator": {
          "name": "add_labels",
          "type": "Mutator",
          "api_version": "core/v2"
        },
        "handler": {
          "name": "slack",
          "type": "Handler",
          "api_version": "core/v2"
        }
      }
    ]
  }
]

API Specification

/pipelines (GET)
description	Returns the list of pipelines.
example url	http://hostname:8080/api/core/v2/namespaces/default/pipelines
pagination	This endpoint supports pagination using the `limit` and `continue` query parameters.
response filtering	This endpoint supports API response filtering.
response type	Array
response codes	Success: 200 (OK) Error: 500 (Internal Server Error)
output	[ { "metadata": { "name": "labeled_emails", "namespace": "default", "created_by": "admin" }, "workflows": [ { "name": "default", "filters": [ { "name": "is_incident", "type": "EventFilter", "api_version": "core/v2" }, { "name": "state_change_only", "type": "EventFilter", "api_version": "core/v2" } ], "mutator": { "name": "add_labels", "type": "Mutator", "api_version": "core/v2" }, "handler": { "name": "email", "type": "Handler", "api_version": "core/v2" } } ] }, { "metadata": { "name": "slack_pipeline", "namespace": "default", "created_by": "admin" }, "workflows": [ { "name": "default", "filters": [ { "name": "is_incident", "type": "EventFilter", "api_version": "core/v2" }, { "name": "state_change_only", "type": "EventFilter", "api_version": "core/v2" } ], "mutator": { "name": "add_labels", "type": "Mutator", "api_version": "core/v2" }, "handler": { "name": "slack", "type": "Handler", "api_version": "core/v2" } } ] } ]

Create a new pipeline

The /pipelines API endpoint provides HTTP POST access to create a pipeline.

Example

In the following example, an HTTP POST request is submitted to the /pipelines API endpoint to create the pipeline resource labeled_emails:

curl -X POST \
-H "Authorization: Key $SENSU_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
  "metadata": {
    "name": "labeled_emails",
    "namespace": "default"
  },
  "workflows": [
    {
      "name": "default",
      "filters": [
        {
          "api_version": "core/v2",
          "type": "EventFilter",
          "name": "is_incident"
        },
        {
          "api_version": "core/v2",
          "type": "EventFilter",
          "name": "state_change_only"
        }
      ],
      "mutator": {
        "api_version": "core/v2",
        "type": "Mutator",
        "name": "add_labels"
      },
      "handler": {
        "api_version": "core/v2",
        "type": "Handler",
        "name": "email"
      }
    }
  ]
}' \
http://127.0.0.1:8080/api/core/v2/namespaces/default/pipelines

The request will return a successful HTTP/1.1 201 Created response.

API Specification

/pipelines (POST)
description	Creates a Sensu pipeline.
example URL	http://hostname:8080/api/core/v2/namespaces/default/pipelines
payload	`{ "metadata": { "name": "labeled_email", "namespace": "default" }, "workflows": [ { "name": "default", "filters": [ { "api_version": "core/v2", "type": "EventFilter", "name": "is_incident" }, { "api_version": "core/v2", "type": "EventFilter", "name": "state_change_only" } ], "mutator": { "api_version": "core/v2", "type": "Mutator", "name": "add_labels" }, "handler": { "api_version": "core/v2", "type": "Handler", "name": "email" } } ] }`
response codes	Success: 201 (Created) Malformed: 400 (Bad Request) Error: 500 (Internal Server Error)

Get a specific pipeline

The /pipelines/:pipeline API endpoint provides HTTP GET access to pipeline data for specific :pipeline definitions, by pipeline name.

Example

The following example queries the /pipelines/:pipeline API endpoint for the :pipeline named labeled_emails:

curl -X GET \
http://127.0.0.1:8080/api/core/v2/namespaces/default/pipelines/labeled_emails \
-H "Authorization: Key $SENSU_API_KEY"

The request will return a successful HTTP/1.1 200 OK response and a JSON map that contains the requested :pipeline definition (in this example, labeled_emails):

{
  "metadata": {
    "name": "labeled_emails",
    "namespace": "default",
    "created_by": "admin"
  },
  "workflows": [
    {
      "name": "default",
      "filters": [
        {
          "name": "is_incident",
          "type": "EventFilter",
          "api_version": "core/v2"
        },
        {
          "name": "state_change_only",
          "type": "EventFilter",
          "api_version": "core/v2"
        }
      ],
      "mutator": {
        "name": "add_labels",
        "type": "Mutator",
        "api_version": "core/v2"
      },
      "handler": {
        "name": "email",
        "type": "Handler",
        "api_version": "core/v2"
      }
    }
  ]
}

API Specification

/pipelines/:pipeline (GET)
description	Returns a pipeline.
example url	http://hostname:8080/api/core/v2/namespaces/default/pipelines/labeled_emails
response type	Map
response codes	Success: 200 (OK) Missing: 404 (Not Found) Error: 500 (Internal Server Error)
output	`{ "metadata": { "name": "labeled_emails", "namespace": "default", "created_by": "admin" }, "workflows": [ { "name": "default", "filters": [ { "name": "is_incident", "type": "EventFilter", "api_version": "core/v2" }, { "name": "state_change_only", "type": "EventFilter", "api_version": "core/v2" } ], "mutator": { "name": "add_labels", "type": "Mutator", "api_version": "core/v2" }, "handler": { "name": "email", "type": "Handler", "api_version": "core/v2" } } ] }`

Create or update a pipeline

The /pipelines/:pipeline API endpoint provides HTTP PUT access to create or update a specific :pipeline definition, by pipeline name.

Example

In the following example, an HTTP PUT request is submitted to the /pipelines/:pipeline API endpoint to update slack_pipeline to use javascript_mutator instead of the add_labels mutator:

curl -X PUT \
-H "Authorization: Key $SENSU_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
  "metadata": {
    "name": "slack_pipeline",
    "namespace": "default"
  },
  "workflows": [
    {
      "name": "default",
      "filters": [
        {
          "api_version": "core/v2",
          "type": "EventFilter",
          "name": "is_incident"
        },
        {
          "api_version": "core/v2",
          "type": "EventFilter",
          "name": "state_change_only"
        }
      ],
      "mutator": {
        "api_version": "core/v2",
        "type": "Mutator",
        "name": "javascript_mutator"
      },
      "handler": {
        "api_version": "core/v2",
        "type": "Handler",
        "name": "slack"
      }
    }
  ]
}' \
http://127.0.0.1:8080/api/core/v2/namespaces/default/pipelines/slack_pipeline

The request will return a successful HTTP/1.1 201 Created response.

API Specification

/pipelines/:pipeline (PUT)
description	Creates or updates the specified Sensu pipeline.
example URL	http://hostname:8080/api/core/v2/namespaces/default/pipelines/slack_pipeline
payload	`{ "metadata": { "name": "slack_pipeline", "namespace": "default" }, "workflows": [ { "name": "default", "filters": [ { "api_version": "core/v2", "type": "EventFilter", "name": "is_incident" }, { "api_version": "core/v2", "type": "EventFilter", "name": "state_change_only" } ], "mutator": { "api_version": "core/v2", "type": "Mutator", "name": "javascript_mutator" }, "handler": { "api_version": "core/v2", "type": "Handler", "name": "slack" } } ] }`
response codes	Success: 201 (Created) Malformed: 400 (Bad Request) Error: 500 (Internal Server Error)

Update a pipeline with PATCH

The /pipelines/:pipeline API endpoint provides HTTP PATCH access to update :pipeline definitions, specified by pipeline name.

NOTE: You cannot change a resource’s name or namespace with a PATCH request. Use a PUT request instead.

Also, you cannot add elements to an array with a PATCH request — you must replace the entire array.

Example

In the following example, an HTTP PATCH request is submitted to the /pipelines/:pipeline API endpoint to update the mutator for slack_pipeline, resulting in an HTTP/1.1 200 OK response and the updated pipeline definition.

We support JSON merge patches, so you must set the Content-Type header to application/merge-patch+json for PATCH requests.

curl -X PATCH \
-H "Authorization: Key $SENSU_API_KEY" \
-H 'Content-Type: application/merge-patch+json' \
-d '{
  "workflows": [
    {
      "mutator": {
        "api_version": "core/v2",
        "type": "Mutator",
        "name": "javascript_mutator_2"
      }
    }
  ]
}' \
http://127.0.0.1:8080/api/core/v2/namespaces/default/pipelines/slack_pipeline

API Specification

/pipelines/:pipeline (PATCH)
description	Updates the specified Sensu pipeline.
example URL	http://hostname:8080/api/core/v2/namespaces/default/pipelines/slack_pipeline
payload	`{ "workflows": [ { "mutator": { "api_version": "core/v2", "type": "Mutator", "name": "javascript_mutator" } } ] }`
response codes	Success: 200 (OK) Malformed: 400 (Bad Request) Error: 500 (Internal Server Error)

Delete a pipeline

The /pipelines/:pipeline API endpoint provides HTTP DELETE access to delete a pipeline from Sensu (specified by the pipeline name).

Example

The following example shows a request to the /pipelines/:pipeline API endpoint to delete slack_pipeline, resulting in a successful HTTP/1.1 204 No Content response:

curl -X DELETE \
http://127.0.0.1:8080/api/core/v2/namespaces/default/pipelines/slack_pipeline \
-H "Authorization: Key $SENSU_API_KEY"

API Specification

/pipelines/:pipeline (DELETE)
description	Removes the specified pipeline from Sensu.
example url	http://hostname:8080/api/core/v2/namespaces/default/pipelines/slack_pipeline
response codes	Success: 204 (No Content) Missing: 404 (Not Found) Error: 500 (Internal Server Error)

Get a subset of pipelines with response filtering

The /pipelines API endpoint supports response filtering for a subset of pipeline data based on labels and the following fields:

pipeline.name
pipeline.namespace

Example

The following example demonstrates a request to the /pipelines API endpoint with response filtering for only pipeline definitions in the production namespace:

curl -H "Authorization: Key $SENSU_API_KEY" http://127.0.0.1:8080/api/core/v2/pipelines -G \
--data-urlencode 'fieldSelector=pipeline.namespace == production'

The example request will result in a successful HTTP/1.1 200 OK response and a JSON array that contains only pipeline definitions in the production namespace:

[
  {
    "metadata": {
      "name": "sensu_email_alerts",
      "namespace": "production",
      "created_by": "admin"
    },
    "workflows": [
      {
        "name": "labeled_email_alerts",
        "filters": [
          {
            "name": "is_incident",
            "type": "EventFilter",
            "api_version": "core/v2"
          },
          {
            "name": "state_change_only",
            "type": "EventFilter",
            "api_version": "core/v2"
          }
        ],
        "mutator": {
          "name": "add_labels",
          "type": "Mutator",
          "api_version": "core/v2"
        },
        "handler": {
          "name": "email",
          "type": "Handler",
          "api_version": "core/v2"
        }
      }
    ]
  },
  {
    "metadata": {
      "name": "sensu_to_sumo",
      "namespace": "production",
      "created_by": "admin"
    },
    "workflows": [
      {
        "name": "logs_to_sumologic",
        "handler": {
          "name": "sumologic",
          "type": "Handler",
          "api_version": "core/v2"
        }
      }
    ]
  }
]

NOTE: Read API response filtering for more filter statement examples that demonstrate how to filter responses using different operators with label and field selectors.

API Specification

/pipelines (GET) with response filters
description	Returns the list of pipelines that match the response filters applied in the API request.
example url	http://hostname:8080/api/core/v2/pipelines
pagination	This endpoint supports pagination using the `limit` and `continue` query parameters.
response type	Array
response codes	Success: 200 (OK) Error: 500 (Internal Server Error)
output	[ { "metadata": { "name": "sensu_email_alerts", "namespace": "production", "created_by": "admin" }, "workflows": [ { "name": "labeled_email_alerts", "filters": [ { "name": "is_incident", "type": "EventFilter", "api_version": "core/v2" }, { "name": "state_change_only", "type": "EventFilter", "api_version": "core/v2" } ], "mutator": { "name": "add_labels", "type": "Mutator", "api_version": "core/v2" }, "handler": { "name": "email", "type": "Handler", "api_version": "core/v2" } } ] }, { "metadata": { "name": "sensu_to_sumo", "namespace": "production", "created_by": "admin" }, "workflows": [ { "name": "logs_to_sumologic", "handler": { "name": "sumologic", "type": "Handler", "api_version": "core/v2" } } ] } ]

core/v2/pipelines

Get all pipelines

Example

API Specification

Create a new pipeline

Example

API Specification

Get a specific pipeline

Example

API Specification

Create or update a pipeline

Example

API Specification

Update a pipeline with PATCH

Example

API Specification

Delete a pipeline

Example

API Specification

Get a subset of pipelines with response filtering

Example

API Specification

Register your Sensu installation — Get rewards!

About Sensu

Navigation

Resources

Community

Get In Touch

Join Our Community