Send every API request to your own Blink tenant’s host:
https://<your-tenant>.app.blinkops.com/api/v1
For example, if you log in to Blink at https://a1234.app.blinkops.com, your base URL is https://a1234.app.blinkops.com/api/v1. You can find your tenant name in your browser’s address bar when you’re logged in to Blink.
Don’t send requests to app.blinkops.com without your tenant name in front of it, or to another tenant’s host. The request returns 401 Unauthorized, even with a valid API key, because the key belongs to your tenant.
The code samples on each endpoint page use <your-tenant> as a placeholder. Before using Try it, enter your tenant name in the tenant server field.
Blink supports a maximum of 1000 records per page.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BlinkOps Documentation","colors":{"primary":"#1f7ef2","light":"#1f7ef2","dark":"#0080ff"},"logo":{"light":"https://mintcdn.com/blinkops-2/br6cLdqXY9MZvLgO/logo/light.svg?fit=max\u0026auto=format\u0026n=br6cLdqXY9MZvLgO\u0026q=85\u0026s=55c0663d06bf9395563193d3a5259b7a","dark":"https://mintcdn.com/blinkops-2/br6cLdqXY9MZvLgO/logo/dark.svg?fit=max\u0026auto=format\u0026n=br6cLdqXY9MZvLgO\u0026q=85\u0026s=07f1e67e71da76c022a7070bf00b12a7","href":"https://docs.blinkops.com/"},"favicon":"https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/favicon.png?fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=2f51ab37ee8d63c712d36d21be7104ed","background":{"color":{"dark":"#091120"}},"navbar":{"links":[{"href":"https://app.blinkops.com/","label":"Login"}],"primary":{"type":"button","label":"Get Started","href":"https://www.blinkops.com/schedule-time"}},"footer":{"socials":{"youtube":"https://www.youtube.com/channel/UCHPSbeyNTFR8_rTGjV7V9ow","x":"https://twitter.com/getblinkops","linkedin":"https://www.linkedin.com/company/blink-ops"}},"styling":{"codeblocks":"dark","latex":true},"integrations":{"gtm":{"tagId":"GTM-MWQHTL5"}},"contextual":{"options":["copy","download-spec","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"blinkops-2","hasAudioNarration":false,"actualSubdomain":"blinkops-2","customDomains":["docs.blinkops.com"],"gitSource":{"type":"github","owner":"blinkops","repo":"blink-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae30ac575b8bd33c16b01e2","collectionId":"21285134-d15f-43ce-a140-04a2083c7cf2","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae30ac575b8bd33c16b01e2"},"feedback":{"thumbs":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae3a6c2e25e6a2096a5b41e","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Integrations","count":12890},{"language":"default","tag":"Actions","count":5642},{"language":"default","tag":"Triggers","count":343},{"language":"default","tag":"AWS","count":161},{"language":"default","tag":"Case Management","count":109},{"language":"default","tag":"CrowdStrike","count":106},{"language":"default","tag":"Workflows","count":97},{"language":"default","tag":"Rapid7","count":83},{"language":"default","tag":"Platform","count":72},{"language":"default","tag":"Home","count":64}]},"assistantConfig":{},"basePath":"","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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@import url(https://fonts.googleapis.com/css2?family=Inter:wght@200;300;400;500;600;700;800;900\u0026family=Roboto:ital,wght@0,300;0,400;0,500;0,900;1,300;1,400;1,500;1,700\u0026display=swap);@import \"tailwindcss\";@font-face{font-family:'Nacelle';src:url(https://cdn.prod.website-files.com/62000f475eba4d3330543f5b/652d7a00b58f4090a56b69d4_Nacelle-SemiBold.otf) format('opentype');font-weight:600;font-style:normal;font-display:swap}:root{--dark-mode-aware-p-color-alt:rgba(0, 0, 0, 0.50);--dark-mode-aware-dark-background-color:#1A283B;--dark-mode-aware-dark-border-color:#666;--dark-mode-aware-dark-text-color:#eee;--dark-mode-aware-dark-wrapper-background-color:#364150;--dark-mode-aware-dark-link-color:#ffffff;--dark-mode-aware-keyboard-shortcut:\"rgba(18, 18, 18, 0.85)\";--hero-background-image-light:url(\"https://mintlify.s3.us-west-1.amazonaws.com/blinkops-2/img/HeroLightV.svg\");--hero-background-image-dark:url(\"https://mintlify.s3.us-west-1.amazonaws.com/blinkops-2/img/HeroDark.svg\");--landing-page-image-light:url(\"https://mintlify.s3.us-west-1.amazonaws.com/blinkops-2/img/Hero.svg\");--landing-page-image-dark:url(\"https://mintlify.s3.us-west-1.amazonaws.com/blinkops-2/img/HeroDark.svg\");--integration-page-image-dark:url(\"/img/IntegrationsNote.svg\")}h1,h2,h3,h4{font-family:'Roboto';letter-spacing:normal!important}.hero-text h1,.hero-text h3{font-family:\"Roboto\";font-size:48px;font-style:normal;font-weight:800;line-height:63px;letter-spacing:2.4px}.hero-text h3{text-align:center;font-size:22px;font-weight:400;line-height:25.2px;letter-spacing:.96px}.background-image,.integration-background-image{background-image:var(--landing-page-image-light);height:330px;-webkit-background-size:cover;-moz-background-size:cover;-o-background-size:cover;background-size:cover;position:relative;width:100%;display:flex;align-items:center;justify-content:center;overflow:hidden}.integration-background-image{background-image:var(--integration-page-image-dark);height:400px}.dark .background-image{background-image:var(--landing-page-image-dark)}.paragraph-block{text-align:start;text-wrap:inherit}.paragraph{display:block;margin-block-start:.5em;margin-block-end:1em;margin-inline-start:0;margin-inline-end:0;unicode-bidi:isolate;font-family:Roboto;font-size:28px;font-style:normal;font-weight:400;line-height:normal;color:var(----dark-mode-aware-p-color)}.dark .paragraph{color:#fff}.iframe{height:800px;width:100%}.iframe-wrapper{display:unset}.iframe-media{display:none}.hero{display:flex;flex-direction:row;flex-wrap:wrap;align-items:center;justify-content:space-evenly;text-align:center;padding:2rem,2rem,2rem,2rem;background-image:var(--hero-background-image-light);height:326px;-webkit-background-size:cover;-moz-background-size:cover;-o-background-size:cover;background-size:cover}.dark .hero{background-image:var(--hero-background-image-dark)}.hero-content{display:flex;flex-direction:column;align-items:flex-start;margin-bottom:1rem}.hero h1{font-size:2.5rem;font-weight:700;margin-bottom:1.5rem;color:#000}.search-bar{display:flex;align-items:center;background:0 0;border:1px solid #060709;border-radius:.5rem;overflow:hidden}.keyboard-shortcut,.search-bar input{background:0 0;backdrop-filter:blur(8px)}.search-bar input{border:0;padding:.75rem 1rem;width:400px;height:43px;font-size:1rem;flex-grow:1;outline:0;border-radius:var(--Sizes-Radius-R-4-px, 8px);border:1px solid var(--Color-Transparent-White-10, #ffffff);background:var(--Color-Transparent-White-05, rgba(255, 255, 255, 0.05))}.dark ֿ.search-bar input{border:1px solid #fff}.dark #search{border:1px solid #ffff}.keyboard-shortcut{border-radius:var(--Sizes-Radius-R-4-px, 4px);border:1px solid var(--Color-Transparent-White-10, rgba(255, 255, 255, 0.10));padding:.5rem}.api-item,.grid-table,.keyboard-shortcut{display:flex;align-items:center}.grid-table{margin-top:2rem;grid-column-gap:2.5rem;grid-row-gap:2.5rem;flex-flow:column}#api-grid{grid-column-gap:5rem;grid-row-gap:1.25rem;grid-template-rows:auto;grid-template-columns:1fr 1fr 1fr 1fr;grid-auto-columns:1fr;display:grid;justify-items:center}.api-item{padding:var(--Sizes-Padding-Possitive-32-px, 32px) var(--Sizes-Padding-Possitive-16-px, 16px);border:1px solid #e0e0e0;height:100px;width:300px;border-radius:16px;border:1px solid rgba(62,149,255,.04);background:#f4f4f4}.api-item img{height:24px;width:24px;padding:9px,9px,9px 9px}.api-item span{font-size:1rem;font-weight:400;color:#fff}.vendor-link{color:#000;text-overflow:ellipsis;font-family:Roboto;font-size:20px;font-style:normal;font-weight:500;padding-left:24px;letter-spacing:1.12px}.wrapper{display:flex;justify-content:center;align-items:center;width:42px;height:42px;flex-shrink:0;border-radius:8px;background:#e3dfdf}.dark .dark-mode-aware{background:#1a283b}.dark .wrapper{background-color:#364150}.dark .vendor-link{color:#fff;text-overflow:ellipsis;font-family:Roboto;font-size:20px;font-style:normal;font-weight:500;padding-left:24px;letter-spacing:1.12px}.flow-table,.table{width:100%;overflow-x:auto}.integrations-table table,.table table{border-collapse:collapse;text-align:left}.table table{width:100%}.table td,.table th{padding:8px 12px;text-align:left;border-bottom:1px solid #ddd}table{display:table;max-width:90%;margin:20px auto}.integrations-table table{border-style:solid;max-width:fit-content;table-layout:fixed;align-items:left;border-color:#000}.integrations-table code a{pointer-events:none;text-decoration:none;color:var(--ifm-table-cell-color);cursor:default}.integrations-table th:first-child{width:fit-content}.integrations-table th:second-child{width:50%;padding-right:10px}#var-table th:first-child{width:25%}#var-table th:nth-child(2){width:50%}.flow-table td{line-height:1.5;vertical-align:middle}.flow-table table,.table-functions{border-collapse:collapse;width:100%;max-width:100%;text-align:left;table-layout:fixed}.flow-table table{border-style:solid;align-items:left}.flow-table td,.flow-table th{width:25%;height:25%;border:1px solid #cccccc7f;padding:8px;text-align:left}.table-functions{border-style:hidden}.footer-container{display:flex;flex-direction:row;justify-content:space-between;width:100%;margin-top:100px;align-items:center}.footer-icons{display:flex;gap:32px}.footer-title{font-family:Roboto;font-size:12px;font-style:normal;font-weight:400;line-height:16px}.footer-display{display:flex;flex-direction:row}.flow-control{display:flex}@media (max-width:767px){.hero{flex-wrap:nowrap;flex-direction:column;justify-content:center;text-align:center;padding:1.5rem;height:auto;background-size:cover}.hero h1{font-size:2.5rem;font-weight:700;margin-bottom:1.5rem;color:#000}.hero,.hero-content{align-items:center}br{display:none}.paragraph{font-size:20px;margin-inline-start:30px}.search-bar input{width:fit-content}#api-grid{grid-column-gap:1rem;grid-row-gap:1rem;grid-template-rows:auto;grid-template-columns:1fr 1fr;display:grid;justify-items:flex-start}.api-item{display:flex;padding:var(--Sizes-Padding-Possitive-10-px, 10px) var(--Sizes-Padding-Possitive-16-px, 10px);height:100px;width:180px;justify-content:flex-start}.vendor-link{font-size:15px;padding-left:15px}.iframe{max-height:100%;height:unset;border-radius:32px}.iframe-wrapper{display:block;position:relative;max-height:200px;border-radius:32px}.iframe-media{align-items:center;flex-direction:column;justify-content:center;position:absolute;height:100%;width:100%;display:flex;backdrop-filter:blur(.5em);background-color:rgba(34,33,38,.8);border-radius:32px}.table-functions th:first-child{width:17%}}@media (max-width:996px){.hero{flex-direction:column;justify-content:center;text-align:center;padding:1.5rem;height:auto;background-size:cover}.hero h1{font-size:2.5rem;font-weight:700;margin-bottom:1.5rem;color:#000}.hero,.hero-content{align-items:center}br{display:none}.paragraph{font-size:20px;margin-inline-start:30px}.search-bar input{width:fit-content}#api-grid{grid-column-gap:1rem;grid-row-gap:1rem;grid-template-rows:auto;grid-template-columns:1fr 1fr;display:grid;justify-items:flex-start}.api-item{display:flex;padding:var(--Sizes-Padding-Possitive-10-px, 10px) var(--Sizes-Padding-Possitive-16-px, 10px);height:100px;width:180px;justify-content:flex-start}.vendor-link{font-size:15px;padding-left:15px}}"}],"page":{"pagePath":"docs/api/blink-rest-api","slug":"/docs/api/blink-rest-api","pageMetadata":{"title":"Blink REST API","description":"Reference documentation for the Blink REST API, including authentication, endpoints, and usage examples.","href":"/docs/api/blink-rest-api"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Reference documentation for the Blink REST API, including authentication, endpoints, and usage examples.\"\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];function _createMdxContent(props){const _components={code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Frame,Heading,OptimizedImage,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(_components.p,{children:`Send every API request to your own Blink tenant’s host:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://\u003cyour-tenant>.app.blinkops.com/api/v1`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`For example, if you log in to Blink at `,_jsx(_components.code,{children:`https://a1234.app.blinkops.com`}),`, your base URL is `,_jsx(_components.code,{children:`https://a1234.app.blinkops.com/api/v1`}),`. You can find your tenant name in your browser’s address bar when you’re logged in to Blink.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Don’t send requests to `,_jsx(_components.code,{children:`app.blinkops.com`}),` without your tenant name in front of it, or to another tenant’s host. The request returns `,_jsx(_components.strong,{children:`401 Unauthorized`}),`, even with a valid API key, because the key belongs to your tenant.`]})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`The code samples on each endpoint page use `,_jsx(_components.code,{children:`\u003cyour-tenant>`}),` as a placeholder. Before using `,_jsx(_components.strong,{children:`Try it`}),`, enter your tenant name in the `,_jsx(_components.strong,{children:`tenant`}),` server field.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`All requests to the Blink API require authentication.`}),`\n`,_jsx(Heading,{level:`3`,id:`generate-an-api-key`,children:`Generate an API Key`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:`Log in to your BlinkOps account and navigate to the API Keys page.`}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_1.png?fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=c1a412419665017f2d4caf95d9ace53e`,\"data-og-width\":`1162`,width:`1162`,\"data-og-height\":`868`,height:`868`,\"data-path\":`img/API/create_api_key_1.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_1.png?w=280\u0026fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=809c6376a2d0c8fc698b69329ae5a04e 280w, https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_1.png?w=560\u0026fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=8c95dda32ea512f21ef4833ac490f4ab 560w, https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_1.png?w=840\u0026fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=b699e53f317f77aaca02673aa63db366 840w, https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_1.png?w=1100\u0026fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=e4a044c112dbac727a0665e2a8790c5e 1100w, https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_1.png?w=1650\u0026fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=e5282be5f97e106622802eb4bada30ea 1650w, https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_1.png?w=2500\u0026fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=eab8c3414a1a8bfeeb71c18fe117b74f 2500w`})}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:`Copy one of the existing API keys or create a new one.`}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_2.png?fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=9ec69650ef7f1ef9ffc0a383905a049b`,\"data-og-width\":`2790`,width:`2790`,\"data-og-height\":`1442`,height:`1442`,\"data-path\":`img/API/create_api_key_2.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_2.png?w=280\u0026fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=0b3f9b18d20c5db0ad2de7aac023df21 280w, https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_2.png?w=560\u0026fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=486aeb7daea2a0bd0b6ce708c1e1ada9 560w, https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_2.png?w=840\u0026fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=1ff77ba1e907354ed905f30a5d34a53c 840w, https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_2.png?w=1100\u0026fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=0e49efd3c9a7c337611c9f6add317907 1100w, https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_2.png?w=1650\u0026fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=151ae4acada3ec91846579b137494c5f 1650w, https://mintcdn.com/blinkops-2/TqQZZZpDuOn7Wlvq/img/API/create_api_key_2.png?w=2500\u0026fit=max\u0026auto=format\u0026n=TqQZZZpDuOn7Wlvq\u0026q=85\u0026s=499819ed58e31c55508e002463047379 2500w`})}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:`Add the generated key to your request headers as BLINK-API-KEY.`}),`\n`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`using-an-api-key`,children:`Using an API Key`}),`\n`,_jsx(_components.p,{children:`Each request sent to the REST API must be authenticated using an API key, included in the BLINK-API-KEY header.`}),`\n`,_jsx(_components.p,{children:`For example:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -L`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` 'https://\u003cyour-tenant>.app.blinkops.com/api/v1/playbooks/33168bb7-a395-47c9-ba7a-d44b649940dc/execute'`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`'Accept: application/json'`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`'BLINK-API-KEY: h4536jlkh345l456l35y4543l5ls'`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`limits`,children:`Limits`}),`\n`,_jsx(_components.p,{children:`Blink supports a maximum of 1000 records per page.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Blink REST API","description":"Reference documentation for the Blink REST API, including authentication, endpoints, and usage examples.","href":"/docs/api/blink-rest-api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[{"title":"Generate an API Key","slug":"generate-an-api-key","depth":3,"children":[]},{"title":"Using an API Key","slug":"using-an-api-key","depth":3,"children":[]}]},{"title":"Limits","slug":"limits","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"blinkops-2","siteName":"BlinkOps Documentation","title":"Blink REST API - BlinkOps Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-15T08:19:58.469Z","originalFileLocation":"docs/api/blink-rest-api.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=\"Reference documentation for the Blink REST API, including authentication, endpoints, and usage examples.\">\u003cmeta data-mint-head name=\"application-name\" content=\"BlinkOps Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/blinkops-2/7G_DZOlCBlov2A1k/_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=\"/mintlify-assets/_mintlify/favicons/blinkops-2/7G_DZOlCBlov2A1k/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/blinkops-2/7G_DZOlCBlov2A1k/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/blinkops-2/7G_DZOlCBlov2A1k/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/blinkops-2/7G_DZOlCBlov2A1k/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/blinkops-2/7G_DZOlCBlov2A1k/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/blinkops-2/7G_DZOlCBlov2A1k/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/blinkops-2/7G_DZOlCBlov2A1k/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/blinkops-2/7G_DZOlCBlov2A1k/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Blink REST API - BlinkOps Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reference documentation for the Blink REST API, including authentication, endpoints, and usage examples.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BlinkOps Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.blinkops.com/docs/api/blink-rest-api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://blinkops-2.mintlify.app/_mintlify/api/og/v2?division=API\u0026amp;title=Blink+REST+API\u0026amp;description=Reference+documentation+for+the+Blink+REST+API%2C+including+authentication%2C+endpoints%2C+and+usage+examples.\u0026amp;theme=5f867c4b3d6ce5e7185a453d\u0026amp;signature=c378d00ad4003dfd0fc1fc0ed14b3eae37869b93d6e7693b0b4bd0ee7f5d7f3d\">\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=\"Blink REST API - BlinkOps Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reference documentation for the Blink REST API, including authentication, endpoints, and usage examples.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://blinkops-2.mintlify.app/_mintlify/api/og/v2?division=API\u0026amp;title=Blink+REST+API\u0026amp;description=Reference+documentation+for+the+Blink+REST+API%2C+including+authentication%2C+endpoints%2C+and+usage+examples.\u0026amp;theme=5f867c4b3d6ce5e7185a453d\u0026amp;signature=c378d00ad4003dfd0fc1fc0ed14b3eae37869b93d6e7693b0b4bd0ee7f5d7f3d\">\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=\"/mintlify-assets/_mintlify/favicons/blinkops-2/7G_DZOlCBlov2A1k/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BlinkOps Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1f7ef2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.blinkops.com/docs/api/blink-rest-api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/blink-rest-api.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.blinkops.com/#organization\",\"name\":\"BlinkOps Documentation\",\"url\":\"https://docs.blinkops.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/blinkops-2/br6cLdqXY9MZvLgO/logo/light.svg?fit=max\u0026auto=format\u0026n=br6cLdqXY9MZvLgO\u0026q=85\u0026s=55c0663d06bf9395563193d3a5259b7a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.blinkops.com#website\",\"name\":\"BlinkOps Documentation\",\"url\":\"https://docs.blinkops.com\",\"publisher\":{\"@id\":\"https://docs.blinkops.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.blinkops.com/docs/api/blink-rest-api#webpage\",\"url\":\"https://docs.blinkops.com/docs/api/blink-rest-api\",\"name\":\"Blink REST API\",\"description\":\"Reference documentation for the Blink REST API, including authentication, endpoints, and usage examples.\",\"dateModified\":\"2026-10-15T08:19:58.469Z\",\"isPartOf\":{\"@id\":\"https://docs.blinkops.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.blinkops.com/docs/api/blink-rest-api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.blinkops.com/docs/api/blink-rest-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API\",\"item\":\"https://docs.blinkops.com/docs/api/api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Blink REST API\",\"item\":\"https://docs.blinkops.com/docs/api/blink-rest-api\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.blinkops.com/docs/api/blink-rest-api#article\",\"headline\":\"Blink REST API\",\"name\":\"Blink REST API\",\"description\":\"Reference documentation for the Blink REST API, including authentication, endpoints, and usage examples.\",\"url\":\"https://docs.blinkops.com/docs/api/blink-rest-api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.blinkops.com/docs/api/blink-rest-api#webpage\"},\"dateModified\":\"2026-10-15T08:19:58.469Z\",\"publisher\":{\"@id\":\"https://docs.blinkops.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.blinkops.com#website\"}}]}\u003c/script>","siteName":"BlinkOps Documentation","nav":{"global":null,"tabs":[{"tab":"Home","groups":[{"group":"Get Started","pages":[{"mode":"custom","title":null,"href":"/home"}]},{"group":"API","pages":[{"title":"APIs","description":"Overview of the Blink API and how to use it to automate and integrate with the Blink platform programmatically.","href":"/docs/api/api"},{"title":"Blink REST API","href":"/docs/api/blink-rest-api"},{"title":"RQL","description":"Learn how to use Blink's Resource Query Language (RQL) to filter and query resources across your workspace.","href":"/docs/api/rql"}]},{"group":"Connections","pages":[{"openapi":"get /connection_types","title":"List connection types","href":"/docs/api/connections/list-connection-types"},{"openapi":"get /workspace/{ws_id}/connections","title":"List connections","href":"/docs/api/connections/list-connections"},{"openapi":"post /workspace/{ws_id}/connections","title":"Create connection","href":"/docs/api/connections/create-connection"},{"openapi":"get /workspace/{ws_id}/connections/{id}","title":"Gets a Connection by id","href":"/docs/api/connections/gets-a-connection-by-id"},{"openapi":"put /workspace/{ws_id}/connections/{id}","title":"Edit connection","href":"/docs/api/connections/edit-connection"},{"openapi":"delete /workspace/{ws_id}/connections/{id}","title":"Delete Connection","href":"/docs/api/connections/delete-connection"}]},{"group":"Groups","pages":[{"openapi":"get /group/{id}","title":"List group users","href":"/docs/api/groups/list-group-users"},{"openapi":"delete /group/{id}","title":"Delete group","href":"/docs/api/groups/delete-group"},{"openapi":"post /group/{id}/add_users","title":"Add users to group","href":"/docs/api/groups/add-users-to-group"},{"openapi":"post /group/{id}/remove_users","title":"Remove users from group","href":"/docs/api/groups/remove-users-from-group"},{"openapi":"get /workspace/{ws_id}/table/sys_groups","title":"Get groups","href":"/docs/api/groups/get-groups"},{"openapi":"post /workspace/{ws_id}/table/sys_groups","title":"Create group","href":"/docs/api/groups/create-group"}]},{"group":"Workflows","pages":[{"openapi":"get /workspace/{ws_id}/playbooks","title":"List playbooks with optional filtering","href":"/docs/api/workflows/list-playbooks-with-optional-filtering"},{"openapi":"post /workspace/{ws_id}/playbooks","title":"Create a new playbook","href":"/docs/api/workflows/create-a-new-playbook"},{"openapi":"get /workspace/{ws_id}/playbooks/{id}","title":"Get a playbook by its ID","href":"/docs/api/workflows/get-a-playbook-by-its-id"},{"openapi":"delete /workspace/{ws_id}/playbooks/{id}","title":"Delete a playbook by its ID","href":"/docs/api/workflows/delete-a-playbook-by-its-id"},{"openapi":"put /workspace/{ws_id}/playbooks/{id}/edit","title":"Edit playbook metadata","href":"/docs/api/workflows/edit-playbook-metadata"},{"openapi":"post /workspace/{ws_id}/playbooks/get-playbooks-used-connections","title":"Get connections used by a list of playbooks","href":"/docs/api/workflows/get-connections-used-by-a-list-of-playbooks"},{"openapi":"post /workspace/{ws_id}/batch_copy","title":"Batch copy of playbooks to target workspace and pack","href":"/docs/api/workflows/batch-copy-of-playbooks-to-target-workspace-and-pack"},{"openapi":"post /workspace/{ws_id}/batch_move","title":"Batch move of playbooks to target workspace and pack","href":"/docs/api/workflows/batch-move-of-playbooks-to-target-workspace-and-pack"}]},{"group":"Portal Apps","pages":[{"openapi":"post /playbooks/{id}/portal_share","title":"Share portal app","href":"/docs/api/workflows/share-portal-app"},{"openapi":"post /playbooks/{id}/portal_unshare","title":"Un-share portal app","href":"/docs/api/workflows/un-share-portal-app"}]},{"group":"Workflow Versions","pages":[{"openapi":"get /workspace/{ws_id}/playbooks/{id}/versions","title":"List all versions metadata of a playbook","href":"/docs/api/workflows/list-all-versions-metadata-of-a-playbook"},{"openapi":"get /workspace/{ws_id}/playbooks/{id}/draft","title":"Get the latest draft playbook version for a playbook","href":"/docs/api/workflows/get-the-latest-draft-playbook-version-for-a-playbook"},{"openapi":"get /workspace/{ws_id}/playbooks/{id}/public","title":"Get the latest public playbook version for a playbook","href":"/docs/api/workflows/get-the-latest-public-playbook-version-for-a-playbook"},{"openapi":"get /workspace/{ws_id}/playbooks/{id}/version/{branch}/{version}","title":"Get a playbook version by branch and version number","href":"/docs/api/workflows/get-a-playbook-version-by-branch-and-version-number"}]},{"group":"Tenant","pages":[{"openapi":"get /tenant/entities","title":"Get tenant entities (users or groups)","href":"/docs/api/tenant/get-tenant-entities-users-or-groups"}]},{"group":"Roles","pages":[{"openapi":"get /tenant/roles","title":"List all available roles","href":"/docs/api/roles/list-all-available-roles"}]},{"group":"Users","pages":[{"openapi":"get /user/{id}/groups","title":"Get groups of user","href":"/docs/api/users/get-groups-of-user"},{"openapi":"delete /user/{id}/groups","title":"Remove a user from groups","href":"/docs/api/users/remove-a-user-from-groups"}]},{"group":"Action Templates","pages":[{"openapi":"get /workspace/{ws_id}/action_template","title":"Gets all custom template actions in a workspace","href":"/docs/api/action-templates/gets-all-custom-template-actions-in-a-workspace"}]},{"group":"Case Management","pages":[{"openapi":"get /workspace/{ws_id}/case_management/table/{table}","title":"List Records from Case Management Table","href":"/docs/api/case-management/list-records-from-case-management-table"},{"openapi":"get /workspace/{ws_id}/case_management/table/{table}/fields","title":"List Fields from Case Management Table","href":"/docs/api/case-management/list-fields-from-case-management-table"},{"openapi":"delete /workspace/{ws_id}/case_management/table/{table}/{id}","title":"Delete a Record from Case Management Table","href":"/docs/api/case-management/delete-a-record-from-case-management-table"},{"openapi":"put /workspace/{ws_id}/case_management/table/{table}/fields/{field}","title":"Update Field for Case Management Table","href":"/docs/api/case-management/update-field-for-case-management-table"},{"openapi":"post /workspace/{ws_id}/case_management/table/alerts","title":"Create an Alert","href":"/docs/api/case-management/create-an-alert"},{"openapi":"put /workspace/{ws_id}/case_management/table/alerts/{alert_id}","title":"Update an Alert","href":"/docs/api/case-management/update-an-alert"},{"openapi":"post /workspace/{ws_id}/case_management/table/attachments","title":"Create an Attachment","href":"/docs/api/case-management/create-an-attachment"},{"openapi":"put /workspace/{ws_id}/case_management/table/attachments/{attachment_id}","title":"Update an Attachment","href":"/docs/api/case-management/update-an-attachment"},{"openapi":"post /workspace/{ws_id}/case_management/table/cases","title":"Create a Case","href":"/docs/api/case-management/create-a-case"},{"openapi":"put /workspace/{ws_id}/case_management/table/cases/{case_id}","title":"Update a Case","href":"/docs/api/case-management/update-a-case"},{"openapi":"post /workspace/{ws_id}/case_management/table/observables","title":"Create an Observable","href":"/docs/api/case-management/create-an-observable"},{"openapi":"put /workspace/{ws_id}/case_management/table/observables/{observable_id}","title":"Update an Observable","href":"/docs/api/case-management/update-an-observable"},{"openapi":"post /workspace/{ws_id}/case_management/table/tasks","title":"Create a Task","href":"/docs/api/case-management/create-a-task"},{"openapi":"put /workspace/{ws_id}/case_management/table/tasks/{task_id}","title":"Update a Task","href":"/docs/api/case-management/update-a-task"}]},{"group":"Executions","pages":[{"openapi":"post /workspace/{ws_id}/playbooks/{id}/execute","title":"Execute a playbook","href":"/docs/api/workflows/execute-a-playbook"},{"openapi":"get /workspace/{ws_id}/executions","title":"List playbook executions with filtering","href":"/docs/api/executions/list-playbook-executions-with-filtering"},{"openapi":"get /workspace/{ws_id}/executions/{id}","title":"Get a playbook execution by its ID","href":"/docs/api/executions/get-a-playbook-execution-by-its-id"},{"openapi":"get /workspace/{ws_id}/executions/{id}/context/inputs","title":"Get the trigger event and input params of an execution","href":"/docs/api/executions/get-the-trigger-event-and-input-params-of-an-execution"},{"openapi":"get /workspace/{ws_id}/executions/{id}/outputs","title":"Get the outputs of an execution by its ID","href":"/docs/api/executions/get-the-outputs-of-an-execution-by-its-id"},{"openapi":"get /workspace/{ws_id}/executions/{id}/steps","title":"List step executions for a specified execution","href":"/docs/api/executions/list-step-executions-for-a-specified-execution"}]},{"group":"Playbook Publish Approval","pages":[{"openapi":"get /workspace/{ws_id}/get_approvers","title":"List playbook approvers","href":"/docs/api/playbook-publish-approval/list-playbook-approvers"},{"openapi":"get /workspace/{ws_id}/publish_approval_requests","title":"List playbook publish approval requests","href":"/docs/api/playbook-publish-approval/list-playbook-publish-approval-requests"}]},{"group":"Tables","pages":[{"openapi":"get /workspace/{ws_id}/table/{table}","title":"List Records from Table","href":"/docs/api/tables/list-records-from-table"},{"openapi":"put /workspace/{ws_id}/table/{table}/fields/{field}","title":"Updates Field for Table","href":"/docs/api/tables/updates-field-for-table"}]},{"group":"Workspaces","pages":[{"openapi":"get /workspaces/{ws_id}","title":"Get workspace details","href":"/docs/api/workspaces/get-workspace-details"},{"openapi":"post /workspaces/{ws_id}/{entity_type}/{entity_id}/role/{role}","title":"Assign a role to a user or group in a workspace","href":"/docs/api/workspaces/assign-a-role-to-a-user-or-group-in-a-workspace"},{"openapi":"post /workspaces/{ws_id}/entities","title":"Add entities to workspace","href":"/docs/api/workspaces/add-entities-to-workspace"},{"openapi":"put /workspaces/{ws_id}/settings","title":"Update the Workspace Settings","href":"/docs/api/workspaces/update-the-workspace-settings"},{"openapi":"get /user-workspaces","title":"List user workspaces","href":"/docs/api/authorization/list-user-workspaces"}]}]},{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/docs/getting-started/introduction"}]},{"tab":"Agents","pages":[{"title":"Agents","href":"/docs/agent-builder/agent-builder"}]},{"tab":"Workflows","pages":[{"title":"Workflows","href":"/docs/workflows/workflows"}]},{"tab":"Platform","pages":[{"title":"Platform","href":"/docs/blink-platform/blink-platform"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/docs/integrations/integrations"}]},{"tab":"Case Management","pages":[{"title":"Case Management","href":"/docs/case-management/case-management"}]}]},"title":"Blink REST API - BlinkOps Documentation","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-CIbhtp2j.js","DynamicMarkdown-CtpgKJwj.js","zoom-image-lightbox-CVZVK4hN.js","lightbox-handle-r17bVUz3.js"]}
