|
1 | 1 | [[delete-pipeline-api]] |
2 | | -=== Delete Pipeline API |
| 2 | +=== Delete pipeline API |
| 3 | +++++ |
| 4 | +<titleabbrev>Delete pipeline</titleabbrev> |
| 5 | +++++ |
3 | 6 |
|
4 | | -The delete pipeline API deletes pipelines by ID or wildcard match (`my-*`, `*`). |
5 | | - |
6 | | -////////////////////////// |
| 7 | +Deletes one or more existing ingest pipeline. |
7 | 8 |
|
| 9 | +//// |
8 | 10 | [source,js] |
9 | | --------------------------------------------------- |
10 | | -PUT _ingest/pipeline/my-pipeline-id |
| 11 | +---- |
| 12 | +PUT /_ingest/pipeline/my-pipeline-id |
11 | 13 | { |
12 | | - "description" : "describe pipeline", |
13 | | - "version" : 123, |
14 | | - "processors" : [ |
15 | | - { |
16 | | - "set" : { |
17 | | - "field": "foo", |
18 | | - "value": "bar" |
19 | | - } |
20 | | - } |
21 | | - ] |
| 14 | + "description" : "example pipeline to delete", |
| 15 | + "processors" : [ ] |
22 | 16 | } |
23 | | --------------------------------------------------- |
24 | | -// CONSOLE |
25 | 17 |
|
26 | | -////////////////////////// |
| 18 | +PUT /_ingest/pipeline/pipeline-one |
| 19 | +{ |
| 20 | + "description" : "another example pipeline to delete", |
| 21 | + "processors" : [ ] |
| 22 | +} |
| 23 | +---- |
| 24 | +// CONSOLE |
| 25 | +// TESTSETUP |
| 26 | +//// |
27 | 27 |
|
28 | 28 | [source,js] |
29 | | --------------------------------------------------- |
30 | | -DELETE _ingest/pipeline/my-pipeline-id |
31 | | --------------------------------------------------- |
| 29 | +---- |
| 30 | +DELETE /_ingest/pipeline/my-pipeline-id |
| 31 | +---- |
32 | 32 | // CONSOLE |
33 | | -// TEST[continued] |
34 | 33 |
|
35 | | -////////////////////////// |
36 | 34 |
|
37 | | -[source,js] |
38 | | --------------------------------------------------- |
39 | | -{ |
40 | | -"acknowledged": true |
41 | | -} |
42 | | --------------------------------------------------- |
43 | | -// TESTRESPONSE |
| 35 | +[[delete-pipeline-api-request]] |
| 36 | +==== {api-request-title} |
44 | 37 |
|
45 | | -[source,js] |
46 | | --------------------------------------------------- |
47 | | -PUT _ingest/pipeline/wild-one |
48 | | -{ |
49 | | - "description" : "first pipeline to be wildcard deleted", |
50 | | - "processors" : [ ] |
51 | | -} |
| 38 | +`DELETE /_ingest/pipeline/<pipeline>` |
52 | 39 |
|
53 | | -PUT _ingest/pipeline/wild-two |
54 | | -{ |
55 | | - "description" : "second pipeline to be wildcard deleted", |
56 | | - "processors" : [ ] |
57 | | -} |
58 | | --------------------------------------------------- |
| 40 | + |
| 41 | +[[delete-pipeline-api-path-params]] |
| 42 | +==== {api-path-parms-title} |
| 43 | + |
| 44 | +`<pipeline>`:: |
| 45 | ++ |
| 46 | +-- |
| 47 | +(Required, string) Pipeline ID or wildcard expression of pipeline IDs |
| 48 | +used to limit the request. |
| 49 | + |
| 50 | +To delete all ingest pipelines in a cluster, |
| 51 | +use a value of `*`. |
| 52 | +-- |
| 53 | + |
| 54 | + |
| 55 | +[[delete-pipeline-api-query-params]] |
| 56 | +==== {api-query-parms-title} |
| 57 | + |
| 58 | +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] |
| 59 | + |
| 60 | + |
| 61 | +[[delete-pipeline-api-api-example]] |
| 62 | +==== {api-examples-title} |
| 63 | + |
| 64 | + |
| 65 | +[[delete-pipeline-api-specific-ex]] |
| 66 | +===== Delete a specific ingest pipeline |
| 67 | + |
| 68 | +[source,js] |
| 69 | +---- |
| 70 | +DELETE /_ingest/pipeline/pipeline-one |
| 71 | +---- |
59 | 72 | // CONSOLE |
60 | 73 |
|
61 | | -////////////////////////// |
| 74 | + |
| 75 | +[[delete-pipeline-api-wildcard-ex]] |
| 76 | +===== Delete ingest pipelines using a wildcard expression |
62 | 77 |
|
63 | 78 | [source,js] |
64 | | --------------------------------------------------- |
65 | | -DELETE _ingest/pipeline/* |
66 | | --------------------------------------------------- |
| 79 | +---- |
| 80 | +DELETE /_ingest/pipeline/pipeline-* |
| 81 | +---- |
67 | 82 | // CONSOLE |
68 | 83 |
|
69 | | -////////////////////////// |
| 84 | + |
| 85 | +[[delete-pipeline-api-all-ex]] |
| 86 | +===== Delete all ingest pipelines |
70 | 87 |
|
71 | 88 | [source,js] |
72 | | --------------------------------------------------- |
| 89 | +---- |
| 90 | +DELETE /_ingest/pipeline/* |
| 91 | +---- |
| 92 | +// CONSOLE |
| 93 | + |
| 94 | +//// |
| 95 | +[source,js] |
| 96 | +---- |
73 | 97 | { |
74 | 98 | "acknowledged": true |
75 | 99 | } |
76 | | --------------------------------------------------- |
| 100 | +---- |
77 | 101 | // TESTRESPONSE |
78 | | -
|
79 | | -////////////////////////// |
| 102 | +//// |
0 commit comments