{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"PlanetScale","description":"PlanetScale is a relational database platform for Vitess, Neki, and Postgres that gives you scale, performance, and reliability without sacrificing developer experience.","colors":{"primary":"#0e73cc","light":"#47b7f8","dark":"#f15817"},"logo":{"light":"https://mintcdn.com/planetscale-2/xUilVHToUFALai8a/logo/light.png?fit=max\u0026auto=format\u0026n=xUilVHToUFALai8a\u0026q=85\u0026s=cccd3c9fc813c01b899ab7af15a115b1","dark":"https://mintcdn.com/planetscale-2/xUilVHToUFALai8a/logo/dark.png?fit=max\u0026auto=format\u0026n=xUilVHToUFALai8a\u0026q=85\u0026s=4153888dc0ef54ddc3464738a2d7ee6e","href":"https://planetscale.com"},"favicon":"https://mintcdn.com/planetscale-2/DJh9Bv1aUZHTVDnK/favicon.svg?fit=max\u0026auto=format\u0026n=DJh9Bv1aUZHTVDnK\u0026q=85\u0026s=cc6ec9d8d0deb3450719bb4b5b6df73a","background":{"color":{"light":"#fafafa","dark":"#111111"}},"navbar":{"links":[{"href":"https://auth.planetscale.com/sign-in","label":"Log in"},{"href":"https://auth.planetscale.com/sign-up","label":"Get started"}],"primary":{"type":"button","label":"Get in touch","href":"https://planetscale.com/contact"}},"footer":{"socials":{"x":"https://twitter.com/planetscale","github":"https://github.com/planetscale","linkedin":"https://www.linkedin.com/company/planetscale","youtube":"https://www.youtube.com/c/PlanetScale","discord":"https://pscale.link/community","facebook":"https://www.facebook.com/planetscaledata"}},"seo":{"metatags":{"canonical":"https://planetscale.com/docs"}},"fonts":{"heading":{"family":"Inter"},"body":{"family":"Inter"}},"integrations":{"segment":{"key":"9Ujczlrndco2w8fcFAakL0FT4bsJCCh3"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://planetscale.com/blog"},{"anchor":"Contact Us","icon":"headset","href":"https://planetscale.com/contact"},{"anchor":"Status","icon":"signal","href":"https://www.planetscalestatus.com/"},{"anchor":"Benchmarks","icon":"chart-line","href":"https://planetscale.com/benchmarks"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"planetscale-2","hasAudioNarration":false,"actualSubdomain":"planetscale-2","customDomains":["planetscale.com"],"gitSource":{"type":"github","owner":"planetscale","repo":"www","deployBranch":"main","contentDirectory":"content/mintlify/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae505c7cb870de49023cbd6","collectionId":"75c09c64-fefe-4ba5-8569-25281688c6cb","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae505c7cb870de49023cbd6"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae50e31004f8cf1ce957135","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Platform","count":289},{"language":"default","tag":"API Reference","count":268},{"language":"default","tag":"Vitess","count":184},{"language":"default","tag":"Postgres","count":109},{"language":"default","tag":"General API endpoints","count":97},{"language":"default","tag":"Neki","count":58},{"language":"default","tag":"Guides","count":58},{"language":"default","tag":"Vitess API endpoints","count":56},{"language":"default","tag":"Postgres API endpoints","count":51},{"language":"default","tag":"Neki API endpoints","count":50}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"type":"link","url":"https://planetscale.com/contact?initial=support"}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#content-container{column-gap:2rem}.nav-tabs{column-gap:.5em}.nav-tabs-item{padding:0 8px}.eyebrow,.light #navigation-items .text-gray-700,.nav-tabs a{color:#616161}#navigation-items .text-primary,#topbar-cta-button .text-white,#topbar-cta-button svg,.nav-tabs a.text-primary{color:#1a1a1a}.nav-tabs a.text-primary .bg-primary{background-color:#1a1a1a;left:0}.dark .nav-tabs a[href='/docs/vitess'i].text-primary,.nav-tabs a[href='/docs/vitess'i].text-primary{color:#f15817}.dark .nav-tabs a[href='/docs/vitess'i].text-primary .bg-primary,.nav-tabs a[href='/docs/vitess'i].text-primary .bg-primary{background-color:#f15817}.nav-tabs a[href='/docs/postgres'i].text-primary{color:#0e73cc}.nav-tabs a[href='/docs/postgres'i].text-primary .bg-primary{background-color:#0e73cc}.nav-tabs a[href='/docs/neki'i].text-primary{color:#8f7200}.nav-tabs a[href='/docs/neki'i].text-primary .bg-primary{background-color:#8f7200}.dark .nav-tabs a{color:#a1a1a1}.dark #navigation-items .text-primary,.dark .nav-tabs a.text-primary{color:#fafafa}.dark .nav-tabs a.text-primary .bg-primary{background-color:#fafafa}.dark .nav-tabs a[href='/docs/postgres'i].text-primary{color:#47b7f8}.dark .nav-tabs a[href='/docs/postgres'i].text-primary .bg-primary{background-color:#47b7f8}.dark .nav-tabs a[href='/docs/neki'i].text-primary{color:#fbca00}.dark .nav-tabs a[href='/docs/neki'i].text-primary .bg-primary{background-color:#fbca00}.prose:is(.dark *){color:#c1c1c1}.prose :where(a):not(:where([class~='not-prose'], [class~='not-prose'] *)){color:#0e73cc;font-weight:500}.dark .prose :where(a):not(:where(.not-prose, .not-prose *)){color:#47b7f8}.dark .eyebrow{color:#a1a1a1}@media (min-width:1024px){#content-container{padding-top:2rem;padding-right:2rem;padding-left:2.5rem}}#topbar-cta-button a>span{background-color:#fbca00}.group:hover span{opacity:1!important}.bg-primary\\/10{background-color:rgba(129,129,129,.1)}.dark .bg-primary\\/10{background-color:rgba(255,255,255,.1)}body[data-current-path^='/vitess'] svg.bg-primary{background-color:#f15817}body[data-current-path^='/vitess'] .border-primary{border-color:#f15817}body[data-current-path^='/vitess'] #table-of-contents-content .text-primary,body[data-current-path^='/vitess'] .eyebrow{color:#f15817}body[data-current-path^='/vitess'] .card-group a:hover{border-color:#f15817!important}body[data-current-path^='/postgres'] .eyebrow{color:#0e73cc}.dark body[data-current-path^='/postgres'] .eyebrow{color:#47b7f8}body[data-current-path^='/neki'] svg.bg-primary{background-color:#8f7200}body[data-current-path^='/neki'] [data-component-part=card-icon]{background-color:#fbca00}body[data-current-path^='/neki'] [data-component-part=card-icon] svg.bg-primary{background-color:#1a1a1a;transform:scale(.7);transform-origin:center}body[data-current-path^='/neki'] .border-primary{border-color:#8f7200}body[data-current-path^='/neki'] #table-of-contents-content .text-primary{color:#1a1a1a;background-color:transparent;border-color:#fbca00}body[data-current-path^='/neki'] .eyebrow{display:inline-flex;align-items:center;width:fit-content;height:auto;min-height:1.25rem;padding:0 .375rem;color:#1a1a1a;background-color:#fbca00}body[data-current-path^='/neki'] .eyebrow:empty,body[data-current-path^='/neki'] .eyebrow[data-empty]{display:none}.dark body[data-current-path^='/neki'] .card-group .card:hover,body[data-current-path^='/neki'] .card-group .card:hover{--primary:251 202 0;--primary-light:251 202 0;border-color:#fbca00!important}.dark body[data-current-path^='/neki'] [data-component-part=card-icon],.dark body[data-current-path^='/neki'] svg.bg-primary{background-color:#fbca00}.dark body[data-current-path^='/neki'] [data-component-part=card-icon] svg.bg-primary{background-color:#1a1a1a}.dark body[data-current-path^='/neki'] .border-primary{border-color:#fbca00}.dark body[data-current-path^='/neki'] #table-of-contents-content .text-primary{color:#fafafa;background-color:transparent;border-color:#fbca00}.dark body[data-current-path^='/neki'] .eyebrow{color:#1a1a1a;background-color:#fbca00}footer div:last-child{display:none}#header,#pagination a,[data-component-part=card-content-container],[data-component-part=frame-caption]{text-wrap:balance}.step:last-of-type [data-component-part=step-line]{opacity:0}"}],"page":{"pagePath":"api/reference/create_bouncer","slug":"/api/reference/create_bouncer","pageMetadata":{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/bouncers","og:image":"images/og/api/reference/create_bouncer.png","title":"Create a bouncer","description":"\n### Authorization\nA service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:\n\n**Service Token Accesses**\n `write_database`\n\n**OAuth Scopes**\n\n | Resource | Scopes |\n| :------- | :---------- |\n| Organization | `write_databases` |\n| Database | `write_database` |","href":"/api/reference/create_bouncer"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h3: \"h3\",\n p: \"p\",\n strong: \"strong\",\n table: \"table\",\n tbody: \"tbody\",\n td: \"td\",\n th: \"th\",\n thead: \"thead\",\n tr: \"tr\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.h3, {\n children: \"Authorization\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Service Token Accesses\"\n }), \"\\n\", _jsx(_components.code, {\n children: \"write_database\"\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"OAuth Scopes\"\n })\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n style: {\n textAlign: \"left\"\n },\n children: \"Resource\"\n }), _jsx(_components.th, {\n style: {\n textAlign: \"left\"\n },\n children: \"Scopes\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n style: {\n textAlign: \"left\"\n },\n children: \"Organization\"\n }), _jsx(_components.td, {\n style: {\n textAlign: \"left\"\n },\n children: _jsx(_components.code, {\n children: \"write_databases\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n style: {\n textAlign: \"left\"\n },\n children: \"Database\"\n }), _jsx(_components.td, {\n style: {\n textAlign: \"left\"\n },\n children: _jsx(_components.code, {\n children: \"write_database\"\n })\n })]\n })]\n })]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const __snippet_platformLabels_3vlljw={vitess:`Vitess`,postgres:`Postgres`,neki:`Neki`};const __snippet_combinedPlatformLabels_3vlljw={both:`Vitess and Postgres`,all:`Vitess, Neki, and Postgres`,\"postgres-neki\":`Postgres and Neki`};const __snippet_platformBadgeClassName_3vlljw=`inline-flex items-center gap-1.5 whitespace-nowrap rounded-full border px-2.5 py-1 text-[13px] font-semibold leading-tight no-underline data-[engine=vitess]:data-[state=current]:border-[#ffc59b] data-[engine=vitess]:data-[state=current]:bg-[#ffe8d8] data-[engine=vitess]:data-[state=current]:text-[#672002] dark:data-[engine=vitess]:data-[state=current]:border-[#962d00] dark:data-[engine=vitess]:data-[state=current]:bg-[#3c1403] dark:data-[engine=vitess]:data-[state=current]:text-[#ffe8d8] data-[engine=vitess]:data-[state=link]:border-[#ffc59b] data-[engine=vitess]:data-[state=link]:bg-transparent data-[engine=vitess]:data-[state=link]:text-[#b83a05] dark:data-[engine=vitess]:data-[state=link]:border-[#962d00] dark:data-[engine=vitess]:data-[state=link]:bg-transparent dark:data-[engine=vitess]:data-[state=link]:text-[#ffc59b] data-[engine=postgres]:data-[state=current]:border-[#a9dffe] data-[engine=postgres]:data-[state=current]:bg-[#ddf2ff] data-[engine=postgres]:data-[state=current]:text-[#0e3682] dark:data-[engine=postgres]:data-[state=current]:border-[#144eb6] dark:data-[engine=postgres]:data-[state=current]:bg-[#08204e] dark:data-[engine=postgres]:data-[state=current]:text-[#ddf2ff] data-[engine=postgres]:data-[state=link]:border-[#a9dffe] data-[engine=postgres]:data-[state=link]:bg-transparent data-[engine=postgres]:data-[state=link]:text-[#0b6ec5] dark:data-[engine=postgres]:data-[state=link]:border-[#144eb6] dark:data-[engine=postgres]:data-[state=link]:bg-transparent dark:data-[engine=postgres]:data-[state=link]:text-[#73c7f9] data-[engine=neki]:data-[state=current]:border-[#fbca00] data-[engine=neki]:data-[state=current]:bg-[#fbca00] data-[engine=neki]:data-[state=current]:text-[#1a1a1a] dark:data-[engine=neki]:data-[state=current]:border-[#fbca00] dark:data-[engine=neki]:data-[state=current]:bg-[#fbca00] dark:data-[engine=neki]:data-[state=current]:text-[#1a1a1a] data-[engine=neki]:data-[state=link]:border-[#fbca00] data-[engine=neki]:data-[state=link]:bg-transparent data-[engine=neki]:data-[state=link]:text-[#8f7200] dark:data-[engine=neki]:data-[state=link]:border-[#fbca00] dark:data-[engine=neki]:data-[state=link]:bg-transparent dark:data-[engine=neki]:data-[state=link]:text-[#fbca00] data-[engine=both]:data-[state=current]:border-[#d4d4d4] data-[engine=both]:data-[state=current]:bg-[#f0f0f0] data-[engine=both]:data-[state=current]:text-[#3d3d3d] dark:data-[engine=both]:data-[state=current]:border-[#525252] dark:data-[engine=both]:data-[state=current]:bg-[#2a2a2a] dark:data-[engine=both]:data-[state=current]:text-[#e5e5e5]`;const __snippet_docsHref_3vlljw=path=>path.startsWith(`/`)?path:`/${path}`;const __snippet_PlatformAvailabilityBadges_3vlljw=({current,vitess,postgres,neki})=>{const _components={a:`a`,..._provideComponents()};if(__snippet_combinedPlatformLabels_3vlljw[current]){return _jsx(`div`,{className:`not-prose mint-mb-5 mint-flex mint-flex-wrap mint-items-center mint-gap-2`,role:`group`,\"aria-label\":`Platform availability`,children:_jsx(`span`,{\"data-engine\":`both`,\"data-state\":`current`,\"aria-current\":`true`,className:`mint-inline-flex mint-items-center mint-gap-1.5 mint-whitespace-nowrap mint-rounded-full mint-border mint-px-2.5 mint-py-1 mint-text-[13px] mint-font-semibold mint-leading-tight mint-no-underline data-[engine=vitess]:data-[state=current]:mint-border-[#ffc59b] data-[engine=vitess]:data-[state=current]:mint-bg-[#ffe8d8] data-[engine=vitess]:data-[state=current]:mint-text-[#672002] dark:data-[engine=vitess]:data-[state=current]:mint-border-[#962d00] dark:data-[engine=vitess]:data-[state=current]:mint-bg-[#3c1403] dark:data-[engine=vitess]:data-[state=current]:mint-text-[#ffe8d8] data-[engine=vitess]:data-[state=link]:mint-border-[#ffc59b] data-[engine=vitess]:data-[state=link]:mint-bg-transparent data-[engine=vitess]:data-[state=link]:mint-text-[#b83a05] dark:data-[engine=vitess]:data-[state=link]:mint-border-[#962d00] dark:data-[engine=vitess]:data-[state=link]:mint-bg-transparent dark:data-[engine=vitess]:data-[state=link]:mint-text-[#ffc59b] data-[engine=postgres]:data-[state=current]:mint-border-[#a9dffe] data-[engine=postgres]:data-[state=current]:mint-bg-[#ddf2ff] data-[engine=postgres]:data-[state=current]:mint-text-[#0e3682] dark:data-[engine=postgres]:data-[state=current]:mint-border-[#144eb6] dark:data-[engine=postgres]:data-[state=current]:mint-bg-[#08204e] dark:data-[engine=postgres]:data-[state=current]:mint-text-[#ddf2ff] data-[engine=postgres]:data-[state=link]:mint-border-[#a9dffe] data-[engine=postgres]:data-[state=link]:mint-bg-transparent data-[engine=postgres]:data-[state=link]:mint-text-[#0b6ec5] dark:data-[engine=postgres]:data-[state=link]:mint-border-[#144eb6] dark:data-[engine=postgres]:data-[state=link]:mint-bg-transparent dark:data-[engine=postgres]:data-[state=link]:mint-text-[#73c7f9] data-[engine=neki]:data-[state=current]:mint-border-[#fbca00] data-[engine=neki]:data-[state=current]:mint-bg-[#fbca00] data-[engine=neki]:data-[state=current]:mint-text-[#1a1a1a] dark:data-[engine=neki]:data-[state=current]:mint-border-[#fbca00] dark:data-[engine=neki]:data-[state=current]:mint-bg-[#fbca00] dark:data-[engine=neki]:data-[state=current]:mint-text-[#1a1a1a] data-[engine=neki]:data-[state=link]:mint-border-[#fbca00] data-[engine=neki]:data-[state=link]:mint-bg-transparent data-[engine=neki]:data-[state=link]:mint-text-[#8f7200] dark:data-[engine=neki]:data-[state=link]:mint-border-[#fbca00] dark:data-[engine=neki]:data-[state=link]:mint-bg-transparent dark:data-[engine=neki]:data-[state=link]:mint-text-[#fbca00] data-[engine=both]:data-[state=current]:mint-border-[#d4d4d4] data-[engine=both]:data-[state=current]:mint-bg-[#f0f0f0] data-[engine=both]:data-[state=current]:mint-text-[#3d3d3d] dark:data-[engine=both]:data-[state=current]:mint-border-[#525252] dark:data-[engine=both]:data-[state=current]:mint-bg-[#2a2a2a] dark:data-[engine=both]:data-[state=current]:mint-text-[#e5e5e5]`,children:__snippet_combinedPlatformLabels_3vlljw[current]})})}const paths={vitess,postgres,neki};const others=[`vitess`,`neki`,`postgres`].filter(engine=>engine!==current\u0026\u0026paths[engine]);const engines=__snippet_platformLabels_3vlljw[current]?[current,...others]:others;const only=engines.length===1;return _jsx(`div`,{className:`not-prose mint-mb-5 mint-flex mint-flex-wrap mint-items-center mint-gap-2`,role:`group`,\"aria-label\":`Platform availability`,children:engines.map(engine=>{const label=only?`${__snippet_platformLabels_3vlljw[engine]} only`:__snippet_platformLabels_3vlljw[engine];if(engine===current){return _jsx(`span`,{\"data-engine\":engine,\"data-state\":`current`,\"aria-current\":`true`,className:`mint-inline-flex mint-items-center mint-gap-1.5 mint-whitespace-nowrap mint-rounded-full mint-border mint-px-2.5 mint-py-1 mint-text-[13px] mint-font-semibold mint-leading-tight mint-no-underline data-[engine=vitess]:data-[state=current]:mint-border-[#ffc59b] data-[engine=vitess]:data-[state=current]:mint-bg-[#ffe8d8] data-[engine=vitess]:data-[state=current]:mint-text-[#672002] dark:data-[engine=vitess]:data-[state=current]:mint-border-[#962d00] dark:data-[engine=vitess]:data-[state=current]:mint-bg-[#3c1403] dark:data-[engine=vitess]:data-[state=current]:mint-text-[#ffe8d8] data-[engine=vitess]:data-[state=link]:mint-border-[#ffc59b] data-[engine=vitess]:data-[state=link]:mint-bg-transparent data-[engine=vitess]:data-[state=link]:mint-text-[#b83a05] dark:data-[engine=vitess]:data-[state=link]:mint-border-[#962d00] dark:data-[engine=vitess]:data-[state=link]:mint-bg-transparent dark:data-[engine=vitess]:data-[state=link]:mint-text-[#ffc59b] data-[engine=postgres]:data-[state=current]:mint-border-[#a9dffe] data-[engine=postgres]:data-[state=current]:mint-bg-[#ddf2ff] data-[engine=postgres]:data-[state=current]:mint-text-[#0e3682] dark:data-[engine=postgres]:data-[state=current]:mint-border-[#144eb6] dark:data-[engine=postgres]:data-[state=current]:mint-bg-[#08204e] dark:data-[engine=postgres]:data-[state=current]:mint-text-[#ddf2ff] data-[engine=postgres]:data-[state=link]:mint-border-[#a9dffe] data-[engine=postgres]:data-[state=link]:mint-bg-transparent data-[engine=postgres]:data-[state=link]:mint-text-[#0b6ec5] dark:data-[engine=postgres]:data-[state=link]:mint-border-[#144eb6] dark:data-[engine=postgres]:data-[state=link]:mint-bg-transparent dark:data-[engine=postgres]:data-[state=link]:mint-text-[#73c7f9] data-[engine=neki]:data-[state=current]:mint-border-[#fbca00] data-[engine=neki]:data-[state=current]:mint-bg-[#fbca00] data-[engine=neki]:data-[state=current]:mint-text-[#1a1a1a] dark:data-[engine=neki]:data-[state=current]:mint-border-[#fbca00] dark:data-[engine=neki]:data-[state=current]:mint-bg-[#fbca00] dark:data-[engine=neki]:data-[state=current]:mint-text-[#1a1a1a] data-[engine=neki]:data-[state=link]:mint-border-[#fbca00] data-[engine=neki]:data-[state=link]:mint-bg-transparent data-[engine=neki]:data-[state=link]:mint-text-[#8f7200] dark:data-[engine=neki]:data-[state=link]:mint-border-[#fbca00] dark:data-[engine=neki]:data-[state=link]:mint-bg-transparent dark:data-[engine=neki]:data-[state=link]:mint-text-[#fbca00] data-[engine=both]:data-[state=current]:mint-border-[#d4d4d4] data-[engine=both]:data-[state=current]:mint-bg-[#f0f0f0] data-[engine=both]:data-[state=current]:mint-text-[#3d3d3d] dark:data-[engine=both]:data-[state=current]:mint-border-[#525252] dark:data-[engine=both]:data-[state=current]:mint-bg-[#2a2a2a] dark:data-[engine=both]:data-[state=current]:mint-text-[#e5e5e5]`,children:label},engine)}return _jsxs(_components.a,{href:__snippet_docsHref_3vlljw(paths[engine]),\"data-engine\":engine,\"data-state\":`link`,title:`View ${__snippet_platformLabels_3vlljw[engine]} documentation`,className:`mint-inline-flex mint-items-center mint-gap-1.5 mint-whitespace-nowrap mint-rounded-full mint-border mint-px-2.5 mint-py-1 mint-text-[13px] mint-font-semibold mint-leading-tight mint-no-underline data-[engine=vitess]:data-[state=current]:mint-border-[#ffc59b] data-[engine=vitess]:data-[state=current]:mint-bg-[#ffe8d8] data-[engine=vitess]:data-[state=current]:mint-text-[#672002] dark:data-[engine=vitess]:data-[state=current]:mint-border-[#962d00] dark:data-[engine=vitess]:data-[state=current]:mint-bg-[#3c1403] dark:data-[engine=vitess]:data-[state=current]:mint-text-[#ffe8d8] data-[engine=vitess]:data-[state=link]:mint-border-[#ffc59b] data-[engine=vitess]:data-[state=link]:mint-bg-transparent data-[engine=vitess]:data-[state=link]:mint-text-[#b83a05] dark:data-[engine=vitess]:data-[state=link]:mint-border-[#962d00] dark:data-[engine=vitess]:data-[state=link]:mint-bg-transparent dark:data-[engine=vitess]:data-[state=link]:mint-text-[#ffc59b] data-[engine=postgres]:data-[state=current]:mint-border-[#a9dffe] data-[engine=postgres]:data-[state=current]:mint-bg-[#ddf2ff] data-[engine=postgres]:data-[state=current]:mint-text-[#0e3682] dark:data-[engine=postgres]:data-[state=current]:mint-border-[#144eb6] dark:data-[engine=postgres]:data-[state=current]:mint-bg-[#08204e] dark:data-[engine=postgres]:data-[state=current]:mint-text-[#ddf2ff] data-[engine=postgres]:data-[state=link]:mint-border-[#a9dffe] data-[engine=postgres]:data-[state=link]:mint-bg-transparent data-[engine=postgres]:data-[state=link]:mint-text-[#0b6ec5] dark:data-[engine=postgres]:data-[state=link]:mint-border-[#144eb6] dark:data-[engine=postgres]:data-[state=link]:mint-bg-transparent dark:data-[engine=postgres]:data-[state=link]:mint-text-[#73c7f9] data-[engine=neki]:data-[state=current]:mint-border-[#fbca00] data-[engine=neki]:data-[state=current]:mint-bg-[#fbca00] data-[engine=neki]:data-[state=current]:mint-text-[#1a1a1a] dark:data-[engine=neki]:data-[state=current]:mint-border-[#fbca00] dark:data-[engine=neki]:data-[state=current]:mint-bg-[#fbca00] dark:data-[engine=neki]:data-[state=current]:mint-text-[#1a1a1a] data-[engine=neki]:data-[state=link]:mint-border-[#fbca00] data-[engine=neki]:data-[state=link]:mint-bg-transparent data-[engine=neki]:data-[state=link]:mint-text-[#8f7200] dark:data-[engine=neki]:data-[state=link]:mint-border-[#fbca00] dark:data-[engine=neki]:data-[state=link]:mint-bg-transparent dark:data-[engine=neki]:data-[state=link]:mint-text-[#fbca00] data-[engine=both]:data-[state=current]:mint-border-[#d4d4d4] data-[engine=both]:data-[state=current]:mint-bg-[#f0f0f0] data-[engine=both]:data-[state=current]:mint-text-[#3d3d3d] dark:data-[engine=both]:data-[state=current]:mint-border-[#525252] dark:data-[engine=both]:data-[state=current]:mint-bg-[#2a2a2a] dark:data-[engine=both]:data-[state=current]:mint-text-[#e5e5e5]`,children:[label,_jsx(`svg`,{\"aria-hidden\":`true`,width:`12`,height:`12`,viewBox:`0 0 12 12`,fill:`none`,className:`mint-shrink-0`,children:_jsx(`path`,{d:`M2.5 6h7M6.5 3l3 3-3 3`,stroke:`currentColor`,strokeWidth:`1.5`,strokeLinecap:`round`,strokeLinejoin:`round`})})]},engine)})})};const __snippet_PlatformAvailabilityText_3vlljw=({current,vitess,postgres,neki})=>{const _components={a:`a`,..._provideComponents()};return __snippet_combinedPlatformLabels_3vlljw[current]?_jsxs(`p`,{children:[`Available for `,__snippet_combinedPlatformLabels_3vlljw[current],`.`]}):_jsxs(_Fragment,{children:[_jsxs(`p`,{children:[`This page covers `,__snippet_platformLabels_3vlljw[current],`.`]}),vitess\u0026\u0026current!==`vitess`?_jsxs(`p`,{children:[`Vitess version: `,_jsx(_components.a,{href:vitess.startsWith(`/`)?vitess:`/`+vitess,children:__snippet_platformLabels_3vlljw.vitess})]}):null,postgres\u0026\u0026current!==`postgres`?_jsxs(`p`,{children:[`Postgres version: `,_jsx(_components.a,{href:postgres.startsWith(`/`)?postgres:`/`+postgres,children:__snippet_platformLabels_3vlljw.postgres})]}):null,neki\u0026\u0026current!==`neki`?_jsxs(`p`,{children:[`Neki version: `,_jsx(_components.a,{href:neki.startsWith(`/`)?neki:`/`+neki,children:__snippet_platformLabels_3vlljw.neki})]}):null]})};const PlatformAvailability=props=>{const{Visibility}=_provideComponents()||{};if(!Visibility)_missingMdxReference(`Visibility`,true);return _jsxs(_Fragment,{children:[_jsx(Visibility,{for:`humans`,children:_jsx(__snippet_PlatformAvailabilityBadges_3vlljw,{...props})}),_jsx(Visibility,{for:`agents`,children:_jsx(__snippet_PlatformAvailabilityText_3vlljw,{...props})})]})};function _createMdxContent(props){const{_MdxComponentBoundary}={..._provideComponents(),...props.components};if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsx(_MdxComponentBoundary,{name:`PlatformAvailability`,children:_jsx(PlatformAvailability,{current:`postgres`})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{__snippet_platformLabels_3vlljw,__snippet_combinedPlatformLabels_3vlljw,__snippet_platformBadgeClassName_3vlljw,__snippet_docsHref_3vlljw,__snippet_PlatformAvailabilityBadges_3vlljw,__snippet_PlatformAvailabilityText_3vlljw,PlatformAvailability,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/bouncers","og:image":"images/og/api/reference/create_bouncer.png","title":"Create a bouncer","description":"\n### Authorization\nA service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:\n\n**Service Token Accesses**\n `write_database`\n\n**OAuth Scopes**\n\n | Resource | Scopes |\n| :------- | :---------- |\n| Organization | `write_databases` |\n| Database | `write_database` |","href":"/api/reference/create_bouncer"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[19,69,"jsx:_jsx}=arguments["],[166,14628,"undefined;const __snippet_combinedPlatformLabels_3vlljw=undefined;const __snippet_platformBadgeClassName_3vlljw=undefined;const __snippet_docsHref_3vlljw=()=>null;const __snippet_PlatformAvailabilityBadges_3vlljw=()=>null;const __snippet_PlatformAvailabilityText_3vlljw=()=>null;const PlatformAvailability=()=>null;funct"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/planetscale-2/b155242ec3c4945e/custom.js"],"dynamicCss":".mint-mb-5 {\n margin-bottom: 1.25rem\n}\n.mint-flex {\n display: flex\n}\n.mint-inline-flex {\n display: inline-flex\n}\n.mint-shrink-0 {\n flex-shrink: 0\n}\n.mint-flex-wrap {\n flex-wrap: wrap\n}\n.mint-items-center {\n align-items: center\n}\n.mint-gap-1\\.5 {\n gap: 0.375rem\n}\n.mint-gap-2 {\n gap: 0.5rem\n}\n.mint-whitespace-nowrap {\n white-space: nowrap\n}\n.mint-rounded-full {\n border-radius: 9999px\n}\n.mint-border {\n border-width: 1px\n}\n.mint-px-2\\.5 {\n padding-left: 0.625rem;\n padding-right: 0.625rem\n}\n.mint-py-1 {\n padding-top: 0.25rem;\n padding-bottom: 0.25rem\n}\n.mint-text-\\[13px\\] {\n font-size: 13px\n}\n.mint-font-semibold {\n font-weight: 600\n}\n.mint-leading-tight {\n line-height: 1.25\n}\n.mint-no-underline {\n text-decoration-line: none\n}\n.data-\\[engine\\=both\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#d4d4d4\\][data-state=\"current\"][data-engine=\"both\"] {\n --tw-border-opacity: 1;\n border-color: rgb(212 212 212 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=neki\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#fbca00\\][data-state=\"current\"][data-engine=\"neki\"] {\n --tw-border-opacity: 1;\n border-color: rgb(251 202 0 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=neki\\]\\:data-\\[state\\=link\\]\\:mint-border-\\[\\#fbca00\\][data-state=\"link\"][data-engine=\"neki\"] {\n --tw-border-opacity: 1;\n border-color: rgb(251 202 0 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=postgres\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#a9dffe\\][data-state=\"current\"][data-engine=\"postgres\"] {\n --tw-border-opacity: 1;\n border-color: rgb(169 223 254 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=postgres\\]\\:data-\\[state\\=link\\]\\:mint-border-\\[\\#a9dffe\\][data-state=\"link\"][data-engine=\"postgres\"] {\n --tw-border-opacity: 1;\n border-color: rgb(169 223 254 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=vitess\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#ffc59b\\][data-state=\"current\"][data-engine=\"vitess\"] {\n --tw-border-opacity: 1;\n border-color: rgb(255 197 155 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=vitess\\]\\:data-\\[state\\=link\\]\\:mint-border-\\[\\#ffc59b\\][data-state=\"link\"][data-engine=\"vitess\"] {\n --tw-border-opacity: 1;\n border-color: rgb(255 197 155 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=both\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#f0f0f0\\][data-state=\"current\"][data-engine=\"both\"] {\n --tw-bg-opacity: 1;\n background-color: rgb(240 240 240 / var(--tw-bg-opacity, 1))\n}\n.data-\\[engine\\=neki\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#fbca00\\][data-state=\"current\"][data-engine=\"neki\"] {\n --tw-bg-opacity: 1;\n background-color: rgb(251 202 0 / var(--tw-bg-opacity, 1))\n}\n.data-\\[engine\\=neki\\]\\:data-\\[state\\=link\\]\\:mint-bg-transparent[data-state=\"link\"][data-engine=\"neki\"] {\n background-color: transparent\n}\n.data-\\[engine\\=postgres\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#ddf2ff\\][data-state=\"current\"][data-engine=\"postgres\"] {\n --tw-bg-opacity: 1;\n background-color: rgb(221 242 255 / var(--tw-bg-opacity, 1))\n}\n.data-\\[engine\\=postgres\\]\\:data-\\[state\\=link\\]\\:mint-bg-transparent[data-state=\"link\"][data-engine=\"postgres\"] {\n background-color: transparent\n}\n.data-\\[engine\\=vitess\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#ffe8d8\\][data-state=\"current\"][data-engine=\"vitess\"] {\n --tw-bg-opacity: 1;\n background-color: rgb(255 232 216 / var(--tw-bg-opacity, 1))\n}\n.data-\\[engine\\=vitess\\]\\:data-\\[state\\=link\\]\\:mint-bg-transparent[data-state=\"link\"][data-engine=\"vitess\"] {\n background-color: transparent\n}\n.data-\\[engine\\=both\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#3d3d3d\\][data-state=\"current\"][data-engine=\"both\"] {\n --tw-text-opacity: 1;\n color: rgb(61 61 61 / var(--tw-text-opacity, 1))\n}\n.data-\\[engine\\=neki\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#1a1a1a\\][data-state=\"current\"][data-engine=\"neki\"] {\n --tw-text-opacity: 1;\n color: rgb(26 26 26 / var(--tw-text-opacity, 1))\n}\n.data-\\[engine\\=neki\\]\\:data-\\[state\\=link\\]\\:mint-text-\\[\\#8f7200\\][data-state=\"link\"][data-engine=\"neki\"] {\n --tw-text-opacity: 1;\n color: rgb(143 114 0 / var(--tw-text-opacity, 1))\n}\n.data-\\[engine\\=postgres\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#0e3682\\][data-state=\"current\"][data-engine=\"postgres\"] {\n --tw-text-opacity: 1;\n color: rgb(14 54 130 / var(--tw-text-opacity, 1))\n}\n.data-\\[engine\\=postgres\\]\\:data-\\[state\\=link\\]\\:mint-text-\\[\\#0b6ec5\\][data-state=\"link\"][data-engine=\"postgres\"] {\n --tw-text-opacity: 1;\n color: rgb(11 110 197 / var(--tw-text-opacity, 1))\n}\n.data-\\[engine\\=vitess\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#672002\\][data-state=\"current\"][data-engine=\"vitess\"] {\n --tw-text-opacity: 1;\n color: rgb(103 32 2 / var(--tw-text-opacity, 1))\n}\n.data-\\[engine\\=vitess\\]\\:data-\\[state\\=link\\]\\:mint-text-\\[\\#b83a05\\][data-state=\"link\"][data-engine=\"vitess\"] {\n --tw-text-opacity: 1;\n color: rgb(184 58 5 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=both\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#525252\\][data-state=\"current\"][data-engine=\"both\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(82 82 82 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=neki\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#fbca00\\][data-state=\"current\"][data-engine=\"neki\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(251 202 0 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=neki\\]\\:data-\\[state\\=link\\]\\:mint-border-\\[\\#fbca00\\][data-state=\"link\"][data-engine=\"neki\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(251 202 0 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=postgres\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#144eb6\\][data-state=\"current\"][data-engine=\"postgres\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(20 78 182 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=postgres\\]\\:data-\\[state\\=link\\]\\:mint-border-\\[\\#144eb6\\][data-state=\"link\"][data-engine=\"postgres\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(20 78 182 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=vitess\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#962d00\\][data-state=\"current\"][data-engine=\"vitess\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(150 45 0 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=vitess\\]\\:data-\\[state\\=link\\]\\:mint-border-\\[\\#962d00\\][data-state=\"link\"][data-engine=\"vitess\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(150 45 0 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=both\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#2a2a2a\\][data-state=\"current\"][data-engine=\"both\"]:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(42 42 42 / var(--tw-bg-opacity, 1))\n}\n.dark\\:data-\\[engine\\=neki\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#fbca00\\][data-state=\"current\"][data-engine=\"neki\"]:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(251 202 0 / var(--tw-bg-opacity, 1))\n}\n.dark\\:data-\\[engine\\=neki\\]\\:data-\\[state\\=link\\]\\:mint-bg-transparent[data-state=\"link\"][data-engine=\"neki\"]:is(.dark *) {\n background-color: transparent\n}\n.dark\\:data-\\[engine\\=postgres\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#08204e\\][data-state=\"current\"][data-engine=\"postgres\"]:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(8 32 78 / var(--tw-bg-opacity, 1))\n}\n.dark\\:data-\\[engine\\=postgres\\]\\:data-\\[state\\=link\\]\\:mint-bg-transparent[data-state=\"link\"][data-engine=\"postgres\"]:is(.dark *) {\n background-color: transparent\n}\n.dark\\:data-\\[engine\\=vitess\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#3c1403\\][data-state=\"current\"][data-engine=\"vitess\"]:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(60 20 3 / var(--tw-bg-opacity, 1))\n}\n.dark\\:data-\\[engine\\=vitess\\]\\:data-\\[state\\=link\\]\\:mint-bg-transparent[data-state=\"link\"][data-engine=\"vitess\"]:is(.dark *) {\n background-color: transparent\n}\n.dark\\:data-\\[engine\\=both\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#e5e5e5\\][data-state=\"current\"][data-engine=\"both\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(229 229 229 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=neki\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#1a1a1a\\][data-state=\"current\"][data-engine=\"neki\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(26 26 26 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=neki\\]\\:data-\\[state\\=link\\]\\:mint-text-\\[\\#fbca00\\][data-state=\"link\"][data-engine=\"neki\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(251 202 0 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=postgres\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#ddf2ff\\][data-state=\"current\"][data-engine=\"postgres\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(221 242 255 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=postgres\\]\\:data-\\[state\\=link\\]\\:mint-text-\\[\\#73c7f9\\][data-state=\"link\"][data-engine=\"postgres\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(115 199 249 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=vitess\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#ffe8d8\\][data-state=\"current\"][data-engine=\"vitess\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(255 232 216 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=vitess\\]\\:data-\\[state\\=link\\]\\:mint-text-\\[\\#ffc59b\\][data-state=\"link\"][data-engine=\"vitess\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(255 197 155 / var(--tw-text-opacity, 1))\n}","openApiReferenceData":{"operation":{"tags":["Bouncers"],"operationId":"create_bouncer","summary":"Create a bouncer","parameters":["a71ec648-3dfa-49eb-b4ee-299b5e160888","cd2f81f7-6d37-47a3-8f35-d458958ef2da","302d27e1-4c77-4cef-9c88-e4610b03359d"],"requestBody":"cc5da07c-7b73-455f-8b8b-7159d7d9c9b3","responses":{"200":"6fdfd857-645f-4b7f-b439-7b09cebb35d7","401":"4776c4f0-47b4-428e-8b4c-c0c6d3e504da","403":"1e4cc410-5b15-4556-bb6e-370ff395ff49","404":"9af70cb6-0ae5-4d27-81ac-39782ee05e09","422":"fa6ec071-4333-409a-a374-aae5c793d37c","429":"e50ab83c-cd38-4ea9-8242-36c7756179c9","500":"379414f1-5a66-41ee-bc14-fa64505f6a7e"},"description":"\n### Authorization\nA service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:\n\n**Service Token Accesses**\n `write_database`\n\n**OAuth Scopes**\n\n | Resource | Scopes |\n| :------- | :---------- |\n| Organization | `write_databases` |\n| Database | `write_database` |","method":"post","type":"path","servers":["3759bdaa-8148-479e-a8e8-7f8e8d52553e"],"security":["7501a857-855d-4d14-8ee7-cf2bc88fad9f"],"path":"/organizations/{organization}/databases/{database}/branches/{branch}/bouncers","baseUrlOptions":["https://api.planetscale.com/v1"],"title":"Create a bouncer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a71ec648-3dfa-49eb-b4ee-299b5e160888":{"name":"organization","in":"path","required":true,"description":"Organization name slug from `list_organizations`. Example: `acme`.","schema":{"type":"string","isRequired":true,"description":"Organization name slug from `list_organizations`. Example: `acme`.","uniqueKey":"","typeLabel":"string"}},"cd2f81f7-6d37-47a3-8f35-d458958ef2da":{"name":"database","in":"path","required":true,"description":"Database name slug from `list_databases`. Example: `app-db`.","schema":{"type":"string","isRequired":true,"description":"Database name slug from `list_databases`. Example: `app-db`.","uniqueKey":"","typeLabel":"string"}},"302d27e1-4c77-4cef-9c88-e4610b03359d":{"name":"branch","in":"path","required":true,"description":"Branch name from `list_branches`. Example: `main`.","schema":{"type":"string","isRequired":true,"description":"Branch name from `list_branches`. Example: `main`.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The bouncer name","uniqueKey":"name","typeLabel":"string"},"target":{"type":"string","description":"The type of server the bouncer targets","uniqueKey":"target","typeLabel":"string"},"bouncer_size":{"type":"string","description":"The size SKU for the bouncer","uniqueKey":"bouncer_size","typeLabel":"string"},"replicas_per_cell":{"type":"integer","description":"The number of replica servers per cell","uniqueKey":"replicas_per_cell","typeLabel":"integer"},"dedicated_read_replica_id":{"type":"string","description":"The ID of the dedicated read replica where the bouncer should run","uniqueKey":"dedicated_read_replica_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","target":"\u003cstring>","bouncer_size":"\u003cstring>","replicas_per_cell":123,"dedicated_read_replica_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6fdfd857-645f-4b7f-b439-7b09cebb35d7":{"description":"Returns the new bouncer","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the bouncer","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","description":"The name of the bouncer","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"sku":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Postgres bouncer SKU","isRequired":true,"uniqueKey":"sku.name","typeLabel":"string"},"display_name":{"type":"string","description":"The display name","isRequired":true,"uniqueKey":"sku.display_name","typeLabel":"string"},"cpu":{"type":"string","description":"The CPU allocation","isRequired":true,"uniqueKey":"sku.cpu","typeLabel":"string"},"ram":{"type":"integer","description":"The amount of memory in bytes","isRequired":true,"uniqueKey":"sku.ram","typeLabel":"integer"},"sort_order":{"type":"integer","description":"The sort order of the Postgres bouncer SKU","isRequired":true,"uniqueKey":"sku.sort_order","typeLabel":"integer"}},"required":["name","display_name","cpu","ram","sort_order"],"isRequired":true,"uniqueKey":"sku","typeLabel":"object"},"target":{"type":"string","enum":["primary","replica","replica_az_affinity"],"description":"The instance type the bouncer targets","isRequired":true,"uniqueKey":"target","typeLabel":"enum\u003cstring>"},"replicas_per_cell":{"type":"integer","description":"The count of replicas in each cell","isRequired":true,"uniqueKey":"replicas_per_cell","typeLabel":"integer"},"created_at":{"type":"string","description":"When the bouncer was created","isRequired":true,"uniqueKey":"created_at","typeLabel":"string"},"updated_at":{"type":"string","description":"When the bouncer was updated","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string"},"deleted_at":{"oneOf":[{"type":"string","description":"When the bouncer was deleted","isRequired":true,"uniqueKey":"deleted_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the bouncer was deleted","isRequired":true,"uniqueKey":"deleted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"deleted_at","typeLabel":"string | null"},"actor":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the actor","isRequired":true,"uniqueKey":"actor.id","typeLabel":"string"},"display_name":{"type":"string","description":"The name of the actor","isRequired":true,"uniqueKey":"actor.display_name","typeLabel":"string"},"avatar_url":{"type":"string","description":"The URL of the actor's avatar","isRequired":true,"uniqueKey":"actor.avatar_url","typeLabel":"string"}},"required":["id","display_name","avatar_url"],"isRequired":true,"uniqueKey":"actor","typeLabel":"object"},"branch":{"type":"object","properties":{"id":{"type":"string","description":"The ID for the resource","isRequired":true,"uniqueKey":"branch.id","typeLabel":"string"},"name":{"type":"string","description":"The name for the resource","isRequired":true,"uniqueKey":"branch.name","typeLabel":"string"},"created_at":{"type":"string","description":"When the resource was created","isRequired":true,"uniqueKey":"branch.created_at","typeLabel":"string"},"updated_at":{"type":"string","description":"When the resource was last updated","isRequired":true,"uniqueKey":"branch.updated_at","typeLabel":"string"},"deleted_at":{"oneOf":[{"type":"string","description":"When the resource was deleted, if deleted","isRequired":true,"uniqueKey":"branch.deleted_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the resource was deleted, if deleted","isRequired":true,"uniqueKey":"branch.deleted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"branch.deleted_at","typeLabel":"string | null"}},"required":["id","name","created_at","updated_at","deleted_at"],"isRequired":true,"uniqueKey":"branch","typeLabel":"object"},"parameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the parameter","isRequired":true,"uniqueKey":"parameters.items.[INDEX].name","typeLabel":"string"},"display_name":{"type":"string","description":"The display name of the parameter","isRequired":true,"uniqueKey":"parameters.items.[INDEX].display_name","typeLabel":"string"},"namespace":{"type":"string","enum":["patroni","pgbouncer","pgconf"],"description":"The namespace of the parameter","isRequired":true,"uniqueKey":"parameters.items.[INDEX].namespace","typeLabel":"enum\u003cstring>"},"advanced":{"type":"boolean","description":"Whether the parameter is advanced","isRequired":true,"uniqueKey":"parameters.items.[INDEX].advanced","typeLabel":"boolean"},"internal":{"type":"boolean","description":"Whether the parameter is internal and cannot be changed","isRequired":true,"uniqueKey":"parameters.items.[INDEX].internal","typeLabel":"boolean"},"category":{"oneOf":[{"type":"string","description":"The category of the parameter","isRequired":true,"uniqueKey":"parameters.items.[INDEX].category.oneOf.0","typeLabel":"string"},{"type":"null","description":"The category of the parameter","isRequired":true,"uniqueKey":"parameters.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parameters.items.[INDEX].category","typeLabel":"string | null"},"description":{"type":"string","description":"The description of the parameter","isRequired":true,"uniqueKey":"parameters.items.[INDEX].description","typeLabel":"string"},"parameter_type":{"type":"string","enum":["array","boolean","bytes","float","integer","select","string","time"],"description":"The type of the parameter","isRequired":true,"uniqueKey":"parameters.items.[INDEX].parameter_type","typeLabel":"enum\u003cstring>"},"default_value":{"oneOf":[{"type":"string","description":"The default value of the parameter","isRequired":true,"uniqueKey":"parameters.items.[INDEX].default_value.oneOf.0","typeLabel":"string"},{"type":"null","description":"The default value of the parameter","isRequired":true,"uniqueKey":"parameters.items.[INDEX].default_value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parameters.items.[INDEX].default_value","typeLabel":"string | null"},"disabled":{"type":"boolean","description":"Whether the parameter is disabled","isRequired":true,"uniqueKey":"parameters.items.[INDEX].disabled","typeLabel":"boolean"},"requires_update":{"oneOf":[{"type":"string","enum":["cluster"],"description":"The update required before the parameter can be configured","isRequired":true,"uniqueKey":"parameters.items.[INDEX].requires_update.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["cluster"],"description":"The update required before the parameter can be configured","isRequired":true,"uniqueKey":"parameters.items.[INDEX].requires_update.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parameters.items.[INDEX].requires_update","typeLabel":"enum\u003cstring> | null"},"value":{"oneOf":[{"type":"string","description":"The configured value of the parameter","isRequired":true,"uniqueKey":"parameters.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"null","description":"The configured value of the parameter","isRequired":true,"uniqueKey":"parameters.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parameters.items.[INDEX].value","typeLabel":"string | null"},"required":{"type":"boolean","description":"Whether the parameter is required","isRequired":true,"uniqueKey":"parameters.items.[INDEX].required","typeLabel":"boolean"},"created_at":{"oneOf":[{"type":"string","description":"When the parameter was created","isRequired":true,"uniqueKey":"parameters.items.[INDEX].created_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the parameter was created","isRequired":true,"uniqueKey":"parameters.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parameters.items.[INDEX].created_at","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"string","description":"When the parameter was last updated","isRequired":true,"uniqueKey":"parameters.items.[INDEX].updated_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the parameter was last updated","isRequired":true,"uniqueKey":"parameters.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parameters.items.[INDEX].updated_at","typeLabel":"string | null"},"restart":{"type":"boolean","description":"Whether processes require a server restart after the parameter changes","isRequired":true,"uniqueKey":"parameters.items.[INDEX].restart","typeLabel":"boolean"},"url":{"type":"string","description":"The URL of the parameter","isRequired":true,"uniqueKey":"parameters.items.[INDEX].url","typeLabel":"string"},"actor":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the actor","isRequired":true,"uniqueKey":"parameters.items.[INDEX].actor.id","typeLabel":"string"},"display_name":{"type":"string","description":"The name of the actor","isRequired":true,"uniqueKey":"parameters.items.[INDEX].actor.display_name","typeLabel":"string"},"avatar_url":{"type":"string","description":"The URL of the actor's avatar","isRequired":true,"uniqueKey":"parameters.items.[INDEX].actor.avatar_url","typeLabel":"string"}},"required":["id","display_name","avatar_url"],"isRequired":true,"uniqueKey":"parameters.items.[INDEX].actor","typeLabel":"object"},"id":{"oneOf":[{"type":"string","description":"The ID of the parameter","uniqueKey":"parameters.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the parameter","uniqueKey":"parameters.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"parameters.items.[INDEX].id","typeLabel":"string | null"},"max":{"oneOf":[{"type":"string","description":"The maximum value of the parameter, e.g. `800` or `1h`","uniqueKey":"parameters.items.[INDEX].max.oneOf.0","typeLabel":"string"},{"type":"null","description":"The maximum value of the parameter, e.g. `800` or `1h`","uniqueKey":"parameters.items.[INDEX].max.oneOf.1","typeLabel":"null"}],"uniqueKey":"parameters.items.[INDEX].max","typeLabel":"string | null"},"min":{"oneOf":[{"type":"string","description":"The minimum value of the parameter, e.g. `0` or `1ms`","uniqueKey":"parameters.items.[INDEX].min.oneOf.0","typeLabel":"string"},{"type":"null","description":"The minimum value of the parameter, e.g. `0` or `1ms`","uniqueKey":"parameters.items.[INDEX].min.oneOf.1","typeLabel":"null"}],"uniqueKey":"parameters.items.[INDEX].min","typeLabel":"string | null"},"options":{"oneOf":[{"items":{"type":"string","uniqueKey":"parameters.items.[INDEX].options.oneOf.0.items.[INDEX]","typeLabel":"string"},"type":"array","description":"Options, including disabled ones, for the parameter value. Null means unset","uniqueKey":"parameters.items.[INDEX].options.oneOf.0","typeLabel":"string[]"},{"items":{"type":"string"},"type":"null","description":"Options, including disabled ones, for the parameter value. Null means unset","uniqueKey":"parameters.items.[INDEX].options.oneOf.1","typeLabel":"null"}],"uniqueKey":"parameters.items.[INDEX].options","typeLabel":"string[] | null"},"units":{"oneOf":[{"items":{"type":"string","uniqueKey":"parameters.items.[INDEX].units.oneOf.0.items.[INDEX]","typeLabel":"string"},"type":"array","description":"The units of the parameter value","uniqueKey":"parameters.items.[INDEX].units.oneOf.0","typeLabel":"string[]"},{"items":{"type":"string"},"type":"null","description":"The units of the parameter value","uniqueKey":"parameters.items.[INDEX].units.oneOf.1","typeLabel":"null"}],"uniqueKey":"parameters.items.[INDEX].units","typeLabel":"string[] | null"}},"required":["name","display_name","namespace","advanced","internal","category","description","parameter_type","default_value","disabled","requires_update","value","required","created_at","updated_at","restart","url","actor"],"uniqueKey":"parameters.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"parameters","typeLabel":"object[]"}},"required":["id","name","sku","target","replicas_per_cell","created_at","updated_at","deleted_at","actor","branch","parameters"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","sku":{"name":"\u003cstring>","display_name":"\u003cstring>","cpu":"\u003cstring>","ram":123,"sort_order":123},"target":"primary","replicas_per_cell":123,"created_at":"\u003cstring>","updated_at":"\u003cstring>","deleted_at":"\u003cstring>","actor":{"id":"\u003cstring>","display_name":"\u003cstring>","avatar_url":"\u003cstring>"},"branch":{"id":"\u003cstring>","name":"\u003cstring>","created_at":"\u003cstring>","updated_at":"\u003cstring>","deleted_at":"\u003cstring>"},"parameters":[{"name":"\u003cstring>","display_name":"\u003cstring>","namespace":"patroni","advanced":true,"internal":true,"category":"\u003cstring>","description":"\u003cstring>","parameter_type":"array","default_value":"\u003cstring>","disabled":true,"requires_update":"cluster","value":"\u003cstring>","required":true,"created_at":"\u003cstring>","updated_at":"\u003cstring>","restart":true,"url":"\u003cstring>","actor":{"id":"\u003cstring>","display_name":"\u003cstring>","avatar_url":"\u003cstring>"},"id":"\u003cstring>","max":"\u003cstring>","min":"\u003cstring>","options":["\u003cstring>"],"units":["\u003cstring>"]}]}}},"exampleType":"generated"}},"exampleType":"generated"},"4776c4f0-47b4-428e-8b4c-c0c6d3e504da":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"1e4cc410-5b15-4556-bb6e-370ff395ff49":{"description":"Forbidden","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9af70cb6-0ae5-4d27-81ac-39782ee05e09":{"description":"Not Found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"fa6ec071-4333-409a-a374-aae5c793d37c":{"description":"Unprocessable Entity","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"e50ab83c-cd38-4ea9-8242-36c7756179c9":{"description":"Too Many Requests. Reduce the frequency of requests and try again soon.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"379414f1-5a66-41ee-bc14-fa64505f6a7e":{"description":"Internal Server Error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"7501a857-855d-4d14-8ee7-cf2bc88fad9f":{"oauth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.planetscale.com/oauth/authorize","tokenUrl":"https://auth.planetscale.com/oauth/token","scopes":{"email":"Read user email","openid":"OpenID Connect scope","profile":"Read user profile","read_databases":"Read organization databases","read_user":"Read user","read_organization":"Read organization","write_databases":"Write organization databases","write_user":"Write user","write_organization":"Write organization","branch:delete_backups":"Delete backups","branch:delete_branch":"Delete a database branch","branch:manage_passwords":"Read, write, and delete branch passwords","branch:manage_read_only_passwords":"Read, write, and delete read only branch passwords","branch:manage_topology":"Manage shard primaries and tablet serving for this branch","branch:read_backups":"Read backups","branch:read_branch":"Read a database branch","branch:restore_backups":"Restore this branch's backups to new branches","branch:write_backups":"Create and update backups","branch:write_branch":"Write a database branch","database:approve_deploy_requests":"Approve deploy requests in a database","database:delete_backups":"Delete backups","database:delete_branches":"Delete database branches","database:delete_database":"Delete a database","database:delete_members":"Delete members","database:delete_production_branch_backups":"Delete production backups","database:delete_production_branches":"Delete a production database branch","database:demote_branches":"Demote production database branches","database:deploy_deploy_requests":"Deploy deploy requests in a database","database:manage_branch_topologies":"Manage shard primaries and tablet serving for development branches in a database","database:manage_passwords":"Read, write, and delete database branch passwords","database:manage_production_branch_passwords":"Read, write, and delete production branch passwords","database:manage_production_branch_topologies":"Manage shard primaries and tablet serving for production branches in a database","database:manage_production_read_only_passwords":"Read, write, and delete production read only branch passwords in an organization","database:manage_read_only_passwords":"Read, write, and delete read only branch passwords in an organization","database:promote_branches":"Promote database branches","database:read_backups":"Read backups","database:read_branches":"Read database branches","database:read_comments":"Read deploy request comments in a database","database:read_database":"Read database information","database:read_deploy_requests":"Read deploy requests in a database","database:read_members":"Read members","database:read_workflows":"Read database workflows","database:restore_backups":"Restore backups to new branches","database:restore_production_branch_backups":"Restore production branch backups to new branches","database:write_backups":"Create and update backups","database:write_branches":"Write database branches","database:write_comments":"Create deploy request comments in a database","database:write_database":"Write database","database:write_deploy_requests":"Create and update deploy requests in a database","database:write_members":"Write members","database:write_workflows":"Create and manage database workflows","organization:approve_deploy_requests":"Approve deploy requests in an organization","organization:create_databases":"Create organization databases","organization:delete_backups":"Delete backups in an organization","organization:delete_branches":"Delete branches in an organization","organization:delete_databases":"Delete organization databases","organization:delete_members":"Delete members in an organization","organization:delete_organization":"Delete organization","organization:delete_production_branch_backups":"Delete production backups in an organization","organization:delete_production_branches":"Delete a production branch in an organization","organization:deploy_deploy_requests":"Deploy deploy requests in an organization","organization:manage_branch_topologies":"Manage shard primaries and tablet serving for development branches in an organization","organization:manage_passwords":"Read, write, and delete branch passwords in an organization","organization:manage_production_branch_passwords":"Read, write, and delete production branch passwords in an organization","organization:manage_production_branch_topologies":"Manage shard primaries and tablet serving for production branches in an organization","organization:manage_production_read_only_passwords":"Read, write, and delete production read only branch passwords in an organization","organization:manage_read_only_passwords":"Read, write, and delete read only branch passwords in an organization","organization:manage_sso":"Enable, configure, and disable organization SSO","organization:promote_branches":"Promote branches in an organization","organization:read_audit_logs":"Read organization audit logs","organization:read_backups":"Read backups in an organization","organization:read_branches":"Read branches in an organization","organization:read_comments":"Read deploy request comments in an organization","organization:read_databases":"Read organization databases","organization:read_deploy_requests":"Read deploy requests in an organization","organization:read_invoices":"Read organization invoices","organization:read_members":"Read members in an organization","organization:read_organization":"Read organization","organization:read_payment_method":"Read organization payment method","organization:read_workflows":"Read workflows in an organization","organization:restore_backups":"Restore backups to new branches in an organization","organization:restore_production_branch_backups":"Restore production branch backups to new branches in an organization","organization:write_backups":"Create and update backups in an organization","organization:write_branches":"Write branches in an organization","organization:write_comments":"Create deploy request comments in an organization","organization:write_databases":"Write organization databases","organization:write_deploy_requests":"Create and update deploy requests in an organization","organization:write_members":"Write members in an organization","organization:write_organization":"Write organization","organization:write_payment_method":"Update and delete the organization payment method","organization:write_workflows":"Create and manage workflows in an organization","user:read_organizations":"Read a user's organizations","user:read_user":"Read user","user:write_user":"Write user"}}},"scopes":[],"schemeName":"oauth2"}}},"servers":{"3759bdaa-8148-479e-a8e8-7f8e8d52553e":{"url":"https://api.planetscale.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.planetscale.com/oauth/authorize","tokenUrl":"https://auth.planetscale.com/oauth/token","scopes":{"email":"Read user email","openid":"OpenID Connect scope","profile":"Read user profile","read_databases":"Read organization databases","read_user":"Read user","read_organization":"Read organization","write_databases":"Write organization databases","write_user":"Write user","write_organization":"Write organization","branch:delete_backups":"Delete backups","branch:delete_branch":"Delete a database branch","branch:manage_passwords":"Read, write, and delete branch passwords","branch:manage_read_only_passwords":"Read, write, and delete read only branch passwords","branch:manage_topology":"Manage shard primaries and tablet serving for this branch","branch:read_backups":"Read backups","branch:read_branch":"Read a database branch","branch:restore_backups":"Restore this branch's backups to new branches","branch:write_backups":"Create and update backups","branch:write_branch":"Write a database branch","database:approve_deploy_requests":"Approve deploy requests in a database","database:delete_backups":"Delete backups","database:delete_branches":"Delete database branches","database:delete_database":"Delete a database","database:delete_members":"Delete members","database:delete_production_branch_backups":"Delete production backups","database:delete_production_branches":"Delete a production database branch","database:demote_branches":"Demote production database branches","database:deploy_deploy_requests":"Deploy deploy requests in a database","database:manage_branch_topologies":"Manage shard primaries and tablet serving for development branches in a database","database:manage_passwords":"Read, write, and delete database branch passwords","database:manage_production_branch_passwords":"Read, write, and delete production branch passwords","database:manage_production_branch_topologies":"Manage shard primaries and tablet serving for production branches in a database","database:manage_production_read_only_passwords":"Read, write, and delete production read only branch passwords in an organization","database:manage_read_only_passwords":"Read, write, and delete read only branch passwords in an organization","database:promote_branches":"Promote database branches","database:read_backups":"Read backups","database:read_branches":"Read database branches","database:read_comments":"Read deploy request comments in a database","database:read_database":"Read database information","database:read_deploy_requests":"Read deploy requests in a database","database:read_members":"Read members","database:read_workflows":"Read database workflows","database:restore_backups":"Restore backups to new branches","database:restore_production_branch_backups":"Restore production branch backups to new branches","database:write_backups":"Create and update backups","database:write_branches":"Write database branches","database:write_comments":"Create deploy request comments in a database","database:write_database":"Write database","database:write_deploy_requests":"Create and update deploy requests in a database","database:write_members":"Write members","database:write_workflows":"Create and manage database workflows","organization:approve_deploy_requests":"Approve deploy requests in an organization","organization:create_databases":"Create organization databases","organization:delete_backups":"Delete backups in an organization","organization:delete_branches":"Delete branches in an organization","organization:delete_databases":"Delete organization databases","organization:delete_members":"Delete members in an organization","organization:delete_organization":"Delete organization","organization:delete_production_branch_backups":"Delete production backups in an organization","organization:delete_production_branches":"Delete a production branch in an organization","organization:deploy_deploy_requests":"Deploy deploy requests in an organization","organization:manage_branch_topologies":"Manage shard primaries and tablet serving for development branches in an organization","organization:manage_passwords":"Read, write, and delete branch passwords in an organization","organization:manage_production_branch_passwords":"Read, write, and delete production branch passwords in an organization","organization:manage_production_branch_topologies":"Manage shard primaries and tablet serving for production branches in an organization","organization:manage_production_read_only_passwords":"Read, write, and delete production read only branch passwords in an organization","organization:manage_read_only_passwords":"Read, write, and delete read only branch passwords in an organization","organization:manage_sso":"Enable, configure, and disable organization SSO","organization:promote_branches":"Promote branches in an organization","organization:read_audit_logs":"Read organization audit logs","organization:read_backups":"Read backups in an organization","organization:read_branches":"Read branches in an organization","organization:read_comments":"Read deploy request comments in an organization","organization:read_databases":"Read organization databases","organization:read_deploy_requests":"Read deploy requests in an organization","organization:read_invoices":"Read organization invoices","organization:read_members":"Read members in an organization","organization:read_organization":"Read organization","organization:read_payment_method":"Read organization payment method","organization:read_workflows":"Read workflows in an organization","organization:restore_backups":"Restore backups to new branches in an organization","organization:restore_production_branch_backups":"Restore production branch backups to new branches in an organization","organization:write_backups":"Create and update backups in an organization","organization:write_branches":"Write branches in an organization","organization:write_comments":"Create deploy request comments in an organization","organization:write_databases":"Write organization databases","organization:write_deploy_requests":"Create and update deploy requests in an organization","organization:write_members":"Write members in an organization","organization:write_organization":"Write organization","organization:write_payment_method":"Update and delete the organization payment method","organization:write_workflows":"Create and manage workflows in an organization","user:read_organizations":"Read a user's organizations","user:read_user":"Read user","user:write_user":"Write user"}}},"scopes":[],"schemeName":"oauth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"planetscale-2","siteName":"PlanetScale","title":"Create a bouncer - PlanetScale","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T19:25:32.846Z","originalFileLocation":"api/reference/create_bouncer.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: Service Token Accesses write_database OAuth Scopes | Resource | Scopes | | :------- | :---------- | | Organization | write_databases | | Database | write_database |\">\u003cmeta data-mint-head name=\"application-name\" content=\"PlanetScale\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a bouncer - PlanetScale\">\u003cmeta data-mint-head property=\"og:description\" content=\"### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: Service Token Accesses write_database OAuth Scopes | Resource | Scopes | | :------- | :---------- | | Organization | write_databases | | Database | write_database |\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PlanetScale\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://planetscale.com/docs/api/reference/create_bouncer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://planetscale-2.mintlify.app/images/og/api/reference/create_bouncer.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a bouncer - PlanetScale\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: Service Token Accesses write_database OAuth Scopes | Resource | Scopes | | :------- | :---------- | | Organization | write_databases | | Database | write_database |\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://planetscale-2.mintlify.app/images/og/api/reference/create_bouncer.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PlanetScale\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0e73cc\">\u003clink data-mint-head rel=\"canonical\" href=\"https://planetscale.com/docs/api/reference/create_bouncer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/reference/create_bouncer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://planetscale.com/#organization\",\"name\":\"PlanetScale\",\"url\":\"https://planetscale.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/planetscale-2/xUilVHToUFALai8a/logo/light.png?fit=max\u0026auto=format\u0026n=xUilVHToUFALai8a\u0026q=85\u0026s=cccd3c9fc813c01b899ab7af15a115b1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://planetscale.com/docs#website\",\"name\":\"PlanetScale\",\"url\":\"https://planetscale.com/docs\",\"publisher\":{\"@id\":\"https://planetscale.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://planetscale.com/docs/api/reference/create_bouncer#webpage\",\"url\":\"https://planetscale.com/docs/api/reference/create_bouncer\",\"name\":\"Create a bouncer\",\"description\":\"### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: Service Token Accesses write_database OAuth Scopes | Resource | Scopes | | :------- | :---------- | | Organization | write_databases | | Database | write_database |\",\"dateModified\":\"2026-10-26T19:25:32.846Z\",\"isPartOf\":{\"@id\":\"https://planetscale.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://planetscale.com/docs/api/reference/create_bouncer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://planetscale.com/docs/api/reference/create_bouncer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Postgres API endpoints\",\"item\":\"https://planetscale.com/docs/api/reference/list_branch_change_requests\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Dedicated PgBouncers\",\"item\":\"https://planetscale.com/docs/api/reference/list_bouncers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a bouncer\",\"item\":\"https://planetscale.com/docs/api/reference/create_bouncer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://planetscale.com/docs/api/reference/create_bouncer#apireference\",\"headline\":\"Create a bouncer\",\"name\":\"Create a bouncer\",\"description\":\"### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: Service Token Accesses write_database OAuth Scopes | Resource | Scopes | | :------- | :---------- | | Organization | write_databases | | Database | write_database |\",\"url\":\"https://planetscale.com/docs/api/reference/create_bouncer\",\"mainEntityOfPage\":{\"@id\":\"https://planetscale.com/docs/api/reference/create_bouncer#webpage\"},\"image\":\"https://planetscale.com/docs/images/og/api/reference/create_bouncer.png\",\"dateModified\":\"2026-10-26T19:25:32.846Z\",\"publisher\":{\"@id\":\"https://planetscale.com/#organization\"},\"isPartOf\":{\"@id\":\"https://planetscale.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PlanetScale\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"PlanetScale","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://planetscale.com/blog"},{"anchor":"Contact Us","icon":"headset","href":"https://planetscale.com/contact"},{"anchor":"Status","icon":"signal","href":"https://www.planetscalestatus.com/"},{"anchor":"Benchmarks","icon":"chart-line","href":"https://planetscale.com/benchmarks"}]},"tabs":[{"tab":"Platform","pages":[{"title":"Platform","href":""}]},{"tab":"Vitess","pages":[{"title":"Vitess","href":"/vitess"}]},{"tab":"Neki","pages":[{"title":"Neki","href":"/neki"}]},{"tab":"Postgres","pages":[{"title":"Postgres","href":"/postgres"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Getting started with PlanetScale API","href":"/api/reference/getting-started-with-planetscale-api"},{"title":"Rate limits","href":"/api/reference/rate-limits"},{"title":"Pagination","href":"/api/reference/pagination"},{"title":"PlanetScale API and OAuth applications","sidebarTitle":"API and OAuth applications","href":"/api/planetscale-api-oauth-applications"},{"title":"Service tokens","href":"/api/service-tokens"},{"title":"OpenAPI Spec","href":"/api/openapi-spec"}]},{"group":"Webhooks in PlanetScale","pages":[{"title":"Webhooks","sidebarTitle":"Setting up webhooks","href":"/api/webhooks"},{"title":"Webhook events reference","href":"/api/webhook-events"}]},{"group":"Authentication","pages":[{"title":"Service tokens","href":"/api/reference/service-tokens"},{"title":"OAuth","href":"/api/reference/oauth"},{"group":"OAuth tokens","pages":[{"title":"Create or refresh OAuth token","href":"/api/reference/oauth/create-token"},{"title":"Revoke OAuth token","href":"/api/reference/oauth/revoke-token"},{"title":"Get OAuth token info","href":"/api/reference/oauth/token-info"}]},{"title":"OAuth access scopes","href":"/api/reference/oauth-access-scopes"}]},{"group":"General API endpoints","pages":[{"group":"Audit logs","pages":[{"openapi":"get /organizations/{organization}/audit-log","title":"List audit logs","href":"/api/reference/list_audit_logs"}]},{"group":"Backup policies","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/backup-policies","title":"List backup policies","href":"/api/reference/list_backup_policies"},{"openapi":"post /organizations/{organization}/databases/{database}/backup-policies","title":"Create a backup policy","href":"/api/reference/create_backup_policy"},{"openapi":"get /organizations/{organization}/databases/{database}/backup-policies/{id}","title":"Get a backup policy","href":"/api/reference/get_backup_policy"},{"openapi":"patch /organizations/{organization}/databases/{database}/backup-policies/{id}","title":"Update a backup policy","href":"/api/reference/update_backup_policy"},{"openapi":"delete /organizations/{organization}/databases/{database}/backup-policies/{id}","title":"Delete a backup policy","href":"/api/reference/delete_backup_policy"}]},{"group":"Backups","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/backups","title":"List backups","href":"/api/reference/list_backups"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/backups","title":"Create a backup","href":"/api/reference/create_backup"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/backups/{id}","title":"Get a backup","href":"/api/reference/get_backup"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/backups/{id}","title":"Delete a backup","href":"/api/reference/delete_backup"},{"openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/backups/{id}","title":"Update a backup","href":"/api/reference/update_backup"}]},{"group":"Billing payment methods","pages":[{"openapi":"get /organizations/{organization}/billing/payment-method","title":"Get the current billing payment method","href":"/api/reference/get_organization_billing_payment_method"},{"openapi":"delete /organizations/{organization}/billing/payment-method","title":"Delete the current billing payment method","href":"/api/reference/delete_organization_billing_payment_method"}]},{"group":"Cluster sizes","pages":[{"openapi":"get /organizations/{organization}/cluster-size-skus","title":"List available cluster sizes","href":"/api/reference/list_cluster_size_skus"}]},{"group":"Database branches","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches","title":"List branches","href":"/api/reference/list_branches"},{"openapi":"post /organizations/{organization}/databases/{database}/branches","title":"Create a branch","href":"/api/reference/create_branch"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}","title":"Get a branch","href":"/api/reference/get_branch"},{"openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}","title":"Update a branch","href":"/api/reference/update_branch"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}","title":"Delete a branch","href":"/api/reference/delete_branch"}]},{"group":"Databases","pages":[{"openapi":"get /organizations/{organization}/databases","title":"List databases","href":"/api/reference/list_databases"},{"openapi":"post /organizations/{organization}/databases","title":"Create a database","href":"/api/reference/create_database"},{"openapi":"get /organizations/{organization}/databases/{database}","title":"Get a database","href":"/api/reference/get_database"},{"openapi":"patch /organizations/{organization}/databases/{database}","title":"Update database settings","href":"/api/reference/update_database_settings"},{"openapi":"delete /organizations/{organization}/databases/{database}","title":"Delete a database","href":"/api/reference/delete_database"},{"openapi":"get /organizations/{organization}/databases/{database}/read-only-regions","title":"List read-only regions","href":"/api/reference/list_read_only_regions"},{"openapi":"get /organizations/{organization}/databases/{database}/regions","title":"List database regions","href":"/api/reference/list_database_regions"}]},{"group":"Invoices","pages":[{"openapi":"get /organizations/{organization}/invoices","title":"Get invoices","href":"/api/reference/list_invoices"},{"openapi":"get /organizations/{organization}/invoices/{id}","title":"Get an invoice","href":"/api/reference/get_invoice"},{"openapi":"get /organizations/{organization}/invoices/{id}/line-items","title":"Get invoice line items","href":"/api/reference/get_invoice_line_items"}]},{"group":"Maintenance schedules","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/maintenance-schedules","title":"List maintenance schedules","href":"/api/reference/list_maintenance_schedules"},{"openapi":"get /organizations/{organization}/databases/{database}/maintenance-schedules/{id}","title":"Get a maintenance schedule","href":"/api/reference/get_maintenance_schedule"},{"openapi":"patch /organizations/{organization}/databases/{database}/maintenance-schedules/{id}","title":"Update a maintenance schedule","href":"/api/reference/update_maintenance_schedule"},{"openapi":"get /organizations/{organization}/databases/{database}/maintenance-schedules/{id}/windows","title":"List maintenance windows","href":"/api/reference/list_maintenance_windows"}]},{"group":"Metrics","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/metrics/keyspace-tables","title":"Get table storage metrics by keyspace","href":"/api/reference/get_branch_keyspace_table_metrics"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/metrics","title":"Get time-series metrics","href":"/api/reference/get_branch_metrics"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/metrics/query","title":"Get time-series metrics for SQL queries","href":"/api/reference/get_branch_query_metrics"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/metrics/tables","title":"Get table storage metrics","href":"/api/reference/get_branch_table_metrics"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/metrics/tag","title":"Get time-series metrics grouped by query tags","href":"/api/reference/get_branch_tag_metrics"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/metrics/instant","title":"Get current metric values","href":"/api/reference/get_instant_branch_metrics"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/metrics/tablets-instant","title":"Get current tablet metrics","href":"/api/reference/get_instant_tablet_metrics"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/metrics/tablets","title":"Get time-series tablet metrics","href":"/api/reference/get_tablet_metrics"}]},{"group":"OAuth applications","pages":[{"openapi":"get /organizations/{organization}/oauth-applications","title":"List OAuth applications","href":"/api/reference/list_oauth_applications"},{"openapi":"get /organizations/{organization}/oauth-applications/{application_id}","title":"Get an OAuth application","href":"/api/reference/get_oauth_application"},{"openapi":"get /organizations/{organization}/oauth-applications/{application_id}/tokens/{token_id}","title":"Get an OAuth token","href":"/api/reference/get_oauth_token"},{"openapi":"delete /organizations/{organization}/oauth-applications/{application_id}/tokens/{token_id}","title":"Delete an OAuth token","href":"/api/reference/delete_oauth_token"}]},{"group":"OAuth tokens","pages":[{"openapi":"post /organizations/{organization}/oauth-applications/{id}/token","title":"Create or renew an OAuth token","href":"/api/reference/create_oauth_token"}]},{"group":"Organization invitations","pages":[{"openapi":"get /organizations/{organization}/invitations","title":"List pending invitations","href":"/api/reference/list_organization_invitations"},{"openapi":"post /organizations/{organization}/invitations","title":"Send an invitation","href":"/api/reference/create_organization_invitation"},{"openapi":"delete /organizations/{organization}/invitations/{id}","title":"Cancel an invitation","href":"/api/reference/cancel_organization_invitation"}]},{"group":"Organization members","pages":[{"openapi":"get /organizations/{organization}/members","title":"List organization members","href":"/api/reference/list_organization_members"},{"openapi":"get /organizations/{organization}/members/{id}","title":"Get an organization member","href":"/api/reference/get_organization_membership"},{"openapi":"patch /organizations/{organization}/members/{id}","title":"Update organization member role","href":"/api/reference/update_organization_membership"},{"openapi":"delete /organizations/{organization}/members/{id}","title":"Remove a member from an organization","href":"/api/reference/remove_organization_member"}]},{"group":"Organizations","pages":[{"openapi":"get /organizations","title":"List organizations","href":"/api/reference/list_organizations"},{"openapi":"get /organizations/{organization}","title":"Get an organization","href":"/api/reference/get_organization"},{"openapi":"patch /organizations/{organization}","title":"Update an organization","href":"/api/reference/update_organization"},{"openapi":"get /organizations/{organization}/regions","title":"List regions for an organization","href":"/api/reference/list_regions_for_organization"}]},{"group":"Organization teams","pages":[{"openapi":"get /organizations/{organization}/teams","title":"List teams in an organization","href":"/api/reference/list_organization_teams"},{"openapi":"post /organizations/{organization}/teams","title":"Create an organization team","href":"/api/reference/create_organization_team"},{"openapi":"get /organizations/{organization}/teams/{team}","title":"Get an organization team","href":"/api/reference/get_organization_team"},{"openapi":"patch /organizations/{organization}/teams/{team}","title":"Update an organization team","href":"/api/reference/update_organization_team"},{"openapi":"delete /organizations/{organization}/teams/{team}","title":"Delete an organization team","href":"/api/reference/delete_organization_team"},{"openapi":"get /organizations/{organization}/teams/{team}/members","title":"List team members","href":"/api/reference/list_organization_team_members"},{"openapi":"post /organizations/{organization}/teams/{team}/members","title":"Add a member to a team","href":"/api/reference/add_organization_team_member"},{"openapi":"get /organizations/{organization}/teams/{team}/members/{id}","title":"Get a team member","href":"/api/reference/get_organization_team_member"},{"openapi":"delete /organizations/{organization}/teams/{team}/members/{id}","title":"Remove a member from a team","href":"/api/reference/remove_organization_team_member"}]},{"group":"Query insights","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/insights","title":"List branch queries","href":"/api/reference/list_branch_queries"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/insights/{fingerprint}","title":"Retrieve query statistics","href":"/api/reference/get_query_statistics"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/insights/{fingerprint}/summary","title":"Retrieve a summary of query statistics","href":"/api/reference/get_query_summary"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/insights/queries/{id}","title":"Retrieve a branch query","href":"/api/reference/get_branch_query"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/insights/errors","title":"List branch query errors","href":"/api/reference/list_branch_query_errors"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/insights/errors/{fingerprint}","title":"List queries for an error fingerprint","href":"/api/reference/get_branch_query_error"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/insights/anomalies","title":"List branch anomalies","href":"/api/reference/list_branch_anomalies"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/insights/anomalies/{id}","title":"Retrieve a branch anomaly","href":"/api/reference/get_branch_anomaly"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/insights/tags","title":"List query tags","href":"/api/reference/list_branch_query_tags"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/insights/tags/summaries","title":"List query statistics grouped by tag","href":"/api/reference/list_branch_query_tag_summaries"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/insights/tags/{tag}","title":"Retrieve a query tag","href":"/api/reference/get_branch_query_tag"}]},{"group":"Query Insights reports","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns","title":"List generated query patterns reports","href":"/api/reference/list_generated_query_patterns_reports"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns","title":"Create a new query patterns report","href":"/api/reference/create_query_patterns_report"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}","title":"Show the status of a query patterns report","href":"/api/reference/get_query_patterns_report_status"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}","title":"Delete a query patterns report","href":"/api/reference/delete_query_patterns_report"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}/download","title":"Download a finished query patterns report","href":"/api/reference/get_query_patterns_report"}]},{"group":"Schema recommendations","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/schema-recommendations","title":"List schema recommendations","href":"/api/reference/list_schema_recommendations"},{"openapi":"get /organizations/{organization}/databases/{database}/schema-recommendations/{number}","title":"Get a schema recommendation","href":"/api/reference/get_schema_recommendation"},{"openapi":"post /organizations/{organization}/databases/{database}/schema-recommendations/{number}/dismiss","title":"Dismiss a schema recommendation","href":"/api/reference/dismiss_schema_recommendation"}]},{"group":"Regions","pages":[{"openapi":"get /regions","title":"List public regions","href":"/api/reference/list_public_regions"}]},{"group":"Service tokens","pages":[{"openapi":"post /organizations/{organization}/service-tokens","title":"Create a service token","href":"/api/reference/create_service_token"},{"openapi":"delete /organizations/{organization}/service-tokens/{id}","title":"Delete a service token","href":"/api/reference/delete_service_token"},{"openapi":"get /organizations/{organization}/service-tokens/{id}","title":"Get a service token","href":"/api/reference/get_service_token"},{"openapi":"get /organizations/{organization}/service-tokens","title":"List service tokens","href":"/api/reference/list_service_tokens"}]},{"group":"Users","pages":[{"openapi":"get /user","title":"Get current user","href":"/api/reference/get_current_user"}]},{"group":"Webhooks","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/webhooks","title":"List webhooks","href":"/api/reference/list_webhooks"},{"openapi":"post /organizations/{organization}/databases/{database}/webhooks","title":"Create a webhook","href":"/api/reference/create_webhook"},{"openapi":"get /organizations/{organization}/databases/{database}/webhooks/{id}","title":"Get a webhook","href":"/api/reference/get_webhook"},{"openapi":"patch /organizations/{organization}/databases/{database}/webhooks/{id}","title":"Update a webhook","href":"/api/reference/update_webhook"},{"openapi":"delete /organizations/{organization}/databases/{database}/webhooks/{id}","title":"Delete a webhook","href":"/api/reference/delete_webhook"},{"openapi":"post /organizations/{organization}/databases/{database}/webhooks/{id}/test","title":"Test a webhook","href":"/api/reference/test_webhook"}]}]},{"group":"Postgres API endpoints","pages":[{"group":"Branch changes","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/changes","title":"Get branch change requests","href":"/api/reference/list_branch_change_requests"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/changes/{id}","title":"Get a branch change request","href":"/api/reference/get_branch_change_request"},{"openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/changes","title":"Upsert a change request for cluster size, replicas, storage, or parameters","href":"/api/reference/update_branch_change_request"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/resizes","title":"Cancel a change request","href":"/api/reference/cancel_branch_change_request"}]},{"group":"Branch maintenance windows","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/maintenance-window","title":"Get a branch's maintenance window","href":"/api/reference/get_branch_maintenance_window"},{"openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/maintenance-window","title":"Update a branch's maintenance window","href":"/api/reference/update_branch_maintenance_window"}]},{"group":"Cluster extensions","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/extensions","title":"List cluster extensions","href":"/api/reference/list_extensions"}]},{"group":"Cluster parameters","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/parameters","title":"List cluster parameters","href":"/api/reference/list_parameters"}]},{"group":"Dedicated PgBouncers","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/bouncers","title":"List bouncers","description":"\n### Authorization\nA service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:\n\n**Service Token Accesses**\n `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`\n\n**OAuth Scopes**\n\n | Resource | Scopes |\n| :------- | :---------- |\n| Organization | `read_branches` |\n| Database | `read_branches` |\n| Branch | `read_branch` |","href":"/api/reference/list_bouncers"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/bouncers","title":"Create a bouncer","href":"/api/reference/create_bouncer"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}","title":"Get a bouncer","description":"\n### Authorization\nA service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:\n\n**Service Token Accesses**\n `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`\n\n**OAuth Scopes**\n\n | Resource | Scopes |\n| :------- | :---------- |\n| Organization | `read_branches` |\n| Database | `read_branches` |\n| Branch | `read_branch` |","href":"/api/reference/get_bouncer"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}","title":"Delete a bouncer","href":"/api/reference/delete_bouncer"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/bouncer-resizes","title":"Get bouncer resize requests","href":"/api/reference/list_branch_bouncer_resize_requests"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes","title":"Get bouncer resize requests","href":"/api/reference/list_bouncer_resize_requests"},{"openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes","title":"Upsert a bouncer resize request","href":"/api/reference/update_bouncer_resize_request"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes","title":"Cancel a resize request","href":"/api/reference/cancel_bouncer_resize_request"}]},{"group":"IP restrictions","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/cidrs","title":"List IP restriction entries","href":"/api/reference/list_database_postgres_cidrs"},{"openapi":"post /organizations/{organization}/databases/{database}/cidrs","title":"Create an IP restriction entry","href":"/api/reference/create_database_postgres_cidr"},{"openapi":"get /organizations/{organization}/databases/{database}/cidrs/{id}","title":"Get an IP restriction entry","href":"/api/reference/get_database_postgres_cidr"},{"openapi":"patch /organizations/{organization}/databases/{database}/cidrs/{id}","title":"Update an IP restriction entry","href":"/api/reference/update_database_postgres_cidr"},{"openapi":"delete /organizations/{organization}/databases/{database}/cidrs/{id}","title":"Delete an IP restriction entry","href":"/api/reference/delete_database_postgres_cidr"}]},{"group":"Maintenance events","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/maintenance-events","title":"List maintenance events","href":"/api/reference/list_maintenance_events"},{"openapi":"get /organizations/{organization}/databases/{database}/maintenance-events/{id}","title":"Get a maintenance event","href":"/api/reference/get_maintenance_event"},{"openapi":"patch /organizations/{organization}/databases/{database}/maintenance-events/{id}","title":"Reschedule a maintenance event","href":"/api/reference/reschedule_maintenance_event"}]},{"group":"Dedicated read replicas","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas","title":"List dedicated read replicas","href":"/api/reference/list_dedicated_read_replicas"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas","title":"Create a dedicated read replica","href":"/api/reference/create_dedicated_read_replica"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}","title":"Get a dedicated read replica","href":"/api/reference/get_dedicated_read_replica"},{"openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}","title":"Update a dedicated read replica","href":"/api/reference/update_dedicated_read_replica"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}","title":"Delete a dedicated read replica","href":"/api/reference/delete_dedicated_read_replica"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replica-changes","title":"Get dedicated read replica change requests","href":"/api/reference/list_dedicated_read_replica_change_requests"}]},{"group":"Roles","pages":[{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/roles","title":"Create role credentials","href":"/api/reference/create_role"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}","title":"Delete role credentials","href":"/api/reference/delete_role"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/roles/default","title":"Get the default postgres role","href":"/api/reference/get_default_role"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}","title":"Get a role","href":"/api/reference/get_role"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/roles","title":"List roles","href":"/api/reference/list_roles"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/reassign","title":"Reassign objects owned by one role to another role","href":"/api/reference/reassign_role_objects"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/renew","title":"Renew role expiration","href":"/api/reference/renew_role"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/roles/reset-default","title":"Reset default credentials","href":"/api/reference/reset_default_role"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/reset","title":"Reset a role's password","href":"/api/reference/reset_role"},{"openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}","title":"Update role name","href":"/api/reference/update_role"}]},{"group":"Switchovers","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/switchovers","title":"List switchovers","href":"/api/reference/list_switchovers"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/switchovers","title":"Create a switchover","href":"/api/reference/create_switchover"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/switchovers/{id}","title":"Get a switchover","href":"/api/reference/get_switchover"}]},{"group":"Traffic budgets","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets","title":"List traffic budgets","href":"/api/reference/list_traffic_budgets"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets","title":"Create a traffic budget","href":"/api/reference/create_traffic_budget"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets/{id}","title":"Get a traffic budget","href":"/api/reference/get_traffic_budget"},{"openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets/{id}","title":"Update a traffic budget","href":"/api/reference/update_traffic_budget"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets/{id}","title":"Delete a traffic budget","href":"/api/reference/delete_traffic_budget"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/insights/{fingerprint}/traffic/budgets","title":"List traffic budgets affecting a query fingerprint","href":"/api/reference/list_traffic_budgets_for_query"}]},{"group":"Traffic rules","pages":[{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets/{budget_id}/rules","title":"Create a traffic rule","href":"/api/reference/create_traffic_rule"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets/{budget_id}/rules/{id}","title":"Delete a traffic rule","href":"/api/reference/delete_traffic_rule"}]}]},{"group":"Neki API endpoints","pages":[{"group":"Admins","pages":[{"title":"Get the admin for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/admin","href":"/api/reference/get_admin"},{"title":"Update the admin for a branch","openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/admin","href":"/api/reference/update_admin"},{"title":"List admin size SKUs for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/admin-size-skus","href":"/api/reference/list_admin_size_skus"},{"title":"List change requests for an admin","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/admin/change-requests","href":"/api/reference/list_admin_change_requests"},{"title":"Get a change request for an admin","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/admin/change-requests/{id}","href":"/api/reference/get_admin_change_request"},{"title":"Cancel a change request for an admin","openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/admin/change-requests/{id}","href":"/api/reference/cancel_admin_change_request"},{"title":"List parameters for an admin","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/admin/parameters","href":"/api/reference/list_admin_parameters"}]},{"group":"Configuration profiles","pages":[{"title":"List configuration profiles for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles","href":"/api/reference/list_shard_configuration_profiles"},{"title":"Create a configuration profile for a branch","openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles","href":"/api/reference/create_shard_configuration_profile"},{"title":"Get a configuration profile for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}","href":"/api/reference/get_shard_configuration_profile"},{"title":"Update a configuration profile for a branch","openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}","href":"/api/reference/update_shard_configuration_profile"},{"title":"Delete a configuration profile for a branch","openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}","href":"/api/reference/delete_shard_configuration_profile"},{"title":"Run maintenance for selected configuration profiles","openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/maintenance","href":"/api/reference/run_shard_configuration_profiles_maintenance"},{"title":"Run maintenance for a configuration profile","openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/maintenance","href":"/api/reference/run_shard_configuration_profile_maintenance"},{"title":"List change requests for a configuration profile","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/change-requests","href":"/api/reference/list_shard_configuration_profile_change_requests"},{"title":"Get a change request for a configuration profile","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/change-requests/{id}","href":"/api/reference/get_shard_configuration_profile_change_request"},{"title":"Cancel a change request for a configuration profile","openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/change-requests/{id}","href":"/api/reference/cancel_shard_configuration_profile_change_request"},{"title":"List extensions for a configuration profile","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/extensions","href":"/api/reference/list_shard_configuration_profile_extensions"},{"title":"Enable or disable an extension for a configuration profile","openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/extensions/{extension}","href":"/api/reference/update_shard_configuration_profile_extension"},{"title":"List parameters for a configuration profile","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/parameters","href":"/api/reference/list_shard_configuration_profile_parameters"}]},{"group":"Configuration profile shards","pages":[{"title":"List shards for a configuration profile","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards","href":"/api/reference/list_shard_configuration_profile_shards"},{"title":"Add a shard to a configuration profile","openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards","href":"/api/reference/create_shard_configuration_profile_shard"},{"title":"Add shards to a configuration profile","openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards/bulk","href":"/api/reference/bulk_create_shard_configuration_profile_shards"},{"title":"Assign shards to a configuration profile","openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards","href":"/api/reference/assign_shard_configuration_profile_shards"},{"title":"Remove shards from a configuration profile","openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards","href":"/api/reference/delete_shard_configuration_profile_shards"},{"title":"Get a shard in a configuration profile","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards/{id}","href":"/api/reference/get_shard_configuration_profile_shard"},{"title":"Update a shard in a configuration profile","openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards/{id}","href":"/api/reference/update_shard_configuration_profile_shard"},{"title":"Remove a shard from a configuration profile","openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards/{id}","href":"/api/reference/delete_shard_configuration_profile_shard"}]},{"group":"Data topology","pages":[{"title":"Get the data topology for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/data-topology","href":"/api/reference/get_data_topology"},{"title":"Set the data topology for a branch","openapi":"put /organizations/{organization}/databases/{database}/branches/{branch}/data-topology","href":"/api/reference/update_data_topology"}]},{"group":"Default configuration profile","pages":[{"title":"Get the default configuration profile for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/default-configuration-profile","href":"/api/reference/get_default_shard_configuration_profile"},{"title":"Set the default configuration profile for a branch","openapi":"put /organizations/{organization}/databases/{database}/branches/{branch}/default-configuration-profile","href":"/api/reference/set_default_shard_configuration_profile"}]},{"group":"Neki changes","pages":[{"title":"List change requests for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/neki-changes","href":"/api/reference/list_neki_change_requests"},{"title":"Get a change request for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/neki-changes/{id}","href":"/api/reference/get_neki_change_request"},{"title":"Cancel a change request for a branch","openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/neki-changes/{id}","href":"/api/reference/cancel_neki_change_request"}]},{"group":"Routers","pages":[{"title":"List router size SKUs for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/router-size-skus","href":"/api/reference/list_router_size_skus"},{"title":"List routers for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/routers","href":"/api/reference/list_routers"},{"title":"Create a router for a branch","openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/routers","href":"/api/reference/create_router"},{"title":"Get a router for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}","href":"/api/reference/get_router"},{"title":"Update a router for a branch","openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}","href":"/api/reference/update_router"},{"title":"Delete a router from a branch","openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}","href":"/api/reference/delete_router"},{"title":"List change requests for a router","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}/change-requests","href":"/api/reference/list_router_change_requests"},{"title":"Get a change request for a router","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}/change-requests/{id}","href":"/api/reference/get_router_change_request"},{"title":"Cancel a change request for a router","openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}/change-requests/{id}","href":"/api/reference/cancel_router_change_request"},{"title":"List parameters for a router","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}/parameters","href":"/api/reference/list_router_parameters"}]},{"group":"Shards","pages":[{"title":"List shards for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/shards","href":"/api/reference/list_shards"},{"title":"Add shards to a branch","openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/shards","href":"/api/reference/create_shard"},{"title":"Get a shard for a branch","openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/shards/{id}","href":"/api/reference/get_shard"},{"title":"Update a shard for a branch","openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/shards/{id}","href":"/api/reference/update_shard"},{"title":"Remove a shard from a branch","openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/shards/{id}","href":"/api/reference/delete_shard"}]}]},{"group":"Vitess API endpoints","pages":[{"group":"Branch cluster size","pages":[{"openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/cluster","title":"Change a branch cluster configuration","href":"/api/reference/update_branch_cluster_config"}]},{"group":"Branch promotion","pages":[{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/demote","title":"Demote a branch","href":"/api/reference/demote_branch"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/promote","title":"Promote a branch","href":"/api/reference/promote_branch"}]},{"group":"Branch schema","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/schema","title":"Get a branch schema","href":"/api/reference/get_branch_schema"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/schema/lint","title":"Lint a branch schema","href":"/api/reference/lint_branch_schema"}]},{"group":"Database branch keyspaces","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces","title":"Get keyspaces","href":"/api/reference/list_keyspaces"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces","title":"Create a keyspace","href":"/api/reference/create_keyspace"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}","title":"Get a keyspace","href":"/api/reference/get_keyspace"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}","title":"Delete a keyspace","href":"/api/reference/delete_keyspace"},{"openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}","title":"Configure keyspace settings","href":"/api/reference/update_keyspace"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/rollout-status","title":"Get keyspace rollout status","href":"/api/reference/get_keyspace_rollout_status"}]},{"group":"Database branch passwords","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/passwords","title":"List passwords","href":"/api/reference/list_passwords"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/passwords","title":"Create a password","href":"/api/reference/create_password"},{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}","title":"Get a password","href":"/api/reference/get_password"},{"openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}","title":"Update a password","href":"/api/reference/update_password"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}","title":"Delete a password","href":"/api/reference/delete_password"},{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}/renew","title":"Renew a password","href":"/api/reference/renew_password"}]},{"group":"Deploy request throttling","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/throttler","title":"Get database throttler configurations","href":"/api/reference/get_database_throttler"},{"openapi":"patch /organizations/{organization}/databases/{database}/throttler","title":"Update database throttler configurations","href":"/api/reference/update_database_throttler"}]},{"group":"Deploy requests","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/deploy-queue","title":"Get the deploy queue","href":"/api/reference/get_deploy_queue"},{"openapi":"get /organizations/{organization}/databases/{database}/deploy-requests","title":"List deploy requests","href":"/api/reference/list_deploy_requests"},{"openapi":"post /organizations/{organization}/databases/{database}/deploy-requests","title":"Create a deploy request","href":"/api/reference/create_deploy_request"},{"openapi":"get /organizations/{organization}/databases/{database}/deploy-requests/{number}","title":"Get a deploy request","href":"/api/reference/get_deploy_request"},{"openapi":"patch /organizations/{organization}/databases/{database}/deploy-requests/{number}","title":"Close a deploy request","href":"/api/reference/close_deploy_request"},{"openapi":"post /organizations/{organization}/databases/{database}/deploy-requests/{number}/apply-deploy","title":"Complete a gated deploy request","href":"/api/reference/complete_gated_deploy_request"},{"openapi":"put /organizations/{organization}/databases/{database}/deploy-requests/{number}/auto-apply","title":"Update auto-apply for deploy request","href":"/api/reference/update_auto_apply"},{"openapi":"put /organizations/{organization}/databases/{database}/deploy-requests/{number}/auto-delete-branch","title":"Update auto-delete branch for deploy request","href":"/api/reference/update_auto_delete_branch"},{"openapi":"post /organizations/{organization}/databases/{database}/deploy-requests/{number}/cancel","title":"Cancel a queued deploy request","href":"/api/reference/cancel_deploy_request"},{"openapi":"post /organizations/{organization}/databases/{database}/deploy-requests/{number}/complete-deploy","title":"Complete an errored deploy","href":"/api/reference/complete_errored_deploy"},{"openapi":"post /organizations/{organization}/databases/{database}/deploy-requests/{number}/deploy","title":"Queue a deploy request","href":"/api/reference/queue_deploy_request"},{"openapi":"get /organizations/{organization}/databases/{database}/deploy-requests/{number}/deployment","title":"Get a deployment","href":"/api/reference/get_deployment"},{"openapi":"get /organizations/{organization}/databases/{database}/deploy-requests/{number}/operations","title":"List deploy operations","href":"/api/reference/list_deploy_operations"},{"openapi":"post /organizations/{organization}/databases/{database}/deploy-requests/{number}/revert","title":"Complete a revert","href":"/api/reference/complete_revert"},{"openapi":"get /organizations/{organization}/databases/{database}/deploy-requests/{number}/reviews","title":"List deploy request reviews","href":"/api/reference/list_deploy_request_reviews"},{"openapi":"post /organizations/{organization}/databases/{database}/deploy-requests/{number}/reviews","title":"Review a deploy request","href":"/api/reference/review_deploy_request"},{"openapi":"post /organizations/{organization}/databases/{database}/deploy-requests/{number}/skip-revert","title":"Skip revert period","href":"/api/reference/skip_revert_period"},{"openapi":"get /organizations/{organization}/databases/{database}/deploy-requests/{number}/storage-check","title":"Check deploy request storage","href":"/api/reference/check_deploy_request_storage"},{"openapi":"post /organizations/{organization}/databases/{database}/deploy-requests/{number}/force-cutover","title":"Enable force cutover for a deploy request","href":"/api/reference/force_cutover_deploy_request"},{"openapi":"get /organizations/{organization}/databases/{database}/deploy-requests/{number}/throttler","title":"Get deploy request throttler configurations","href":"/api/reference/get_deploy_request_throttler"},{"openapi":"patch /organizations/{organization}/databases/{database}/deploy-requests/{number}/throttler","title":"Update deploy request throttler configurations","href":"/api/reference/update_deploy_request_throttler"}]},{"group":"Keyspace VSchemas","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema","title":"Get the VSchema for the keyspace","href":"/api/reference/get_keyspace_vschema"},{"openapi":"patch /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema","title":"Update the VSchema for the keyspace","href":"/api/reference/update_keyspace_vschema"}]},{"group":"Safe migrations","pages":[{"openapi":"post /organizations/{organization}/databases/{database}/branches/{branch}/safe-migrations","title":"Enable safe migrations for a branch","href":"/api/reference/enable_safe_migrations"},{"openapi":"delete /organizations/{organization}/databases/{database}/branches/{branch}/safe-migrations","title":"Disable safe migrations for a branch","href":"/api/reference/disable_safe_migrations"}]},{"group":"Workflows","pages":[{"openapi":"get /organizations/{organization}/databases/{database}/workflows","title":null,"href":"/api/reference/list_workflows"},{"openapi":"post /organizations/{organization}/databases/{database}/workflows","title":null,"href":"/api/reference/create_workflow"},{"openapi":"get /organizations/{organization}/databases/{database}/workflows/{number}","title":null,"href":"/api/reference/get_workflow"},{"openapi":"delete /organizations/{organization}/databases/{database}/workflows/{number}","title":null,"href":"/api/reference/workflow_cancel"},{"openapi":"patch /organizations/{organization}/databases/{database}/workflows/{number}/complete","title":null,"href":"/api/reference/workflow_complete"},{"openapi":"patch /organizations/{organization}/databases/{database}/workflows/{number}/cutover","title":null,"href":"/api/reference/workflow_cutover"},{"openapi":"patch /organizations/{organization}/databases/{database}/workflows/{number}/retry","title":null,"href":"/api/reference/workflow_retry"},{"openapi":"patch /organizations/{organization}/databases/{database}/workflows/{number}/reverse-cutover","title":null,"href":"/api/reference/workflow_reverse_cutover"},{"openapi":"patch /organizations/{organization}/databases/{database}/workflows/{number}/reverse-traffic","title":null,"href":"/api/reference/workflow_reverse_traffic"},{"openapi":"patch /organizations/{organization}/databases/{database}/workflows/{number}/switch-primaries","title":null,"href":"/api/reference/workflow_switch_primaries"},{"openapi":"patch /organizations/{organization}/databases/{database}/workflows/{number}/switch-replicas","title":null,"href":"/api/reference/workflow_switch_replicas"},{"openapi":"patch /organizations/{organization}/databases/{database}/workflows/{number}/verify-data","title":null,"href":"/api/reference/verify_workflow"}]}]}]},{"tab":"CLI Reference","pages":[{"title":"CLI Reference","href":"/cli"}]}]},"basePath":"","title":"Create a bouncer - PlanetScale","buildId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","deploymentId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D_4Sesi0.js","utils-DRHeK26p.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6d-DUc2.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dex7slho.js","snippetPresets-BcCEBp0Z.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CufowNTX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-A4lJSCIe.js","shallow-DqoHP7zn.js","getApiPlaygroundDisplay-Cku8AmtL.js","CodeSnippet-CtHQbNqc.js","CodeSnippets-CGo5Cslf.js","Page-BoJxk0m8.js","getPastedJson-M-bKdue4.js","icon-DEqCU4st.js","MethodPill-DnfSSXiJ.js","DuplicateIcon-BHu2PE8M.js","createIcon-BPsE5X7c.js","DynamicMarkdown-Dnt6YhtR.js","SectionHeading-6CtFWqMQ.js","axios-vUo_bRtp.js","Markdown-BoKe_1fI.js","clsx-DM5-sUNJ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CkIdkovK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-B3e6Nh_r.js"]}