Added: nifi/site/trunk/docs/nifi-registry-docs/html/rest-api.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-registry-docs/html/rest-api.html?rev=1859662&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-registry-docs/html/rest-api.html (added) +++ nifi/site/trunk/docs/nifi-registry-docs/html/rest-api.html Tue May 21 16:47:35 2019 @@ -0,0 +1,23846 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + <!DOCTYPE html> +<html lang="en"> +<head> +<meta charset="UTF-8"> +<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<meta name="generator" content="Asciidoctor 1.5.7.1"> +<title>Apache NiFi Registry REST API</title> +<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";> +<style> +/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */ +/* Uncomment @import statement below to use as custom stylesheet */ +/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/ +article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block} +audio,canvas,video{display:inline-block} +audio:not([controls]){display:none;height:0} +script{display:none!important} +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} +a{background:transparent} +a:focus{outline:thin dotted} +a:active,a:hover{outline:0} +h1{font-size:2em;margin:.67em 0} +abbr[title]{border-bottom:1px dotted} +b,strong{font-weight:bold} +dfn{font-style:italic} +hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0} +mark{background:#ff0;color:#000} +code,kbd,pre,samp{font-family:monospace;font-size:1em} +pre{white-space:pre-wrap} +q{quotes:"\201C" "\201D" "\2018" "\2019"} +small{font-size:80%} +sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} +sup{top:-.5em} +sub{bottom:-.25em} +img{border:0} +svg:not(:root){overflow:hidden} +figure{margin:0} +fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} +legend{border:0;padding:0} +button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} +button,input{line-height:normal} +button,select{text-transform:none} +button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer} +button[disabled],html input[disabled]{cursor:default} +input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0} +button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} +textarea{overflow:auto;vertical-align:top} +table{border-collapse:collapse;border-spacing:0} +*,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box} +html,body{font-size:100%} +body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased} +a:hover{cursor:pointer} +img,object,embed{max-width:100%;height:auto} +object,embed{height:100%} +img{-ms-interpolation-mode:bicubic} +.left{float:left!important} +.right{float:right!important} +.text-left{text-align:left!important} +.text-right{text-align:right!important} +.text-center{text-align:center!important} +.text-justify{text-align:justify!important} +.hide{display:none} +img,object,svg{display:inline-block;vertical-align:middle} +textarea{height:auto;min-height:50px} +select{width:100%} +.center{margin-left:auto;margin-right:auto} +.stretch{width:100%} +.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} +div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr} +a{color:#2156a5;text-decoration:underline;line-height:inherit} +a:hover,a:focus{color:#1d4b8f} +a img{border:none} +p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} +p aside{font-size:.875em;line-height:1.35;font-style:italic} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} +h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} +h1{font-size:2.125em} +h2{font-size:1.6875em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} +h4,h5{font-size:1.125em} +h6{font-size:1em} +hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} +em,i{font-style:italic;line-height:inherit} +strong,b{font-weight:bold;line-height:inherit} +small{font-size:60%;line-height:inherit} +code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} +ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} +ul,ol{margin-left:1.5em} +ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} +ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} +ul.square{list-style-type:square} +ul.circle{list-style-type:circle} +ul.disc{list-style-type:disc} +ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} +dl dt{margin-bottom:.3125em;font-weight:bold} +dl dd{margin-bottom:1.25em} +abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} +abbr{text-transform:none} +blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} +blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} +blockquote cite::before{content:"\2014 \0020"} +blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} +blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} +@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} +h1{font-size:2.75em} +h2{font-size:2.3125em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} +h4{font-size:1.4375em}} +table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} +table thead,table tfoot{background:#f7f8f7} +table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} +table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} +table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7} +table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} +h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} +.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table} +.clearfix::after,.float-group::after{clear:both} +*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word} +*:not(pre)>code.nobreak{word-wrap:normal} +*:not(pre)>code.nowrap{white-space:nowrap} +pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed} +em em{font-style:normal} +strong strong{font-weight:400} +.keyseq{color:rgba(51,51,51,.8)} +kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap} +.keyseq kbd:first-child{margin-left:0} +.keyseq kbd:last-child{margin-right:0} +.menuseq,.menuref{color:#000} +.menuseq b:not(.caret),.menuref{font-weight:inherit} +.menuseq{word-spacing:-.02em} +.menuseq b.caret{font-size:1.25em;line-height:.8} +.menuseq i.caret{font-weight:bold;text-align:center;width:.45em} +b.button::before,b.button::after{position:relative;top:-1px;font-weight:400} +b.button::before{content:"[";padding:0 3px 0 2px} +b.button::after{content:"]";padding:0 2px 0 3px} +p a>code:hover{color:rgba(0,0,0,.9)} +#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} +#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table} +#header::after,#content::after,#footnotes::after,#footer::after{clear:both} +#content{margin-top:1.25em} +#content::before{content:none} +#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} +#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8} +#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px} +#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap} +#header .details span:first-child{margin-left:-.125em} +#header .details span.email a{color:rgba(0,0,0,.85)} +#header .details br{display:none} +#header .details br+span::before{content:"\00a0\2013\00a0"} +#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} +#header .details br+span#revremark::before{content:"\00a0|\00a0"} +#header #revnumber{text-transform:capitalize} +#header #revnumber::after{content:"\00a0"} +#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} +#toc{border-bottom:1px solid #efefed;padding-bottom:.5em} +#toc>ul{margin-left:.125em} +#toc ul.sectlevel0>li>a{font-style:italic} +#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} +#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} +#toc li{line-height:1.3334;margin-top:.3334em} +#toc a{text-decoration:none} +#toc a:active{text-decoration:underline} +#toctitle{color:#7a2518;font-size:1.2em} +@media screen and (min-width:768px){#toctitle{font-size:1.375em} +body.toc2{padding-left:15em;padding-right:0} +#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} +#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em} +#toc.toc2>ul{font-size:.9em;margin-bottom:0} +#toc.toc2 ul ul{margin-left:0;padding-left:1em} +#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} +body.toc2.toc-right{padding-left:0;padding-right:15em} +body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}} +@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} +#toc.toc2{width:20em} +#toc.toc2 #toctitle{font-size:1.375em} +#toc.toc2>ul{font-size:.95em} +#toc.toc2 ul ul{padding-left:1.25em} +body.toc2.toc-right{padding-left:0;padding-right:20em}} +#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +#content #toc>:first-child{margin-top:0} +#content #toc>:last-child{margin-bottom:0} +#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em} +#footer-text{color:rgba(255,255,255,.8);line-height:1.44} +#content{margin-bottom:.625em} +.sect1{padding-bottom:.625em} +@media screen and (min-width:768px){#content{margin-bottom:1.25em} +.sect1{padding-bottom:1.25em}} +.sect1:last-child{padding-bottom:0} +.sect1+.sect1{border-top:1px solid #efefed} +#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} +#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} +#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} +#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none} +#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} +.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} +.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic} +table.tableblock.fit-content>caption.title{white-space:nowrap;width:0} +.paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)} +table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit} +.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} +.admonitionblock>table td.icon{text-align:center;width:80px} +.admonitionblock>table td.icon img{max-width:none} +.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} +.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)} +.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} +.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px} +.exampleblock>.content>:first-child{margin-top:0} +.exampleblock>.content>:last-child{margin-bottom:0} +.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +.sidebarblock>:first-child{margin-top:0} +.sidebarblock>:last-child{margin-bottom:0} +.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} +.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} +.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8} +.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1} +.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em} +.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal} +@media screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}} +@media screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}} +.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)} +.listingblock pre.highlightjs{padding:0} +.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} +.listingblock pre.prettyprint{border-width:0} +.listingblock>.content{position:relative} +.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999} +.listingblock:hover code[data-lang]::before{display:block} +.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:#999} +.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"} +table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none} +table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45} +table.pyhltable td.code{padding-left:.75em;padding-right:0} +pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8} +pre.pygments .lineno{display:inline-block;margin-right:.25em} +table.pyhltable .linenodiv{background:none!important;padding-right:0!important} +.quoteblock{margin:0 1em 1.25em 1.5em;display:table} +.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em} +.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} +.quoteblock blockquote{margin:0;padding:0;border:0} +.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} +.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} +.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right} +.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)} +.quoteblock .quoteblock blockquote{padding:0 0 0 .75em} +.quoteblock .quoteblock blockquote::before{display:none} +.verseblock{margin:0 1em 1.25em} +.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} +.verseblock pre strong{font-weight:400} +.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} +.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} +.quoteblock .attribution br,.verseblock .attribution br{display:none} +.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)} +.quoteblock.abstract{margin:0 1em 1.25em;display:block} +.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center} +.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{word-spacing:0;line-height:1.6} +.quoteblock.abstract blockquote::before,.quoteblock.abstract p::before{display:none} +table.tableblock{max-width:100%;border-collapse:separate} +p.tableblock:last-child{margin-bottom:0} +td.tableblock>.content{margin-bottom:-1.25em} +table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} +table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0} +table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0} +table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0} +table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px} +table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0} +table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0} +table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0} +table.frame-all{border-width:1px} +table.frame-sides{border-width:0 1px} +table.frame-topbot,table.frame-ends{border-width:1px 0} +table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd){background:#f8f8f7} +table.stripes-none tr,table.stripes-odd tr:nth-of-type(even){background:none} +th.halign-left,td.halign-left{text-align:left} +th.halign-right,td.halign-right{text-align:right} +th.halign-center,td.halign-center{text-align:center} +th.valign-top,td.valign-top{vertical-align:top} +th.valign-bottom,td.valign-bottom{vertical-align:bottom} +th.valign-middle,td.valign-middle{vertical-align:middle} +table thead th,table tfoot th{font-weight:bold} +tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} +tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} +p.tableblock>code:only-child{background:none;padding:0} +p.tableblock{font-size:1em} +td>div.verse{white-space:pre} +ol{margin-left:1.75em} +ul li ol{margin-left:1.5em} +dl dd{margin-left:1.125em} +dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} +ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} +ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none} +ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em} +ul.unstyled,ol.unstyled{margin-left:0} +ul.checklist{margin-left:.625em} +ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em} +ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em} +ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em} +ul.inline>li{margin-left:1.25em} +.unstyled dl dt{font-weight:400;font-style:normal} +ol.arabic{list-style-type:decimal} +ol.decimal{list-style-type:decimal-leading-zero} +ol.loweralpha{list-style-type:lower-alpha} +ol.upperalpha{list-style-type:upper-alpha} +ol.lowerroman{list-style-type:lower-roman} +ol.upperroman{list-style-type:upper-roman} +ol.lowergreek{list-style-type:lower-greek} +.hdlist>table,.colist>table{border:0;background:none} +.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} +td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em} +td.hdlist1{font-weight:bold;padding-bottom:1.25em} +.literalblock+.colist,.listingblock+.colist{margin-top:-.5em} +.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top} +.colist td:not([class]):first-child img{max-width:none} +.colist td:not([class]):last-child{padding:.25em 0} +.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd} +.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0} +.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em} +.imageblock>.title{margin-bottom:0} +.imageblock.thumb,.imageblock.th{border-width:6px} +.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} +.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} +.image.left{margin-right:.625em} +.image.right{margin-left:.625em} +a.image{text-decoration:none;display:inline-block} +a.image object{pointer-events:none} +sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super} +sup.footnote a,sup.footnoteref a{text-decoration:none} +sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline} +#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} +#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0} +#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em} +#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em} +#footnotes .footnote:last-of-type{margin-bottom:0} +#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} +.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0} +.gist .file-data>table td.line-data{width:99%} +div.unbreakable{page-break-inside:avoid} +.big{font-size:larger} +.small{font-size:smaller} +.underline{text-decoration:underline} +.overline{text-decoration:overline} +.line-through{text-decoration:line-through} +.aqua{color:#00bfbf} +.aqua-background{background-color:#00fafa} +.black{color:#000} +.black-background{background-color:#000} +.blue{color:#0000bf} +.blue-background{background-color:#0000fa} +.fuchsia{color:#bf00bf} +.fuchsia-background{background-color:#fa00fa} +.gray{color:#606060} +.gray-background{background-color:#7d7d7d} +.green{color:#006000} +.green-background{background-color:#007d00} +.lime{color:#00bf00} +.lime-background{background-color:#00fa00} +.maroon{color:#600000} +.maroon-background{background-color:#7d0000} +.navy{color:#000060} +.navy-background{background-color:#00007d} +.olive{color:#606000} +.olive-background{background-color:#7d7d00} +.purple{color:#600060} +.purple-background{background-color:#7d007d} +.red{color:#bf0000} +.red-background{background-color:#fa0000} +.silver{color:#909090} +.silver-background{background-color:#bcbcbc} +.teal{color:#006060} +.teal-background{background-color:#007d7d} +.white{color:#bfbfbf} +.white-background{background-color:#fafafa} +.yellow{color:#bfbf00} +.yellow-background{background-color:#fafa00} +span.icon>.fa{cursor:default} +a span.icon>.fa{cursor:inherit} +.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} +.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c} +.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} +.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900} +.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400} +.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000} +.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} +.conum[data-value] *{color:#fff!important} +.conum[data-value]+b{display:none} +.conum[data-value]::after{content:attr(data-value)} +pre .conum[data-value]{position:relative;top:-.125em} +b.conum *{color:inherit!important} +.conum:not([data-value]):empty{display:none} +dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility} +h1,h2,p,td.content,span.alt{letter-spacing:-.01em} +p strong,td.content strong,div.footnote strong{letter-spacing:-.005em} +p,blockquote,dt,td.content,span.alt{font-size:1.0625rem} +p{margin-bottom:1.25rem} +.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} +.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} +.print-only{display:none!important} +@page{margin:1.25cm .75cm} +@media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important} +html{font-size:80%} +a{color:inherit!important;text-decoration:underline!important} +a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} +a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} +abbr[title]::after{content:" (" attr(title) ")"} +pre,blockquote,tr,img,object,svg{page-break-inside:avoid} +thead{display:table-header-group} +svg{max-width:100%} +p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} +h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} +#toc,.sidebarblock,.exampleblock>.content{background:none!important} +#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important} +body.book #header{text-align:center} +body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em} +body.book #header .details{border:0!important;display:block;padding:0!important} +body.book #header .details span:first-child{margin-left:0!important} +body.book #header .details br{display:block} +body.book #header .details br+span::before{content:none!important} +body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} +body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} +.listingblock code[data-lang]::before{display:block} +#footer{padding:0 .9375em} +.hide-on-print{display:none!important} +.print-only{display:block!important} +.hide-for-print{display:none!important} +.show-for-print{display:inherit!important}} +@media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem} +.sect1{padding:0!important} +.sect1+.sect1{border:0} +#footer{background:none} +#footer-text{color:rgba(0,0,0,.6);font-size:.9em}} +@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}} +</style> +</head> +<body class="article"> +<div id="header"> +<h1>Apache NiFi Registry REST API</h1> +<div class="details"> +<span id="revnumber">version 0.4.0</span> +</div> +<div id="toc" class="toc"> +<div id="toctitle">Table of Contents</div> +<ul class="sectlevel1"> +<li><a href="rest-api.html#_overview">1. Overview</a> +<ul class="sectlevel2"> +<li><a href="rest-api.html#_version_information">1.1. Version information</a></li> +<li><a href="rest-api.html#_contact_information">1.2. Contact information</a></li> +<li><a href="rest-api.html#_license_information">1.3. License information</a></li> +<li><a href="rest-api.html#_uri_scheme">1.4. URI scheme</a></li> +<li><a href="rest-api.html#_tags">1.5. Tags</a></li> +</ul> +</li> +<li><a href="rest-api.html#_securityscheme">2. Security</a> +<ul class="sectlevel2"> +<li><a href="rest-api.html#_authorization">2.1. Authorization</a></li> +<li><a href="rest-api.html#_basicauth">2.2. BasicAuth</a></li> +</ul> +</li> +<li><a href="rest-api.html#_paths">3. Resources</a> +<ul class="sectlevel2"> +<li><a href="rest-api.html#_access_resource">3.1. Access</a> +<ul class="sectlevel3"> +<li><a href="rest-api.html#_getaccessstatus">3.1.1. Get access status</a></li> +<li><a href="rest-api.html#_createaccesstokenbytryingallproviders">3.1.2. Create token trying all providers</a></li> +<li><a href="rest-api.html#_createaccesstokenusingidentityprovidercredentials">3.1.3. Create token using identity provider</a></li> +<li><a href="rest-api.html#_testidentityproviderrecognizescredentialsformat">3.1.4. Test identity provider</a></li> +<li><a href="rest-api.html#_getidentityproviderusageinstructions">3.1.5. Get identity provider usage</a></li> +<li><a href="rest-api.html#_createaccesstokenusingkerberosticket">3.1.6. Create token using kerberos</a></li> +<li><a href="rest-api.html#_createaccesstokenusingbasicauthcredentials">3.1.7. Create token using basic auth</a></li> +</ul> +</li> +<li><a href="rest-api.html#_bucket_bundles_resource">3.2. Bucket Bundles</a> +<ul class="sectlevel3"> +<li><a href="rest-api.html#_getextensionbundles">3.2.1. Get extension bundles by bucket</a></li> +<li><a href="rest-api.html#_createextensionbundleversion">3.2.2. Create extension bundle version</a></li> +</ul> +</li> +<li><a href="rest-api.html#_bucket_flows_resource">3.3. Bucket Flows</a> +<ul class="sectlevel3"> +<li><a href="rest-api.html#_createflow">3.3.1. Create flow</a></li> +<li><a href="rest-api.html#_getflows">3.3.2. Get bucket flows</a></li> +<li><a href="rest-api.html#_getflow">3.3.3. Get bucket flow</a></li> +<li><a href="rest-api.html#_updateflow">3.3.4. Update bucket flow</a></li> +<li><a href="rest-api.html#_deleteflow">3.3.5. Delete bucket flow</a></li> +<li><a href="rest-api.html#_getflowdiff">3.3.6. Get bucket flow diff</a></li> +<li><a href="rest-api.html#_createflowversion">3.3.7. Create flow version</a></li> +<li><a href="rest-api.html#_getflowversions">3.3.8. Get bucket flow versions</a></li> +<li><a href="rest-api.html#_getlatestflowversion">3.3.9. Get latest bucket flow version content</a></li> +<li><a href="rest-api.html#_getlatestflowversionmetadata">3.3.10. Get latest bucket flow version metadata</a></li> +<li><a href="rest-api.html#_getflowversion">3.3.11. Get bucket flow version</a></li> +</ul> +</li> +<li><a href="rest-api.html#_buckets_resource">3.4. Buckets</a> +<ul class="sectlevel3"> +<li><a href="rest-api.html#_createbucket">3.4.1. Create bucket</a></li> +<li><a href="rest-api.html#_getbuckets">3.4.2. Get all buckets</a></li> +<li><a href="rest-api.html#_getavailablebucketfields">3.4.3. Get bucket fields</a></li> +<li><a href="rest-api.html#_getbucket">3.4.4. Get bucket</a></li> +<li><a href="rest-api.html#_updatebucket">3.4.5. Update bucket</a></li> +<li><a href="rest-api.html#_deletebucket">3.4.6. Delete bucket</a></li> +</ul> +</li> +<li><a href="rest-api.html#_bundles_resource">3.5. Bundles</a> +<ul class="sectlevel3"> +<li><a href="rest-api.html#_getbundles">3.5.1. Get all bundles</a></li> +<li><a href="rest-api.html#_getbundleversions">3.5.2. Get all bundle versions</a></li> +<li><a href="rest-api.html#_globalgetextensionbundle">3.5.3. Get bundle</a></li> +<li><a href="rest-api.html#_globaldeleteextensionbundle">3.5.4. Delete bundle</a></li> +<li><a href="rest-api.html#_globalgetbundleversions">3.5.5. Get bundle versions</a></li> +<li><a href="rest-api.html#_globalgetbundleversion">3.5.6. Get bundle version</a></li> +<li><a href="rest-api.html#_globaldeletebundleversion">3.5.7. Delete bundle version</a></li> +<li><a href="rest-api.html#_globalgetbundleversioncontent">3.5.8. Get bundle version content</a></li> +<li><a href="rest-api.html#_globalgetbundleversionextensions">3.5.9. Get bundle version extensions</a></li> +<li><a href="rest-api.html#_globalgetbundleversionextension">3.5.10. Get bundle version extension</a></li> +<li><a href="rest-api.html#_getbundleversionextensiondocs">3.5.11. Get bundle version extension docs</a></li> +<li><a href="rest-api.html#_getbundleversionextensionadditionaldetailsdocs">3.5.12. Get bundle version extension docs details</a></li> +</ul> +</li> +<li><a href="rest-api.html#_config_resource">3.6. Config</a> +<ul class="sectlevel3"> +<li><a href="rest-api.html#_getconfiguration">3.6.1. Get configration</a></li> +</ul> +</li> +<li><a href="rest-api.html#_extension_repository_resource">3.7. Extension Repository</a> +<ul class="sectlevel3"> +<li><a href="rest-api.html#_getextensionrepobuckets">3.7.1. Get extension repo buckets</a></li> +<li><a href="rest-api.html#_getextensionrepogroups">3.7.2. Get extension repo groups</a></li> +<li><a href="rest-api.html#_getextensionrepoartifacts">3.7.3. Get extension repo artifacts</a></li> +<li><a href="rest-api.html#_getextensionrepoversions">3.7.4. Get extension repo versions</a></li> +<li><a href="rest-api.html#_getextensionrepoversion">3.7.5. Get extension repo version</a></li> +<li><a href="rest-api.html#_getextensionrepoversioncontent">3.7.6. Get extension repo version content</a></li> +<li><a href="rest-api.html#_getextensionrepoversionextensions">3.7.7. Get extension repo extensions</a></li> +<li><a href="rest-api.html#_getextensionrepoversionextension">3.7.8. Get extension repo extension</a></li> +<li><a href="rest-api.html#_getextensionrepoversionextensiondocs">3.7.9. Get extension repo extension docs</a></li> +<li><a href="rest-api.html#_getextensionrepoversionextensionadditionaldetailsdocs">3.7.10. Get extension repo extension details</a></li> +<li><a href="rest-api.html#_getextensionrepoversionsha256">3.7.11. Get extension repo version checksum</a></li> +<li><a href="rest-api.html#_getglobalextensionrepoversionsha256">3.7.12. Get global extension repo version checksum</a></li> +</ul> +</li> +<li><a href="rest-api.html#_extensions_resource">3.8. Extensions</a> +<ul class="sectlevel3"> +<li><a href="rest-api.html#_getextensions">3.8.1. Get all extensions</a></li> +<li><a href="rest-api.html#_getextensionsprovidingserviceapi">3.8.2. Get extensions providing service API</a></li> +<li><a href="rest-api.html#_gettags">3.8.3. Get extension tags</a></li> +</ul> +</li> +<li><a href="rest-api.html#_flows_resource">3.9. Flows</a> +<ul class="sectlevel3"> +<li><a href="rest-api.html#_getavailableflowfields">3.9.1. Get flow fields</a></li> +<li><a href="rest-api.html#_globalgetflow">3.9.2. Get flow</a></li> +<li><a href="rest-api.html#_globalgetflowversions">3.9.3. Get flow versions</a></li> +<li><a href="rest-api.html#_globalgetlatestflowversion">3.9.4. Get latest flow version</a></li> +<li><a href="rest-api.html#_globalgetlatestflowversionmetadata">3.9.5. Get latest flow version metadata</a></li> +<li><a href="rest-api.html#_globalgetflowversion">3.9.6. Get flow version</a></li> +</ul> +</li> +<li><a href="rest-api.html#_items_resource">3.10. Items</a> +<ul class="sectlevel3"> +<li><a href="rest-api.html#_getitems">3.10.1. Get all items</a></li> +<li><a href="rest-api.html#_getavailablebucketitemfields">3.10.2. Get item fields</a></li> +<li><a href="rest-api.html#_getitemsinbucket">3.10.3. Get bucket items</a></li> +</ul> +</li> +<li><a href="rest-api.html#_policies_resource">3.11. Policies</a> +<ul class="sectlevel3"> +<li><a href="rest-api.html#_createaccesspolicy">3.11.1. Create access policy</a></li> +<li><a href="rest-api.html#_getaccesspolicies">3.11.2. Get all access policies</a></li> +<li><a href="rest-api.html#_getresources">3.11.3. Get available resources</a></li> +<li><a href="rest-api.html#_getaccesspolicyforresource">3.11.4. Get access policy for resource</a></li> +<li><a href="rest-api.html#_getaccesspolicy">3.11.5. Get access policy</a></li> +<li><a href="rest-api.html#_updateaccesspolicy">3.11.6. Update access policy</a></li> +<li><a href="rest-api.html#_removeaccesspolicy">3.11.7. Delete access policy</a></li> +</ul> +</li> +<li><a href="rest-api.html#_tenants_resource">3.12. Tenants</a> +<ul class="sectlevel3"> +<li><a href="rest-api.html#_createusergroup">3.12.1. Create user group</a></li> +<li><a href="rest-api.html#_getusergroups">3.12.2. Get user groups</a></li> +<li><a href="rest-api.html#_getusergroup">3.12.3. Get user group</a></li> +<li><a href="rest-api.html#_updateusergroup">3.12.4. Update user group</a></li> +<li><a href="rest-api.html#_removeusergroup">3.12.5. Delete user group</a></li> +<li><a href="rest-api.html#_createuser">3.12.6. Create user</a></li> +<li><a href="rest-api.html#_getusers">3.12.7. Get all users</a></li> +<li><a href="rest-api.html#_getuser">3.12.8. Get user</a></li> +<li><a href="rest-api.html#_updateuser">3.12.9. Update user</a></li> +<li><a href="rest-api.html#_removeuser">3.12.10. Delete user</a></li> +</ul> +</li> +</ul> +</li> +<li><a href="rest-api.html#_definitions">4. Definitions</a> +<ul class="sectlevel2"> +<li><a href="rest-api.html#_accesspolicy">4.1. AccessPolicy</a></li> +<li><a href="rest-api.html#_accesspolicysummary">4.2. AccessPolicySummary</a></li> +<li><a href="rest-api.html#_allowablevalue">4.3. AllowableValue</a></li> +<li><a href="rest-api.html#_attribute">4.4. Attribute</a></li> +<li><a href="rest-api.html#_batchsize">4.5. BatchSize</a></li> +<li><a href="rest-api.html#_bucket">4.6. Bucket</a></li> +<li><a href="rest-api.html#_bucketitem">4.7. BucketItem</a></li> +<li><a href="rest-api.html#_buildinfo">4.8. BuildInfo</a></li> +<li><a href="rest-api.html#_bundle">4.9. Bundle</a></li> +<li><a href="rest-api.html#_bundleinfo">4.10. BundleInfo</a></li> +<li><a href="rest-api.html#_bundleversion">4.11. BundleVersion</a></li> +<li><a href="rest-api.html#_bundleversiondependency">4.12. BundleVersionDependency</a></li> +<li><a href="rest-api.html#_bundleversionmetadata">4.13. BundleVersionMetadata</a></li> +<li><a href="rest-api.html#_componentdifference">4.14. ComponentDifference</a></li> +<li><a href="rest-api.html#_componentdifferencegroup">4.15. ComponentDifferenceGroup</a></li> +<li><a href="rest-api.html#_connectablecomponent">4.16. ConnectableComponent</a></li> +<li><a href="rest-api.html#_controllerserviceapi">4.17. ControllerServiceAPI</a></li> +<li><a href="rest-api.html#_controllerservicedefinition">4.18. ControllerServiceDefinition</a></li> +<li><a href="rest-api.html#_currentuser">4.19. CurrentUser</a></li> +<li><a href="rest-api.html#_deprecationnotice">4.20. DeprecationNotice</a></li> +<li><a href="rest-api.html#_dynamicproperty">4.21. DynamicProperty</a></li> +<li><a href="rest-api.html#_dynamicrelationship">4.22. DynamicRelationship</a></li> +<li><a href="rest-api.html#_extension">4.23. Extension</a></li> +<li><a href="rest-api.html#_extensionbundle">4.24. ExtensionBundle</a></li> +<li><a href="rest-api.html#_extensionfilterparams">4.25. ExtensionFilterParams</a></li> +<li><a href="rest-api.html#_extensionmetadata">4.26. ExtensionMetadata</a></li> +<li><a href="rest-api.html#_extensionmetadatacontainer">4.27. ExtensionMetadataContainer</a></li> +<li><a href="rest-api.html#_extensionrepoartifact">4.28. ExtensionRepoArtifact</a></li> +<li><a href="rest-api.html#_extensionrepobucket">4.29. ExtensionRepoBucket</a></li> +<li><a href="rest-api.html#_extensionrepogroup">4.30. ExtensionRepoGroup</a></li> +<li><a href="rest-api.html#_extensionrepoversion">4.31. ExtensionRepoVersion</a></li> +<li><a href="rest-api.html#_extensionrepoversionsummary">4.32. ExtensionRepoVersionSummary</a></li> +<li><a href="rest-api.html#_externalcontrollerservicereference">4.33. ExternalControllerServiceReference</a></li> +<li><a href="rest-api.html#_fields">4.34. Fields</a></li> +<li><a href="rest-api.html#_jaxblink">4.35. JaxbLink</a></li> +<li><a href="rest-api.html#_permissions">4.36. Permissions</a></li> +<li><a href="rest-api.html#_position">4.37. Position</a></li> +<li><a href="rest-api.html#_property">4.38. Property</a></li> +<li><a href="rest-api.html#_providedserviceapi">4.39. ProvidedServiceAPI</a></li> +<li><a href="rest-api.html#_registryconfiguration">4.40. RegistryConfiguration</a></li> +<li><a href="rest-api.html#_relationship">4.41. Relationship</a></li> +<li><a href="rest-api.html#_resource">4.42. Resource</a></li> +<li><a href="rest-api.html#_resourcepermissions">4.43. ResourcePermissions</a></li> +<li><a href="rest-api.html#_restricted">4.44. Restricted</a></li> +<li><a href="rest-api.html#_restriction">4.45. Restriction</a></li> +<li><a href="rest-api.html#_stateful">4.46. Stateful</a></li> +<li><a href="rest-api.html#_systemresourceconsideration">4.47. SystemResourceConsideration</a></li> +<li><a href="rest-api.html#_tagcount">4.48. TagCount</a></li> +<li><a href="rest-api.html#_tenant">4.49. Tenant</a></li> +<li><a href="rest-api.html#_user">4.50. User</a></li> +<li><a href="rest-api.html#_usergroup">4.51. UserGroup</a></li> +<li><a href="rest-api.html#_versionedconnection">4.52. VersionedConnection</a></li> +<li><a href="rest-api.html#_versionedcontrollerservice">4.53. VersionedControllerService</a></li> +<li><a href="rest-api.html#_versionedflow">4.54. VersionedFlow</a></li> +<li><a href="rest-api.html#_versionedflowcoordinates">4.55. VersionedFlowCoordinates</a></li> +<li><a href="rest-api.html#_versionedflowdifference">4.56. VersionedFlowDifference</a></li> +<li><a href="rest-api.html#_versionedflowsnapshot">4.57. VersionedFlowSnapshot</a></li> +<li><a href="rest-api.html#_versionedflowsnapshotmetadata">4.58. VersionedFlowSnapshotMetadata</a></li> +<li><a href="rest-api.html#_versionedfunnel">4.59. VersionedFunnel</a></li> +<li><a href="rest-api.html#_versionedlabel">4.60. VersionedLabel</a></li> +<li><a href="rest-api.html#_versionedparameter">4.61. VersionedParameter</a></li> +<li><a href="rest-api.html#_versionedparametercontext">4.62. VersionedParameterContext</a></li> +<li><a href="rest-api.html#_versionedport">4.63. VersionedPort</a></li> +<li><a href="rest-api.html#_versionedprocessgroup">4.64. VersionedProcessGroup</a></li> +<li><a href="rest-api.html#_versionedprocessor">4.65. VersionedProcessor</a></li> +<li><a href="rest-api.html#_versionedpropertydescriptor">4.66. VersionedPropertyDescriptor</a></li> +<li><a href="rest-api.html#_versionedremotegroupport">4.67. VersionedRemoteGroupPort</a></li> +<li><a href="rest-api.html#_versionedremoteprocessgroup">4.68. VersionedRemoteProcessGroup</a></li> +</ul> +</li> +</ul> +</div> +</div> +<div id="content"> +<div class="sect1"> +<h2 id="_overview"><a class="anchor" href="rest-api.html#_overview"></a><a class="link" href="rest-api.html#_overview">1. Overview</a></h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.</p> +</div> +<div class="sect2"> +<h3 id="_version_information"><a class="anchor" href="rest-api.html#_version_information"></a><a class="link" href="rest-api.html#_version_information">1.1. Version information</a></h3> +<div class="paragraph"> +<p><em>Version</em> : 0.4.0</p> +</div> +</div> +<div class="sect2"> +<h3 id="_contact_information"><a class="anchor" href="rest-api.html#_contact_information"></a><a class="link" href="rest-api.html#_contact_information">1.2. Contact information</a></h3> +<div class="paragraph"> +<p><em>Contact</em> : Apache NiFi Registry<br> +<em>Contact Email</em> : <a href="mailto:[email protected]";>[email protected]</a></p> +</div> +</div> +<div class="sect2"> +<h3 id="_license_information"><a class="anchor" href="rest-api.html#_license_information"></a><a class="link" href="rest-api.html#_license_information">1.3. License information</a></h3> +<div class="paragraph"> +<p><em>License</em> : Apache 2.0 License<br> +<em>License URL</em> : <a href="http://www.apache.org/licenses/LICENSE-2.0.html"; class="bare">http://www.apache.org/licenses/LICENSE-2.0.html</a><br> +<em>Terms of service</em> : As described in the license</p> +</div> +</div> +<div class="sect2"> +<h3 id="_uri_scheme"><a class="anchor" href="rest-api.html#_uri_scheme"></a><a class="link" href="rest-api.html#_uri_scheme">1.4. URI scheme</a></h3> +<div class="paragraph"> +<p><em>BasePath</em> : /nifi-registry-api<br> +<em>Schemes</em> : HTTP, HTTPS</p> +</div> +</div> +<div class="sect2"> +<h3 id="_tags"><a class="anchor" href="rest-api.html#_tags"></a><a class="link" href="rest-api.html#_tags">1.5. Tags</a></h3> +<div class="ulist"> +<ul> +<li> +<p>access : Endpoints for obtaining an access token or checking access status.</p> +</li> +<li> +<p>bucket bundles : Create extension bundles scoped to an existing bucket in the registry.</p> +</li> +<li> +<p>bucket flows : Create flows scoped to an existing bucket in the registry.</p> +</li> +<li> +<p>buckets : Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets.</p> +</li> +<li> +<p>bundles : Gets metadata about extension bundles and their versions.</p> +</li> +<li> +<p>config : Retrieves the configuration for this NiFi Registry.</p> +</li> +<li> +<p>extension repository : Interact with extension bundles via the hierarchy of bucket/group/artifact/version.</p> +</li> +<li> +<p>extensions : Find and retrieve extensions.</p> +</li> +<li> +<p>flows : Gets metadata about flows.</p> +</li> +<li> +<p>items : Retrieve items across all buckets for which the user is authorized.</p> +</li> +<li> +<p>policies : Endpoint for managing access policies.</p> +</li> +<li> +<p>tenants : Endpoint for managing users and user groups.</p> +</li> +</ul> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_securityscheme"><a class="anchor" href="rest-api.html#_securityscheme"></a><a class="link" href="rest-api.html#_securityscheme">2. Security</a></h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_authorization"><a class="anchor" href="rest-api.html#_authorization"></a><a class="link" href="rest-api.html#_authorization">2.1. Authorization</a></h3> +<div class="paragraph"> +<p><em>Type</em> : apiKey<br> +<em>Name</em> : Authorization<br> +<em>In</em> : HEADER</p> +</div> +</div> +<div class="sect2"> +<h3 id="_basicauth"><a class="anchor" href="rest-api.html#_basicauth"></a><a class="link" href="rest-api.html#_basicauth">2.2. BasicAuth</a></h3> +<div class="paragraph"> +<p>HTTP Basic Auth</p> +</div> +<div class="paragraph"> +<p><em>Type</em> : basic</p> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_paths"><a class="anchor" href="rest-api.html#_paths"></a><a class="link" href="rest-api.html#_paths">3. Resources</a></h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_access_resource"><a class="anchor" href="rest-api.html#_access_resource"></a><a class="link" href="rest-api.html#_access_resource">3.1. Access</a></h3> +<div class="paragraph"> +<p>Endpoints for obtaining an access token or checking access status.</p> +</div> +<div class="sect3"> +<h4 id="_getaccessstatus"><a class="anchor" href="rest-api.html#_getaccessstatus"></a><a class="link" href="rest-api.html#_getaccessstatus">3.1.1. Get access status</a></h4> +<div class="literalblock"> +<div class="content"> +<pre>GET /access</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description"><a class="anchor" href="rest-api.html#_description"></a><a class="link" href="rest-api.html#_description">Description</a></h5> +<div class="paragraph"> +<p>Returns the current client’s authenticated identity and permissions to top-level resources</p> +</div> +</div> +<div class="sect4"> +<h5 id="_responses"><a class="anchor" href="rest-api.html#_responses"></a><a class="link" href="rest-api.html#_responses">Responses</a></h5> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 10%;"> +<col style="width: 70%;"> +<col style="width: 20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">successful operation</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="rest-api.html#_currentuser">CurrentUser</a></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>409</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect4"> +<h5 id="_consumes"><a class="anchor" href="rest-api.html#_consumes"></a><a class="link" href="rest-api.html#_consumes">Consumes</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code><strong>/</strong></code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_produces"><a class="anchor" href="rest-api.html#_produces"></a><a class="link" href="rest-api.html#_produces">Produces</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_security"><a class="anchor" href="rest-api.html#_security"></a><a class="link" href="rest-api.html#_security">Security</a></h5> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 42.8571%;"> +<col style="width: 57.1429%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>apiKey</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong><a href="rest-api.html#_authorization">Authorization</a></strong></p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect4"> +<h5 id="_example_http_request"><a class="anchor" href="rest-api.html#_example_http_request"></a><a class="link" href="rest-api.html#_example_http_request">Example HTTP request</a></h5> +<div class="sect5"> +<h6 id="_request_path"><a class="anchor" href="rest-api.html#_request_path"></a><a class="link" href="rest-api.html#_request_path">Request path</a></h6> +<div class="listingblock"> +<div class="content"> +<pre>/access</pre> +</div> +</div> +</div> +</div> +<div class="sect4"> +<h5 id="_example_http_response"><a class="anchor" href="rest-api.html#_example_http_response"></a><a class="link" href="rest-api.html#_example_http_response">Example HTTP response</a></h5> +<div class="sect5"> +<h6 id="_response_200"><a class="anchor" href="rest-api.html#_response_200"></a><a class="link" href="rest-api.html#_response_200">Response 200</a></h6> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-json" data-lang="json">{ + "identity" : "string", + "anonymous" : true, + "resourcePermissions" : { + "buckets" : { + "canRead" : true, + "canWrite" : true, + "canDelete" : true + }, + "tenants" : { + "canRead" : true, + "canWrite" : true, + "canDelete" : true + }, + "policies" : { + "canRead" : true, + "canWrite" : true, + "canDelete" : true + }, + "proxy" : { + "canRead" : true, + "canWrite" : true, + "canDelete" : true + }, + "anyTopLevelResource" : { + "canRead" : true, + "canWrite" : true, + "canDelete" : true + } + } +}</code></pre> +</div> +</div> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="_createaccesstokenbytryingallproviders"><a class="anchor" href="rest-api.html#_createaccesstokenbytryingallproviders"></a><a class="link" href="rest-api.html#_createaccesstokenbytryingallproviders">3.1.2. Create token trying all providers</a></h4> +<div class="literalblock"> +<div class="content"> +<pre>POST /access/token</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_2"><a class="anchor" href="rest-api.html#_description_2"></a><a class="link" href="rest-api.html#_description_2">Description</a></h5> +<div class="paragraph"> +<p>Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.</p> +</div> +</div> +<div class="sect4"> +<h5 id="_responses_2"><a class="anchor" href="rest-api.html#_responses_2"></a><a class="link" href="rest-api.html#_responses_2">Responses</a></h5> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 10%;"> +<col style="width: 70%;"> +<col style="width: 20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">successful operation</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Client could not be authenticated.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>409</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because an unexpected error occurred.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect4"> +<h5 id="_consumes_2"><a class="anchor" href="rest-api.html#_consumes_2"></a><a class="link" href="rest-api.html#_consumes_2">Consumes</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code><strong>/</strong></code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_produces_2"><a class="anchor" href="rest-api.html#_produces_2"></a><a class="link" href="rest-api.html#_produces_2">Produces</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code>text/plain</code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_example_http_request_2"><a class="anchor" href="rest-api.html#_example_http_request_2"></a><a class="link" href="rest-api.html#_example_http_request_2">Example HTTP request</a></h5> +<div class="sect5"> +<h6 id="_request_path_2"><a class="anchor" href="rest-api.html#_request_path_2"></a><a class="link" href="rest-api.html#_request_path_2">Request path</a></h6> +<div class="listingblock"> +<div class="content"> +<pre>/access/token</pre> +</div> +</div> +</div> +</div> +<div class="sect4"> +<h5 id="_example_http_response_2"><a class="anchor" href="rest-api.html#_example_http_response_2"></a><a class="link" href="rest-api.html#_example_http_response_2">Example HTTP response</a></h5> +<div class="sect5"> +<h6 id="_response_200_2"><a class="anchor" href="rest-api.html#_response_200_2"></a><a class="link" href="rest-api.html#_response_200_2">Response 200</a></h6> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre> +</div> +</div> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="_createaccesstokenusingidentityprovidercredentials"><a class="anchor" href="rest-api.html#_createaccesstokenusingidentityprovidercredentials"></a><a class="link" href="rest-api.html#_createaccesstokenusingidentityprovidercredentials">3.1.3. Create token using identity provider</a></h4> +<div class="literalblock"> +<div class="content"> +<pre>POST /access/token/identity-provider</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_3"><a class="anchor" href="rest-api.html#_description_3"></a><a class="link" href="rest-api.html#_description_3">Description</a></h5> +<div class="paragraph"> +<p>Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.</p> +</div> +</div> +<div class="sect4"> +<h5 id="_responses_3"><a class="anchor" href="rest-api.html#_responses_3"></a><a class="link" href="rest-api.html#_responses_3">Responses</a></h5> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 10%;"> +<col style="width: 70%;"> +<col style="width: 20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">successful operation</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Client could not be authenticated.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>409</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because an unexpected error occurred.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect4"> +<h5 id="_consumes_3"><a class="anchor" href="rest-api.html#_consumes_3"></a><a class="link" href="rest-api.html#_consumes_3">Consumes</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code><strong>/</strong></code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_produces_3"><a class="anchor" href="rest-api.html#_produces_3"></a><a class="link" href="rest-api.html#_produces_3">Produces</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code>text/plain</code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_example_http_request_3"><a class="anchor" href="rest-api.html#_example_http_request_3"></a><a class="link" href="rest-api.html#_example_http_request_3">Example HTTP request</a></h5> +<div class="sect5"> +<h6 id="_request_path_3"><a class="anchor" href="rest-api.html#_request_path_3"></a><a class="link" href="rest-api.html#_request_path_3">Request path</a></h6> +<div class="listingblock"> +<div class="content"> +<pre>/access/token/identity-provider</pre> +</div> +</div> +</div> +</div> +<div class="sect4"> +<h5 id="_example_http_response_3"><a class="anchor" href="rest-api.html#_example_http_response_3"></a><a class="link" href="rest-api.html#_example_http_response_3">Example HTTP response</a></h5> +<div class="sect5"> +<h6 id="_response_200_3"><a class="anchor" href="rest-api.html#_response_200_3"></a><a class="link" href="rest-api.html#_response_200_3">Response 200</a></h6> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre> +</div> +</div> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="_testidentityproviderrecognizescredentialsformat"><a class="anchor" href="rest-api.html#_testidentityproviderrecognizescredentialsformat"></a><a class="link" href="rest-api.html#_testidentityproviderrecognizescredentialsformat">3.1.4. Test identity provider</a></h4> +<div class="literalblock"> +<div class="content"> +<pre>POST /access/token/identity-provider/test</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_4"><a class="anchor" href="rest-api.html#_description_4"></a><a class="link" href="rest-api.html#_description_4">Description</a></h5> +<div class="paragraph"> +<p>Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.</p> +</div> +</div> +<div class="sect4"> +<h5 id="_responses_4"><a class="anchor" href="rest-api.html#_responses_4"></a><a class="link" href="rest-api.html#_responses_4">Responses</a></h5> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 10%;"> +<col style="width: 70%;"> +<col style="width: 20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">successful operation</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">The format of the credentials were not recognized by the currently configured identity provider.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>409</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because an unexpected error occurred.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect4"> +<h5 id="_consumes_4"><a class="anchor" href="rest-api.html#_consumes_4"></a><a class="link" href="rest-api.html#_consumes_4">Consumes</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code><strong>/</strong></code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_produces_4"><a class="anchor" href="rest-api.html#_produces_4"></a><a class="link" href="rest-api.html#_produces_4">Produces</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code>text/plain</code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_example_http_request_4"><a class="anchor" href="rest-api.html#_example_http_request_4"></a><a class="link" href="rest-api.html#_example_http_request_4">Example HTTP request</a></h5> +<div class="sect5"> +<h6 id="_request_path_4"><a class="anchor" href="rest-api.html#_request_path_4"></a><a class="link" href="rest-api.html#_request_path_4">Request path</a></h6> +<div class="listingblock"> +<div class="content"> +<pre>/access/token/identity-provider/test</pre> +</div> +</div> +</div> +</div> +<div class="sect4"> +<h5 id="_example_http_response_4"><a class="anchor" href="rest-api.html#_example_http_response_4"></a><a class="link" href="rest-api.html#_example_http_response_4">Example HTTP response</a></h5> +<div class="sect5"> +<h6 id="_response_200_4"><a class="anchor" href="rest-api.html#_response_200_4"></a><a class="link" href="rest-api.html#_response_200_4">Response 200</a></h6> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre> +</div> +</div> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="_getidentityproviderusageinstructions"><a class="anchor" href="rest-api.html#_getidentityproviderusageinstructions"></a><a class="link" href="rest-api.html#_getidentityproviderusageinstructions">3.1.5. Get identity provider usage</a></h4> +<div class="literalblock"> +<div class="content"> +<pre>GET /access/token/identity-provider/usage</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_5"><a class="anchor" href="rest-api.html#_description_5"></a><a class="link" href="rest-api.html#_description_5">Description</a></h5> +<div class="paragraph"> +<p>Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider</p> +</div> +</div> +<div class="sect4"> +<h5 id="_responses_5"><a class="anchor" href="rest-api.html#_responses_5"></a><a class="link" href="rest-api.html#_responses_5">Responses</a></h5> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 10%;"> +<col style="width: 70%;"> +<col style="width: 20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">successful operation</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>409</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because an unexpected error occurred.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect4"> +<h5 id="_consumes_5"><a class="anchor" href="rest-api.html#_consumes_5"></a><a class="link" href="rest-api.html#_consumes_5">Consumes</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code><strong>/</strong></code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_produces_5"><a class="anchor" href="rest-api.html#_produces_5"></a><a class="link" href="rest-api.html#_produces_5">Produces</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code>text/plain</code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_example_http_request_5"><a class="anchor" href="rest-api.html#_example_http_request_5"></a><a class="link" href="rest-api.html#_example_http_request_5">Example HTTP request</a></h5> +<div class="sect5"> +<h6 id="_request_path_5"><a class="anchor" href="rest-api.html#_request_path_5"></a><a class="link" href="rest-api.html#_request_path_5">Request path</a></h6> +<div class="listingblock"> +<div class="content"> +<pre>/access/token/identity-provider/usage</pre> +</div> +</div> +</div> +</div> +<div class="sect4"> +<h5 id="_example_http_response_5"><a class="anchor" href="rest-api.html#_example_http_response_5"></a><a class="link" href="rest-api.html#_example_http_response_5">Example HTTP response</a></h5> +<div class="sect5"> +<h6 id="_response_200_5"><a class="anchor" href="rest-api.html#_response_200_5"></a><a class="link" href="rest-api.html#_response_200_5">Response 200</a></h6> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre> +</div> +</div> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="_createaccesstokenusingkerberosticket"><a class="anchor" href="rest-api.html#_createaccesstokenusingkerberosticket"></a><a class="link" href="rest-api.html#_createaccesstokenusingkerberosticket">3.1.6. Create token using kerberos</a></h4> +<div class="literalblock"> +<div class="content"> +<pre>POST /access/token/kerberos</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_6"><a class="anchor" href="rest-api.html#_description_6"></a><a class="link" href="rest-api.html#_description_6">Description</a></h5> +<div class="paragraph"> +<p>Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.</p> +</div> +</div> +<div class="sect4"> +<h5 id="_responses_6"><a class="anchor" href="rest-api.html#_responses_6"></a><a class="link" href="rest-api.html#_responses_6">Responses</a></h5> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 10%;"> +<col style="width: 70%;"> +<col style="width: 20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">successful operation</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Client could not be authenticated.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>409</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because an unexpected error occurred.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect4"> +<h5 id="_consumes_6"><a class="anchor" href="rest-api.html#_consumes_6"></a><a class="link" href="rest-api.html#_consumes_6">Consumes</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code><strong>/</strong></code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_produces_6"><a class="anchor" href="rest-api.html#_produces_6"></a><a class="link" href="rest-api.html#_produces_6">Produces</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code>text/plain</code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_example_http_request_6"><a class="anchor" href="rest-api.html#_example_http_request_6"></a><a class="link" href="rest-api.html#_example_http_request_6">Example HTTP request</a></h5> +<div class="sect5"> +<h6 id="_request_path_6"><a class="anchor" href="rest-api.html#_request_path_6"></a><a class="link" href="rest-api.html#_request_path_6">Request path</a></h6> +<div class="listingblock"> +<div class="content"> +<pre>/access/token/kerberos</pre> +</div> +</div> +</div> +</div> +<div class="sect4"> +<h5 id="_example_http_response_6"><a class="anchor" href="rest-api.html#_example_http_response_6"></a><a class="link" href="rest-api.html#_example_http_response_6">Example HTTP response</a></h5> +<div class="sect5"> +<h6 id="_response_200_6"><a class="anchor" href="rest-api.html#_response_200_6"></a><a class="link" href="rest-api.html#_response_200_6">Response 200</a></h6> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre> +</div> +</div> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="_createaccesstokenusingbasicauthcredentials"><a class="anchor" href="rest-api.html#_createaccesstokenusingbasicauthcredentials"></a><a class="link" href="rest-api.html#_createaccesstokenusingbasicauthcredentials">3.1.7. Create token using basic auth</a></h4> +<div class="literalblock"> +<div class="content"> +<pre>POST /access/token/login</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_7"><a class="anchor" href="rest-api.html#_description_7"></a><a class="link" href="rest-api.html#_description_7">Description</a></h5> +<div class="paragraph"> +<p>Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic <credentials>', where <credentials> is the base64 encoded value of '<username>:<password>'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.</p> +</div> +</div> +<div class="sect4"> +<h5 id="_responses_7"><a class="anchor" href="rest-api.html#_responses_7"></a><a class="link" href="rest-api.html#_responses_7">Responses</a></h5> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 10%;"> +<col style="width: 70%;"> +<col style="width: 20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">successful operation</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Client could not be authenticated.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>409</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">NiFi Registry was unable to complete the request because an unexpected error occurred.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect4"> +<h5 id="_consumes_7"><a class="anchor" href="rest-api.html#_consumes_7"></a><a class="link" href="rest-api.html#_consumes_7">Consumes</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code><strong>/</strong></code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_produces_7"><a class="anchor" href="rest-api.html#_produces_7"></a><a class="link" href="rest-api.html#_produces_7">Produces</a></h5> +<div class="ulist"> +<ul> +<li> +<p><code>text/plain</code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_security_2"><a class="anchor" href="rest-api.html#_security_2"></a><a class="link" href="rest-api.html#_security_2">Security</a></h5> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 42.8571%;"> +<col style="width: 57.1429%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>basic</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong><a href="rest-api.html#_basicauth">BasicAuth</a></strong></p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect4"> +<h5 id="_example_http_request_7"><a class="anchor" href="rest-api.html#_example_http_request_7"></a><a class="link" href="rest-api.html#_example_http_request_7">Example HTTP request</a></h5> +<div class="sect5"> +<h6 id="_request_path_7"><a class="anchor" href="rest-api.html#_request_path_7"></a><a class="link" href="rest-api.html#_request_path_7">Request path</a></h6> +<div class="listingblock"> +<div class="content"> +<pre>/access/token/login</pre> +</div> +</div> +</div> +</div> +<div class="sect4"> +<h5 id="_example_http_response_7"><a class="anchor" href="rest-api.html#_example_http_response_7"></a><a class="link" href="rest-api.html#_example_http_response_7">Example HTTP response</a></h5> +<div class="sect5"> +<h6 id="_response_200_7"><a class="anchor" href="rest-api.html#_response_200_7"></a><a class="link" href="rest-api.html#_response_200_7">Response 200</a></h6> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre> +</div> +</div> +</div> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_bucket_bundles_resource"><a class="anchor" href="rest-api.html#_bucket_bundles_resource"></a><a class="link" href="rest-api.html#_bucket_bundles_resource">3.2. Bucket Bundles</a></h3> +<div class="paragraph"> +<p>Create extension bundles scoped to an existing bucket in the registry.</p> +</div> +<div class="sect3"> +<h4 id="_getextensionbundles"><a class="anchor" href="rest-api.html#_getextensionbundles"></a><a class="link" href="rest-api.html#_getextensionbundles">3.2.1. Get extension bundles by bucket</a></h4> +<div class="literalblock"> +<div class="content"> +<pre>GET /buckets/{bucketId}/bundles</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_8"><a class="anchor" href="rest-api.html#_description_8"></a><a class="link" href="rest-api.html#_description_8">Description</a></h5> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<div class="title">Note</div> +</td> +<td class="content"> +This endpoint is subject to change as NiFi Registry and its REST API evolve. +</td> +</tr> +</table> +</div> +</div> +<div class="sect4"> +<h5 id="_parameters"><a class="anchor" href="rest-api.html#_parameters"></a><a class="link" href="rest-api.html#_parameters">Parameters</a></h5> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 11.1111%;">
[... 22274 lines stripped ...]
