Bugcrowd Docs | Bugcrowd user documentation

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1">  <title>Bugcrowd Docs | Bugcrowd user documentation</title> <meta name="generator" content="Jekyll v4.3.4" /> <meta property="og:title" content="Bugcrowd Docs" /> <meta property="og:locale" content="en" /> <meta name="description" content="Bugcrowd user documentation" /> <meta property="og:description" content="Bugcrowd user documentation" /> <link rel="canonical" href="/" /> <meta property="og:url" content="/" /> <meta property="og:site_name" content="Bugcrowd Docs" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary" /> <meta property="twitter:title" content="Bugcrowd Docs" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebSite","description":"Bugcrowd user documentation","headline":"Bugcrowd Docs","name":"Bugcrowd Docs","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/bugcrowd-logo.svg"}},"url":"/"}</script>  <meta property="og:image" content="/assets/images/bugcrowd-logo.svg"/> <link rel="stylesheet" href="/assets/css/main.css"> <link rel="shortcut icon" type="image/png" href="/assets/images/favicon-96x96.png" > <link rel="alternate" type="application/rss+xml" title="Bugcrowd Docs" href="/feed.xml"> <script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha256-4+XzXVhsDmqanXGHaHvgh1gMQKX40OUvDEBTu8JcmNs=" crossorigin="anonymous"></script> <script src="/assets/js/main.js"></script> <script> function searchResults(form) { var currentItem = null; var search = document.getElementById(form); var results = document.getElementById(form + "-results"); var toggle = document.getElementById(form + "-toggle"); function removeActive() { for (i = 0; i < results.children.length; i++) { results.children[i].classList.remove("uk-background-muted"); } } // Detect all clicks on the document document.addEventListener("click", function(event) { var isClickSearch = false; var isClickResults = false; var isClickSearchToggle = false; if (search !== null) { isClickSearch = search.contains(event.target); } if (results !== null) { isClickResults = results.contains(event.target); } if (toggle !== null) { isClickSearchToggle = toggle.contains(event.target); } if (isClickSearch || isClickSearchToggle) { results.style.display = "block"; } if (!isClickResults && !isClickSearch && !isClickSearchToggle) { results.style.display = "none"; } }); results.addEventListener("mouseover", function(event) { removeActive(); event.target.parentElement.classList.add("uk-background-muted"); currentItem = null; }); results.addEventListener("mouseout", function(event) { event.target.parentElement.classList.remove("uk-background-muted"); }); search.addEventListener("keyup", function(event) { var resultItems = results.children; var resultCount = results.children.length; if (event.keyCode === 40) { if (currentItem < (resultCount - 1)) { if (currentItem === null) { currentItem = 0; } else { removeActive(); currentItem++; } removeActive(); resultItems[currentItem].classList.add("uk-background-muted"); } } else if (event.keyCode === 38) { if (currentItem > 0) { if (currentItem === null) { currentItem = 0; } else { removeActive(); currentItem--; } removeActive(); resultItems[currentItem].classList.add("uk-background-muted"); } } else if (event.keyCode === 13) { resultItems[currentItem].children[0].click(); } }); } </script> <script type="text/javascript"> var segmentKey = (window.location.hostname == 'docs.bugcrowd.com' ? 'L9nNzCkUZXHjfTwB1PFqtNtSiNbbLcnG' : 'MA6vKoD1xvGP8qyWyha2A7WjwweyFrWn'); if(segmentKey != ''){ !function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on","addSourceMiddleware","addIntegrationMiddleware","setAnonymousId","addDestinationMiddleware"];analytics.factory=function(e){return function(){var t=Array.prototype.slice.call(arguments);t.unshift(e);analytics.push(t);return analytics}};for(var e=0;e<analytics.methods.length;e++){var key=analytics.methods[e];analytics[key]=analytics.factory(key)}analytics.load=function(key,e){var t=document.createElement("script");t.type="text/javascript";t.async=!0;t.src="https://cdn.segment.com/analytics.js/v1/" + key + "/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(t,n);analytics._loadOptions=e};analytics.SNIPPET_VERSION="4.13.1"; analytics.load(segmentKey); analytics.page(); }}(); }; // ToDo: Remove when Intercom integration is removed from Segment (function hideIntercomPopup() {window.intercomSettings={...window.intercomSettings,hide_default_launcher: true}})() </script> </head> <body> <header class="uk-background-center-center uk-background-cover" style=""> <div class="uk-overlay-header" style=""> <div> <nav class="uk-navbar-container uk-navbar-container--dark"> <div class="uk-container"> <div data-uk-navbar> <div class="uk-navbar-left"> <a class="uk-navbar-item uk-logo uk-visible@m" href="/"><img src="/assets/images/bugcrowd-logo.svg" alt="Bugcrowd Docs"></a> <ul class="uk-navbar-nav uk-visible@m"> <li><a href="/customers/quick-start/customer-documentation-overview" >Customer</a> <div class="uk-navbar-dropdown"> <ul class="uk-nav uk-navbar-dropdown-nav"> <li><a href="/customers/quick-start/customer-documentation-overview">Documentation</a></li> <li><a href="/customers/changelog">Changelog</a></li> </ul> </div> </li> <li><a href="/researchers/onboarding/welcome" >Researcher</a> <div class="uk-navbar-dropdown"> <ul class="uk-nav uk-navbar-dropdown-nav"> <li><a href="/researchers/onboarding/welcome">Documentation</a></li> <li><a href="/researchers/changelog">Changelog</a></li> </ul> </div> </li> <li><a href="/api/getting-started" >API</a> <div class="uk-navbar-dropdown"> <ul class="uk-nav uk-navbar-dropdown-nav"> <li><a href="/api/getting-started">Documentation</a></li> <li><a href="/api/latest">Latest Version</a></li> <li><a href="/api/changelog">Changelog</a></li> </ul> </div> </li> </ul> </div> <div class="uk-navbar-center uk-hidden@m"> <a class="uk-navbar-item uk-logo" href="/"><img src="/assets/images/bugcrowd-logo.svg" alt="Bugcrowd Docs"></a> </div> <div class="uk-navbar-right"> <ul class="uk-navbar-nav uk-visible@m"> <li><a href="/changelog" >Changelog</a></li> <li><div class="uk-navbar-item"><a class="uk-button uk-button-primary-outline" href="https://www.bugcrowd.com" target="_blank" >Bugcrowd home</a></div></li> </ul> <a class="uk-navbar-toggle uk-hidden@m" href="#offcanvas" data-uk-toggle><span data-uk-navbar-toggle-icon></span> <span class="uk-margin-small-left">Menu</span></a> </div> </div> </div> </nav> </div> <div class="uk-section section-hero uk-position-relative" data-uk-scrollspy="cls: uk-animation-slide-bottom-medium; repeat: true"> <div class="uk-container uk-container-small"> <p class="hero-image uk-text-center"><img src="/assets/images/welcome-wire.png" alt="Hero"></p> <h1 class="uk-heading-primary uk-text-center uk-margin-remove-top">Welcome 👋</h1> <p class="uk-text-lead uk-text-center">Bugcrowd user and API documentation</p> <div class="hero-search">  <div class="uk-position-relative"> <form class="uk-search uk-search-default uk-width-1-1" name="search-hero" onsubmit="return false;"> <span class="uk-search-icon-flip" data-uk-search-icon></span> <input id="search-hero" class="uk-search-input uk-box-shadow-large" type="search" placeholder="Search documentation…" autocomplete="off"> </form> <ul id="search-hero-results" class="uk-position-absolute uk-width-1-1 uk-list"></ul> </div> <script> SimpleJekyllSearch({ searchInput: document.getElementById('search-hero'), resultsContainer: document.getElementById('search-hero-results'), noResultsText: '<li class="no-results">No results found</li>', searchResultTemplate: '<li><a href="{url}">{title}</a></li>', json: "/search.json" }); searchResults("search-hero"); </script> </div> </div> </div> </div> </header> <div class="uk-section"> <div class="uk-container"> <h2 class="uk-text-center">Get started</h2> <p class="uk-text-lead uk-text-center">Click on API, Customer, or Researcher Docs to get started</p> <div class="uk-child-width-1-3@m uk-grid-match uk-text-center uk-margin-medium-top" data-uk-grid=""> <div> <div class="uk-card uk-card-default uk-box-shadow-medium uk-card-hover uk-card-body uk-inline border-radius-large border-xlight"> <a class="uk-position-cover" href="/customers/quick-start/customer-documentation-overview"></a> <span data-uk-icon="icon: cog; ratio: 3.4" class=""></span> <h3 class="uk-card-title uk-margin">Customer Docs</h3> <p>Learn how to use our platform and get the most out of your program</p> </div> </div> <div> <div class="uk-card uk-card-default uk-box-shadow-medium uk-card-hover uk-card-body uk-inline border-radius-large border-xlight"> <a class="uk-position-cover" href="/researchers/onboarding/welcome"></a> <span data-uk-icon="icon: users; ratio: 3.4" class=""></span> <h3 class="uk-card-title uk-margin">Researcher Docs</h3> <p>Learn how you can work on Bugcrowd</p> </div> </div> <div> <div class="uk-card uk-card-default uk-box-shadow-medium uk-card-hover uk-card-body uk-inline border-radius-large border-xlight"> <a class="uk-position-cover" href="/api/getting-started"></a> <span data-uk-icon="icon: code; ratio: 3.4" class=""></span> <h3 class="uk-card-title uk-margin">API Docs</h3> <p>Integrate with the platform for automation and scale</p> </div> </div> </div> </div> </div> <div id="offcanvas" data-uk-offcanvas="flip: true; overlay: true"> <div class="uk-offcanvas-bar"> <a class="uk-logo uk-margin-small-bottom" href="/"><img src="/assets/images/bugcrowd-logo.svg" alt="Bugcrowd Docs"></a> <button class="uk-offcanvas-close" type="button" data-uk-close></button> <ul class="uk-nav uk-nav-primary uk-margin-top"> <li><a href="/customers/quick-start/customer-documentation-overview" >Customer docs</a></li> <li><a href="/researchers/onboarding/welcome" >Researcher docs</a></li> <li><a href="/api/getting-started" >API docs</a></li> <li><a href="/changelog" >Changelog</a></li> <li><a href="https://www.bugcrowd.com" target="_blank" >Bugcrowd home</a></li> </ul> <div class="uk-margin-top uk-text-center"> <div data-uk-grid class="uk-child-width-auto uk-grid-small uk-flex-center uk-grid"> <div> <a href="https://www.bugcrowd.com" class="uk-link-muted" target="_blank">Visit bugcrowd.com</a> </div> </div> </div> </div> </div> <footer class="bc-footer uk-section uk-text-center uk-text-muted"> <div class="uk-container uk-container-small"> <div> <ul class="uk-subnav uk-flex-center"> </ul> </div> <div class="uk-margin-medium"> <div data-uk-grid class="uk-child-width-auto uk-grid-small uk-flex-center uk-grid"> <div> <a href='#usabilla' id='usbl-integrated-button' class="uk-link-muted">Give feedback</a> </div> <div> <a href="https://www.bugcrowd.com" class="uk-link-muted" target="_blank">Visit bugcrowd.com</a> </div> </div> </div> <div class="uk-margin-small uk-text-small copyright link-secondary">Copyright © 2022 Bugcrowd</div> </div> </footer> <script src="/assets/js/redoc.standalone.js"> </script> <script type="text/javascript"> /*{literal}<![CDATA[*/window.lightningjs||function(c){function g(b,d){d&&(d+=(/\?/.test(d)?"&":"?")+"lv=1");c[b]||function(){var i=window,h=document,j=b,g=h.location.protocol,l="load",k=0;(function(){function b(){a.P(l);a.w=1;c[j]("_load")}c[j]=function(){function m(){m.id=e;return c[j].apply(m,arguments)}var b,e=++k;b=this&&this!=i?this.id||0:0;(a.s=a.s||[]).push([e,b,arguments]);m.then=function(b,c,h){var d=a.fh[e]=a.fh[e]||[],j=a.eh[e]=a.eh[e]||[],f=a.ph[e]=a.ph[e]||[];b&&d.push(b);c&&j.push(c);h&&f.push(h);return m};return m};var a=c[j]._={};a.fh={};a.eh={};a.ph={};a.l=d?d.replace(/^\/\//,(g=="https:"?g:"http:")+"//"):d;a.p={0:+new Date};a.P=function(b){a.p[b]=new Date-a.p[0]};a.w&&b();i.addEventListener?i.addEventListener(l,b,!1):i.attachEvent("on"+l,b);var q=function(){function b(){return["<head></head><",c,' onload="var d=',n,";d.getElementsByTagName('head')[0].",d,"(d.",g,"('script')).",i,"='",a.l,"'\"></",c,">"].join("")}var c="body",e=h[c];if(!e)return setTimeout(q,100);a.P(1);var d="appendChild",g="createElement",i="src",k=h[g]("div"),l=k[d](h[g]("div")),f=h[g]("iframe"),n="document",p;k.style.display="none";e.insertBefore(k,e.firstChild).id=o+"-"+j;f.frameBorder="0";f.id=o+"-frame-"+j;/MSIE[ ]+6/.test(navigator.userAgent)&&(f[i]="javascript:false");f.allowTransparency="true";l[d](f);try{f.contentWindow[n].open()}catch(s){a.domain=h.domain,p="javascript:var d="+n+".open();d.domain='"+h.domain+"';",f[i]=p+"void(0);"}try{var r=f.contentWindow[n];r.write(b());r.close()}catch(t){f[i]=p+'d.write("'+b().replace(/"/g,String.fromCharCode(92)+'"')+'");d.close();'}a.P(2)};a.l&&setTimeout(q,0)})()}();c[b].lv="1";return c[b]}var o="lightningjs",k=window[o]=g(o);k.require=g;k.modules=c}({}); window.usabilla_live = lightningjs.require("usabilla_live", "//w.usabilla.com/af9014ad9637.js");/*]]>{/literal}*/ //Hide Usabilla Default button window.usabilla_live('hide'); //Find a Link and open the Usabilla Feedback form when the user clicks on the link document.getElementById("usbl-integrated-button").addEventListener("click",function(){ window.usabilla_live("click"); }); </script> </body> </html>

CINXE.COM

Bugcrowd Docs | Bugcrowd user documentation