ActionType represents the type of action being performed on a resource
Granular ABAC actions, broken up by CRUD.
Name
Number
Description
ACTION_TYPE_UNSPECIFIED
0
ACTION_TYPE_INGEST_DATA
110
Create actions (reserving 100 for generic create)
ACTION_TYPE_CREATE_RUN
120
ACTION_TYPE_VIEW_DETAILS
200
Read actions Lowest-level read action type. If this is denied, all other read actions should be denied. Used for view/search/index metadata and overview details pages.
ACTION_TYPE_VIEW_DATA
205
Read telemetry data values from channels/runs/assets. Keep ACTION_TYPE_VIEW_DETAILS for non-telemetry “view details” style access.
ACTION_TYPE_EXPORT
210
ACTION_TYPE_EDIT_DETAILS
310
Update/Edit actions (reserving 300 for generic edit) Name, Description, Units
ACTION_TYPE_EDIT_TAGS
312
ACTION_TYPE_EDIT_METADATA
313
ACTION_TYPE_ARCHIVE
400
Delete actions
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Sift","description":"Explore how to accelerate mission-critical engineering with Sift","colors":{"primary":"#EE4220","light":"#ffffff","dark":"#EE4220"},"logo":{"light":"https://mintcdn.com/sift/GjoSEOjJnNg1VWOc/logo/light.svg?fit=max\u0026auto=format\u0026n=GjoSEOjJnNg1VWOc\u0026q=85\u0026s=56b616692038c18386a66c01ce95acf6","dark":"https://mintcdn.com/sift/GjoSEOjJnNg1VWOc/logo/dark.svg?fit=max\u0026auto=format\u0026n=GjoSEOjJnNg1VWOc\u0026q=85\u0026s=5ac0e74497a5ba2765add5b084a556f6"},"favicon":{"light":"https://mintcdn.com/sift/nJFUD-LAQQppRCC8/favicon.png?fit=max\u0026auto=format\u0026n=nJFUD-LAQQppRCC8\u0026q=85\u0026s=b625ac235c68cd471876135f85bdd8cb","dark":"https://mintcdn.com/sift/nJFUD-LAQQppRCC8/favicon-dark.png?fit=max\u0026auto=format\u0026n=nJFUD-LAQQppRCC8\u0026q=85\u0026s=2e037d2fc00056715396fadc69a01bf3"},"api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","go"]}},"appearance":{"default":"light"},"background":{"color":{"light":"#ffffff","dark":"#161616"}},"navbar":{"links":[{"href":"https://www.siftstack.com/#demo","label":"Get a demo"},{"href":"https://app.siftstack.com","label":"PubCloud"},{"href":"https://gov.siftstack.com","label":"GovCloud"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/sift-stack","github":"https://github.com/sift-stack/sift","youtube":"https://www.youtube.com/@Siftstack","x":"https://x.com/SiftStack"},"links":[{"header":"Contact","items":[{"label":"Weekly demo","href":"https://www.siftstack.com/weekly-demo"}]},{"header":"Industries","items":[{"label":"Aerospace","href":"https://www.siftstack.com/industry/aerospace"},{"label":"Transportation","href":"https://www.siftstack.com/industry/transportations"},{"label":"Robotics","href":"https://www.siftstack.com/industry/robotics"},{"label":"Defense","href":"https://www.siftstack.com/industry/defense"},{"label":"Energy","href":"https://www.siftstack.com/industry/energy"}]},{"header":"Company","items":[{"label":"Careers","href":"https://www.siftstack.com/career"},{"label":"Blogs","href":"https://www.siftstack.com/mission-critical"}]}]},"seo":{"metatags":{"canonical":"https://docs.siftstack.com"}},"fonts":{"heading":{"family":"IBM Plex Sans","weight":350},"body":{"family":"IBM Plex Sans","weight":350}},"integrations":{"ga4":{"measurementId":"G-L6ZXBZB1HC"}},"errors":{"404":{"redirect":false,"title":"Page not found","description":"[Sift | Docs](/)"}},"contextual":{"options":["copy","chatgpt"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/sift/3sefDvsBNl0lp9-k/images/curves.png?fit=max\u0026auto=format\u0026n=3sefDvsBNl0lp9-k\u0026q=85\u0026s=1bfd60e88ab39f485fad54767980a30c"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sift","hasAudioNarration":false,"actualSubdomain":"sift","customDomains":["docs.siftstack.com"],"gitSource":{"type":"github","owner":"sift-stack","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":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":"6afe53bc8c149e788edca31e","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Reference","count":447},{"language":"default","tag":"API","count":428},{"language":"default","tag":"REST","count":360},{"language":"default","tag":"Documentation","count":81},{"language":"default","tag":"gRPC","count":59},{"language":"default","tag":"Learning path","count":38},{"language":"default","tag":"FamilyService","count":28},{"language":"default","tag":"ResourceAttributeService","count":26},{"language":"default","tag":"v2","count":24},{"language":"default","tag":"RuleService","count":24}],"searchSettings":{"maxResults":7,"isFiltersEnabled":true}},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":false,"enableAskAiSearchBar":false,"deflection":{"enabled":true,"email":"support@siftstack.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":".callout span strong{color:inherit!important}ol ol{list-style-type:numeric!important}table th{text-align:left}strong,b{font-weight:650!important}.new{color:#47b881}.improvement{color:#1070ca}.restored{color:#f7c948}.card.block .prose a.link,.card.block a.link,.card a.link{color:var(--color-primary)!important;text-decoration-line:underline!important;text-decoration-color:#ee4220!important;text-underline-offset:3px!important;font-weight:normal!important}.card.block .prose a.link:hover,.card.block a.link:hover{text-decoration-thickness:2px!important;text-decoration-color:#ee4220!important}body:has(#is-home-page) h1#page-title{font-size:3.5rem!important;line-height:1.1!important;font-weight:300!important}.navbar-link a[href=\"https://app.siftstack.com\"],.navbar-link a[href=\"https://gov.siftstack.com\"]{background-color:rgb(var(--primary))!important;color:#ffffff!important}.navbar-link a[href=\"https://app.siftstack.com\"]:hover,.navbar-link a[href=\"https://gov.siftstack.com\"]:hover{background-color:rgb(var(--primary))!important;color:#ffffff!important;opacity:0.9}.mermaid-diagram .edgeLabel rect{fill:#ffffff!important;opacity:1!important}html.dark .mermaid-diagram .edgeLabel rect{fill:#161616!important}.sift-svg-icon{display:inline-block;height:1em;vertical-align:-0.125em;background-color:#EE4220;-webkit-mask:var(--sift-icon) center / contain no-repeat;mask:var(--sift-icon) center / contain no-repeat}html.dark .sift-svg-icon{background-color:#ffffff}.sift-svg-icon-calculated-channel{--sift-icon: url(\"/icons/calculated-channel.svg\");width:1.84em}.sift-svg-icon-zoom-xy{--sift-icon: url(\"/icons/zoom-xy.svg\");width:1.25em}"}]}
{"page":{"pagePath":"api/reference/protocol-buffers/action_type","slug":"/api/reference/protocol-buffers/action_type","pageMetadata":{"title":"action_type","description":"sift/common/v1/action_type.proto","href":"/api/reference/protocol-buffers/action_type"},"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: \"sift/common/v1/action_type.proto\"\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={em:`em`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(`a`,{name:`sift_common_v1_action_type-proto`}),`\n`,_jsx(`a`,{name:`sift_common_v1_action_type-proto-services`}),`\n`,_jsx(Heading,{level:`2`,id:`services`,children:`Services`}),`\n`,_jsx(_components.p,{children:_jsx(_components.em,{children:`RPC methods exposed by this API.`})}),`\n`,_jsx(`a`,{name:`sift_common_v1_action_type-proto-messages`}),`\n`,_jsx(Heading,{level:`2`,id:`messages`,children:`Messages`}),`\n`,_jsx(_components.p,{children:_jsx(_components.em,{children:`Data models used across requests/responses.`})}),`\n`,_jsx(`a`,{name:`sift_common_v1_action_type-proto-enums`}),`\n`,_jsx(Heading,{level:`2`,id:`enums`,children:`Enums`}),`\n`,_jsx(_components.p,{children:_jsx(_components.em,{children:`Allowed constant values used in message fields.`})}),`\n`,_jsx(Heading,{level:`3`,id:`actiontype`,children:`ActionType`}),`\n`,_jsx(_components.p,{children:`ActionType represents the type of action being performed on a resource\nGranular ABAC actions, broken up by CRUD.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Name`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Number`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`ACTION_TYPE_UNSPECIFIED`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`0`}),_jsx(_components.td,{style:{textAlign:`left`}})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`ACTION_TYPE_INGEST_DATA`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`110`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Create actions (reserving 100 for generic create)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`ACTION_TYPE_CREATE_RUN`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`120`}),_jsx(_components.td,{style:{textAlign:`left`}})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`ACTION_TYPE_VIEW_DETAILS`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`200`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Read actions Lowest-level read action type. If this is denied, all other read actions should be denied. Used for view/search/index metadata and overview details pages.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`ACTION_TYPE_VIEW_DATA`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`205`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Read telemetry data values from channels/runs/assets. Keep ACTION_TYPE_VIEW_DETAILS for non-telemetry “view details” style access.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`ACTION_TYPE_EXPORT`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`210`}),_jsx(_components.td,{style:{textAlign:`left`}})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`ACTION_TYPE_EDIT_DETAILS`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`310`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Update/Edit actions (reserving 300 for generic edit) Name, Description, Units`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`ACTION_TYPE_EDIT_TAGS`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`312`}),_jsx(_components.td,{style:{textAlign:`left`}})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`ACTION_TYPE_EDIT_METADATA`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`313`}),_jsx(_components.td,{style:{textAlign:`left`}})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`ACTION_TYPE_ARCHIVE`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`400`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Delete actions`})]})]})]})]})}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":{"config":{},"pageMetadata":{"title":"action_type","description":"sift/common/v1/action_type.proto","href":"/api/reference/protocol-buffers/action_type"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Services","slug":"services","depth":2,"children":[]},{"title":"Messages","slug":"messages","depth":2,"children":[]},{"title":"Enums","slug":"enums","depth":2,"children":[{"title":"ActionType","slug":"actiontype","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"sift","siteName":"Sift","title":"action_type - Sift","relatedPagesConfig":{"enabled":false,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T21:22:10.019Z","originalFileLocation":"api/reference/protocol-buffers/action_type.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=\"light\"}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=\"sift/common/v1/action_type.proto\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sift\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sift/isjiokFxlGaA1u5N/_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/sift/isjiokFxlGaA1u5N/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sift/isjiokFxlGaA1u5N/_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/sift/isjiokFxlGaA1u5N/_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/sift/isjiokFxlGaA1u5N/_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/sift/isjiokFxlGaA1u5N/_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/sift/isjiokFxlGaA1u5N/_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/sift/isjiokFxlGaA1u5N/_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/sift/isjiokFxlGaA1u5N/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"action_type - Sift\">\u003cmeta data-mint-head property=\"og:description\" content=\"sift/common/v1/action_type.proto\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sift\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.siftstack.com/api/reference/protocol-buffers/action_type\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sift.mintlify.site/_mintlify/api/og/v2?division=gRPC\u0026amp;title=action_type\u0026amp;description=sift%2Fcommon%2Fv1%2Faction_type.proto\u0026amp;theme=e5bcfbc9b291a6a77d091a74\u0026amp;signature=caaeee5806368ccc77cc0fda6aa553e54af5c5d1c23b0763fb2992f7e7152068\">\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=\"action_type - Sift\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"sift/common/v1/action_type.proto\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sift.mintlify.site/_mintlify/api/og/v2?division=gRPC\u0026amp;title=action_type\u0026amp;description=sift%2Fcommon%2Fv1%2Faction_type.proto\u0026amp;theme=e5bcfbc9b291a6a77d091a74\u0026amp;signature=caaeee5806368ccc77cc0fda6aa553e54af5c5d1c23b0763fb2992f7e7152068\">\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/sift/isjiokFxlGaA1u5N/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sift\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#EE4220\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.siftstack.com/api/reference/protocol-buffers/action_type\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/reference/protocol-buffers/action_type.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.siftstack.com/#organization\",\"name\":\"Sift\",\"url\":\"https://docs.siftstack.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sift/GjoSEOjJnNg1VWOc/logo/light.svg?fit=max\u0026auto=format\u0026n=GjoSEOjJnNg1VWOc\u0026q=85\u0026s=56b616692038c18386a66c01ce95acf6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.siftstack.com#website\",\"name\":\"Sift\",\"url\":\"https://docs.siftstack.com\",\"publisher\":{\"@id\":\"https://docs.siftstack.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.siftstack.com/api/reference/protocol-buffers/action_type#webpage\",\"url\":\"https://docs.siftstack.com/api/reference/protocol-buffers/action_type\",\"name\":\"action_type\",\"description\":\"sift/common/v1/action_type.proto\",\"dateModified\":\"2026-11-17T21:22:10.019Z\",\"isPartOf\":{\"@id\":\"https://docs.siftstack.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.siftstack.com/api/reference/protocol-buffers/action_type#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.siftstack.com/api/reference/protocol-buffers/action_type#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.siftstack.com/api-reference/annotationlogservice/createannotationlog\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"gRPC\",\"item\":\"https://docs.siftstack.com/api/reference/protocol-buffers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"action_type\",\"item\":\"https://docs.siftstack.com/api/reference/protocol-buffers/action_type\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.siftstack.com/api/reference/protocol-buffers/action_type#article\",\"headline\":\"action_type\",\"name\":\"action_type\",\"description\":\"sift/common/v1/action_type.proto\",\"url\":\"https://docs.siftstack.com/api/reference/protocol-buffers/action_type\",\"mainEntityOfPage\":{\"@id\":\"https://docs.siftstack.com/api/reference/protocol-buffers/action_type#webpage\"},\"dateModified\":\"2026-11-17T21:22:10.019Z\",\"publisher\":{\"@id\":\"https://docs.siftstack.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.siftstack.com#website\"}}]}\u003c/script>","agentPointerHref":"/api/reference/protocol-buffers/action_type.md","siteName":"Sift","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/documentation/home"}]},{"tab":"Learning path","pages":[{"title":"Learning path","href":"/learning-path/overview"}]},{"tab":"Tutorials","pages":[{"title":"Tutorials","href":"/tutorials/overview"}]},{"tab":"API","groups":[{"group":" ","pages":[{"sidebarTitle":"Overview","title":"API","mode":"wide","href":"/api/overview"}]},{"group":"Authenticate","icon":"shield-keyhole","pages":[{"title":"Authenticate with the API","href":"/api/authenticate/authenticate-with-the-api"}]},{"group":"Clients","icon":"code-simple","pages":[{"title":"Generate a gRPC client with Buf","href":"/api/clients/generate-a-client-with-buf"}]},{"group":"Review","icon":"magnifying-glass","pages":[{"title":"Create, preview, and evaluate Rules programmatically","href":"/api/review/evaluate-rules"},{"title":"Create, preview, and evaluate Ad Hoc Rules","href":"/api/review/manage-ad-hoc-rules"}]},{"group":"Export","icon":"file-export","pages":[{"title":"Export data programmatically","href":"/api/export/export-data-programmatically"},{"title":"Export data to MATLAB","href":"/api/export/export-data-to-matlab"},{"title":"Build your own live telemetry display","href":"/api/export/build-your-own-live-telemetry-display"}]},{"group":"Attachments","icon":"paperclip","pages":[{"title":"Manage Run file attachments","href":"/api/attachments/manage-run-file-attachments"}]},{"group":"Reference","icon":"page","pages":[{"group":"REST","expanded":false,"pages":[{"group":"AnnotationLogService","pages":[{"title":"CreateAnnotationLog","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/annotations/{annotationId}/logs","href":"/api-reference/annotationlogservice/createannotationlog"},{"title":"DeleteAnnotationLog","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/annotations/{annotationId}/logs/{annotationLogId}","href":"/api-reference/annotationlogservice/deleteannotationlog"},{"group":"ListAnnotationLogs","pages":[{"title":"GET /api/v1/annotation-logs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/annotation-logs","href":"/api-reference/annotationlogservice/get-apiv1annotation-logs"},{"title":"by annotationId","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/annotations/{annotationId}/logs","href":"/api-reference/annotationlogservice/by-annotationid"}]}]},{"group":"AnnotationService","pages":[{"title":"ArchiveAnnotation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/annotations/{annotationId}:archive","href":"/api-reference/annotationservice/archiveannotation"},{"title":"BatchArchiveAnnotations","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/annotations:batchArchive","href":"/api-reference/annotationservice/batcharchiveannotations"},{"title":"BatchDeleteAnnotation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/annotations:batchDelete","href":"/api-reference/annotationservice/batchdeleteannotation"},{"title":"BatchUnarchiveAnnotations","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/annotations:batchUnarchive","href":"/api-reference/annotationservice/batchunarchiveannotations"},{"title":"CreateAnnotation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/annotations","href":"/api-reference/annotationservice/createannotation"},{"title":"DeleteAnnotation","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/annotations/{annotationId}","href":"/api-reference/annotationservice/deleteannotation"},{"title":"GetAnnotation","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/annotations/{annotationId}","href":"/api-reference/annotationservice/getannotation"},{"title":"ListAnnotation","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/annotations","href":"/api-reference/annotationservice/listannotation"},{"title":"UnarchiveAnnotation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/annotations/{annotationId}:unarchive","href":"/api-reference/annotationservice/unarchiveannotation"},{"title":"UpdateAnnotation","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/annotations","href":"/api-reference/annotationservice/updateannotation"}]},{"group":"ApiKeyService","pages":[{"title":"ApiKeyOrganization","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/api-keys/organization","href":"/api-reference/apikeyservice/apikeyorganization"},{"title":"CreateApiKey","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/api-keys","href":"/api-reference/apikeyservice/createapikey"},{"title":"DeleteApiKey","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v2/api-keys/{apiKeyId}","href":"/api-reference/apikeyservice/deleteapikey"},{"title":"ListApiKeys","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/api-keys","href":"/api-reference/apikeyservice/listapikeys"}]},{"group":"ArtifactService","pages":[{"title":"ArchiveArtifact","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/artifacts/{artifactId}/archive","href":"/api-reference/artifactservice/archiveartifact"},{"title":"BatchArchiveArtifacts","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/artifacts:batchArchive","href":"/api-reference/artifactservice/batcharchiveartifacts"},{"title":"BatchUnarchiveArtifacts","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/artifacts:batchUnarchive","href":"/api-reference/artifactservice/batchunarchiveartifacts"},{"title":"CreateArtifact","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/artifacts","href":"/api-reference/artifactservice/createartifact"},{"title":"GetArtifact","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/artifacts/{artifactId}","href":"/api-reference/artifactservice/getartifact"},{"title":"LinkArtifactToConversation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/artifacts/{artifactId}/conversations/{conversationId}:link","href":"/api-reference/artifactservice/linkartifacttoconversation"},{"title":"ListArtifactLinks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/artifacts/{artifactId}/links","href":"/api-reference/artifactservice/listartifactlinks"},{"group":"ListArtifactVersions","pages":[{"title":"GET /api/v1/artifact-versions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/artifact-versions","href":"/api-reference/artifactservice/get-apiv1artifact-versions"},{"title":"by artifactId","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/artifacts/{artifactId}/versions","href":"/api-reference/artifactservice/by-artifactid"}]},{"title":"ListArtifacts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/artifacts","href":"/api-reference/artifactservice/listartifacts"},{"title":"PromoteArtifactVersion","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/artifacts/{artifactId}/versions/{artifactVersionId}:promote","href":"/api-reference/artifactservice/promoteartifactversion"},{"title":"UnarchiveArtifact","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/artifacts/{artifactId}/unarchive","href":"/api-reference/artifactservice/unarchiveartifact"},{"title":"UnlinkArtifactFromConversation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/artifacts/{artifactId}/conversations/{conversationId}:unlink","href":"/api-reference/artifactservice/unlinkartifactfromconversation"},{"title":"UpdateArtifact","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/artifacts/{artifactId}","href":"/api-reference/artifactservice/updateartifact"}]},{"group":"AssetService","pages":[{"title":"ArchiveAsset","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/assets/{assetId}/archive","href":"/api-reference/assetservice/archiveasset"},{"title":"CreateAsset","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/assets","href":"/api-reference/assetservice/createasset"},{"title":"DeleteAsset","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/assets/{assetId}","href":"/api-reference/assetservice/deleteasset"},{"title":"GetAsset","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/assets/{assetId}","href":"/api-reference/assetservice/getasset"},{"title":"ListAssets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/assets","href":"/api-reference/assetservice/listassets"},{"title":"UpdateAsset","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/assets","href":"/api-reference/assetservice/updateasset"}]},{"group":"AutomationService","pages":[{"title":"CreateAutomationTrigger","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/automation-triggers","href":"/api-reference/automationservice/createautomationtrigger"},{"title":"DeleteAutomationTrigger","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/automation-triggers/{automationTriggerId}","href":"/api-reference/automationservice/deleteautomationtrigger"},{"title":"GetAutomationTrigger","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/automation-triggers/{automationTriggerId}","href":"/api-reference/automationservice/getautomationtrigger"},{"title":"ListAutomationTriggeredEvents","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/automation-triggered-events","href":"/api-reference/automationservice/listautomationtriggeredevents"},{"title":"ListAutomationTriggers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/automation-triggers","href":"/api-reference/automationservice/listautomationtriggers"},{"title":"UpdateAutomationTrigger","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/automation-triggers","href":"/api-reference/automationservice/updateautomationtrigger"}]},{"group":"CalculatedChannelService","pages":[{"title":"BatchResolveCalculatedChannel","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/calculated-channels/resolve:batch","href":"/api-reference/calculatedchannelservice/batchresolvecalculatedchannel"},{"title":"CreateCalculatedChannel","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/calculated-channels","href":"/api-reference/calculatedchannelservice/createcalculatedchannel"},{"group":"GetCalculatedChannel","pages":[{"title":"GetCalculatedChannel by calculatedChannelId","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/calculated-channels/{calculatedChannelId}","href":"/api-reference/calculatedchannelservice/getcalculatedchannel-by-calculatedchannelid"},{"title":"GetCalculatedChannel by organizationId, clientKey","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/organizations/{organizationId}/calculated-channels/{clientKey}","href":"/api-reference/calculatedchannelservice/getcalculatedchannel-by-organizationid-clientkey"}]},{"title":"GetCalculatedChannelDependents","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/calculated-channels/dependents","href":"/api-reference/calculatedchannelservice/getcalculatedchanneldependents"},{"title":"GetCalculatedChannelVersions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/calculated-channels/versions","href":"/api-reference/calculatedchannelservice/getcalculatedchannelversions"},{"group":"ListCalculatedChannelVersions","pages":[{"title":"ListCalculatedChannelVersions by calculatedChannelId","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/calculated-channels/{calculatedChannelId}/versions","href":"/api-reference/calculatedchannelservice/listcalculatedchannelversions-by-calculatedchannelid"},{"title":"ListCalculatedChannelVersions by organizationId, clientKey","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/organizations/{organizationId}/calculated-channels/{clientKey}/versions","href":"/api-reference/calculatedchannelservice/listcalculatedchannelversions-by-organizationid-clientkey"}]},{"title":"ListCalculatedChannels","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/calculated-channels","href":"/api-reference/calculatedchannelservice/listcalculatedchannels"},{"title":"ListResolvedCalculatedChannels","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/calculated-channels/resolved","href":"/api-reference/calculatedchannelservice/listresolvedcalculatedchannels"},{"title":"ResolveCalculatedChannel","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/calculated-channels/resolve","href":"/api-reference/calculatedchannelservice/resolvecalculatedchannel"},{"title":"UpdateCalculatedChannel","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v2/calculated-channels","href":"/api-reference/calculatedchannelservice/updatecalculatedchannel"}]},{"group":"CalculatedChannelsService","pages":[{"title":"ListExpressionIdentifiers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/calculated-channels:expression-identifiers","href":"/api-reference/calculatedchannelsservice/listexpressionidentifiers"},{"title":"ValidateExpression","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/calculated-channels:validate-expression","href":"/api-reference/calculatedchannelsservice/validateexpression"}]},{"group":"CampaignService","pages":[{"title":"CreateCampaign","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns","href":"/api-reference/campaignservice/createcampaign"},{"group":"GetCampaign","pages":[{"title":"by campaignId","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campaigns/{campaignId}","href":"/api-reference/campaignservice/by-campaignid"},{"title":"by organizationId, clientKey","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organizationId}/campaigns/{clientKey}","href":"/api-reference/campaignservice/by-organizationid-clientkey"}]},{"title":"GetCampaignReportSummaries","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns:report-summaries","href":"/api-reference/campaignservice/getcampaignreportsummaries"},{"title":"ListCampaignAnnotations","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campaigns/{campaignId}/annotations","href":"/api-reference/campaignservice/listcampaignannotations"},{"title":"ListCampaigns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campaigns","href":"/api-reference/campaignservice/listcampaigns"},{"title":"UpdateCampaign","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/campaigns","href":"/api-reference/campaignservice/updatecampaign"}]},{"group":"ChannelSchemaService","pages":[{"group":"v1","pages":[{"title":"BatchCreateChannelSchemas v1","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/channel-schemas:batch-create","href":"/api-reference/channelschemaservice/batchcreatechannelschemas-v1"},{"title":"CreateChannelSchema v1","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/channel-schemas","href":"/api-reference/channelschemaservice/createchannelschema-v1"}]},{"group":"v2","pages":[{"title":"BatchCreateChannelSchemas v2","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/channel-schemas:batch-create","href":"/api-reference/channelschemaservice/batchcreatechannelschemas-v2"},{"title":"CreateChannelSchema v2","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/channel-schemas","href":"/api-reference/channelschemaservice/createchannelschema-v2"}]}]},{"group":"ChannelService","pages":[{"group":"v2","pages":[{"title":"GetChannel v2","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/channels/{channelId}","href":"/api-reference/channelservice/getchannel-v2"},{"title":"ListChannels v2","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/channels","href":"/api-reference/channelservice/listchannels-v2"}]},{"group":"v3","pages":[{"title":"BatchArchiveChannels","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v3/channels:batchArchive","href":"/api-reference/channelservice/batcharchivechannels"},{"title":"BatchUnarchiveChannels","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v3/channels:batchUnarchive","href":"/api-reference/channelservice/batchunarchivechannels"},{"title":"GetChannel v3","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v3/channels/{channelId}","href":"/api-reference/channelservice/getchannel-v3"},{"title":"ListChannels v3","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v3/channels","href":"/api-reference/channelservice/listchannels-v3"},{"title":"UpdateChannel","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v3/channels","href":"/api-reference/channelservice/updatechannel"}]}]},{"group":"CommentService","pages":[{"title":"CreateComment","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/comments","href":"/api-reference/commentservice/createcomment"},{"title":"DeleteComment","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/comments/{commentId}","href":"/api-reference/commentservice/deletecomment"},{"title":"ListComments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/comments","href":"/api-reference/commentservice/listcomments"},{"title":"UpdateComment","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/comments/{comment.commentId}","href":"/api-reference/commentservice/updatecomment"}]},{"group":"DataImportService","pages":[{"title":"CreateDataImportFromUpload","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/data-imports:upload","href":"/api-reference/dataimportservice/createdataimportfromupload"},{"title":"CreateDataImportFromUrl","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/data-imports:url","href":"/api-reference/dataimportservice/createdataimportfromurl"},{"title":"DetectConfig","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/data-imports:detect-config","href":"/api-reference/dataimportservice/detectconfig"},{"title":"GetDataImport","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/data-imports/{dataImportId}","href":"/api-reference/dataimportservice/getdataimport"},{"title":"ListDataImports","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/data-imports","href":"/api-reference/dataimportservice/listdataimports"},{"title":"RetryDataImport","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/data-imports/{dataImportId}:retry","href":"/api-reference/dataimportservice/retrydataimport"}]},{"group":"DataService","pages":[{"group":"v1","pages":[{"title":"GetData v1","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/data","href":"/api-reference/dataservice/getdata-v1"}]},{"group":"v2","pages":[{"title":"GetData v2","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/data","href":"/api-reference/dataservice/getdata-v2"}]}]},{"group":"DlqErrorsService","pages":[{"title":"List Ingestion Dead Letter Queue Errors","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/dlq-errors","href":"/api-reference/dlqerrorsservice/list-ingestion-dead-letter-queue-errors"}]},{"group":"DocsService","pages":[{"title":"ReadDoc","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/docs:read","href":"/api-reference/docsservice/readdoc"},{"title":"SearchDocs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/docs:search","href":"/api-reference/docsservice/searchdocs"}]},{"group":"ExportService","pages":[{"title":"ExportData","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/export","href":"/api-reference/exportservice/exportdata"},{"title":"GetDownloadUrl","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/export/{jobId}/download-url","href":"/api-reference/exportservice/getdownloadurl"}]},{"group":"ExternalSyncService","pages":[{"title":"GenerateToken","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/external-sync:generate-token","href":"/api-reference/externalsyncservice/generatetoken"},{"title":"GetExternalSyncRun","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/external-sync/runs/{externalSyncRunId}","href":"/api-reference/externalsyncservice/getexternalsyncrun"},{"title":"GetIsOrgExternallyProvisioned","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/external-sync:is-org-externally-provisioned","href":"/api-reference/externalsyncservice/getisorgexternallyprovisioned"},{"title":"GetTokenDetails","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/external-sync","href":"/api-reference/externalsyncservice/gettokendetails"},{"title":"ListExternalSyncRuns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/external-sync:list-runs","href":"/api-reference/externalsyncservice/listexternalsyncruns"},{"title":"ListExternalSyncTokens","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/external-sync:list-tokens","href":"/api-reference/externalsyncservice/listexternalsynctokens"},{"title":"SyncOrganization","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/external-sync","href":"/api-reference/externalsyncservice/syncorganization"}]},{"group":"FamilyService","pages":[{"title":"CreateFamily","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/families","href":"/api-reference/familyservice/createfamily"},{"title":"CreateFamilyStatRanges","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/family_stats/create-ranges","href":"/api-reference/familyservice/createfamilystatranges"},{"group":"ExportFamily","pages":[{"title":"ExportFamily by clientKey","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/client_key/{clientKey}/export","href":"/api-reference/familyservice/exportfamily-by-clientkey"},{"title":"ExportFamily by familyVersionId","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/versions/{familyVersionId}/export","href":"/api-reference/familyservice/exportfamily-by-familyversionid"},{"title":"ExportFamily by familyId","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/{familyId}/export","href":"/api-reference/familyservice/exportfamily-by-familyid"}]},{"title":"GenerateFamilyStatRangeName","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/families/stat-range/name","href":"/api-reference/familyservice/generatefamilystatrangename"},{"title":"GetFamilies","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/families:batchGet","href":"/api-reference/familyservice/getfamilies"},{"group":"GetFamily","pages":[{"title":"GetFamily by clientKey","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/client_key/{clientKey}","href":"/api-reference/familyservice/getfamily-by-clientkey"},{"title":"GetFamily by familyId","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/{familyId}","href":"/api-reference/familyservice/getfamily-by-familyid"}]},{"title":"GetFamilyCandidateRunCount","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/versions/{familyVersionId}/candidate-run-count","href":"/api-reference/familyservice/getfamilycandidateruncount"},{"title":"GetFamilyCandidateRuns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/versions/{familyVersionId}/candidate-runs","href":"/api-reference/familyservice/getfamilycandidateruns"},{"title":"GetFamilyRuleDependencies","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/{familyId}/rule-dependencies","href":"/api-reference/familyservice/getfamilyruledependencies"},{"title":"GetFamilyStat","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/family_stats/{familyStatId}","href":"/api-reference/familyservice/getfamilystat"},{"title":"GetFamilyStats","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/family_stats/{familyVersionId}","href":"/api-reference/familyservice/getfamilystats"},{"title":"GetFamilyVersion","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/versions/{familyVersionId}","href":"/api-reference/familyservice/getfamilyversion"},{"title":"ImportFamily","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/families:import","href":"/api-reference/familyservice/importfamily"},{"group":"ImportUpdateFamily","pages":[{"title":"ImportUpdateFamily by clientKey","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/families/client_key/{clientKey}/import-update","href":"/api-reference/familyservice/importupdatefamily-by-clientkey"},{"title":"ImportUpdateFamily by familyId","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/families/{familyId}/import-update","href":"/api-reference/familyservice/importupdatefamily-by-familyid"}]},{"title":"ListFamilies","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families","href":"/api-reference/familyservice/listfamilies"},{"title":"ListFamilyAlignmentPoints","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/alignments/{familyAlignmentId}/points","href":"/api-reference/familyservice/listfamilyalignmentpoints"},{"title":"ListFamilyAlignments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/versions/{familyVersionId}/alignments","href":"/api-reference/familyservice/listfamilyalignments"},{"title":"ListFamilyCandidateRuns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/candidate-runs","href":"/api-reference/familyservice/listfamilycandidateruns"},{"title":"ListFamilyMembers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/versions/{familyVersionId}/members","href":"/api-reference/familyservice/listfamilymembers"},{"title":"ListFamilyVersions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/families/versions","href":"/api-reference/familyservice/listfamilyversions"},{"group":"UpdateFamily","pages":[{"title":"UpdateFamily by clientKey","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/families/client_key/{clientKey}","href":"/api-reference/familyservice/updatefamily-by-clientkey"},{"title":"UpdateFamily by familyId","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/families/{familyId}","href":"/api-reference/familyservice/updatefamily-by-familyid"}]},{"title":"ValidateFamilyClientKey","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/families:validateClientKey","href":"/api-reference/familyservice/validatefamilyclientkey"},{"title":"ValidateFamilyName","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/families:validateFamilyName","href":"/api-reference/familyservice/validatefamilyname"}]},{"group":"IngestionConfigService","pages":[{"group":"v1","pages":[{"title":"CreateIngestionConfig v1","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/ingestion-configs","href":"/api-reference/ingestionconfigservice/createingestionconfig-v1"},{"title":"CreateIngestionConfigFlows v1","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/ingestion-configs/{ingestionConfigId}/flows","href":"/api-reference/ingestionconfigservice/createingestionconfigflows-v1"},{"title":"GetIngestionConfig v1","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/ingestion-configs/{ingestionConfigId}","href":"/api-reference/ingestionconfigservice/getingestionconfig-v1"},{"title":"ListIngestionConfigFlows v1","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/ingestion-configs/{ingestionConfigId}/flows","href":"/api-reference/ingestionconfigservice/listingestionconfigflows-v1"},{"title":"ListIngestionConfigs v1","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/ingestion-configs","href":"/api-reference/ingestionconfigservice/listingestionconfigs-v1"}]},{"group":"v2","pages":[{"title":"CreateIngestionConfig v2","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/ingestion-configs","href":"/api-reference/ingestionconfigservice/createingestionconfig-v2"},{"title":"CreateIngestionConfigFlows v2","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/ingestion-configs/{ingestionConfigId}/flows","href":"/api-reference/ingestionconfigservice/createingestionconfigflows-v2"},{"title":"GetIngestionConfig v2","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/ingestion-configs/{ingestionConfigId}","href":"/api-reference/ingestionconfigservice/getingestionconfig-v2"},{"title":"ListIngestionConfigFlows v2","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/ingestion-configs/{ingestionConfigId}/flows","href":"/api-reference/ingestionconfigservice/listingestionconfigflows-v2"},{"title":"ListIngestionConfigs v2","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/ingestion-configs","href":"/api-reference/ingestionconfigservice/listingestionconfigs-v2"}]}]},{"group":"JobService","pages":[{"title":"CancelJob","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/jobs/{jobId}:cancel","href":"/api-reference/jobservice/canceljob"},{"title":"ListJobs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/jobs","href":"/api-reference/jobservice/listjobs"},{"title":"RetryJob","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/jobs/{jobId}:retry","href":"/api-reference/jobservice/retryjob"}]},{"group":"MeService","pages":[{"title":"Get My User Information","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/me","href":"/api-reference/meservice/get-my-user-information"}]},{"group":"MetadataService","pages":[{"title":"ArchiveMetadataKeys","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/metadata-keys/archive","href":"/api-reference/metadataservice/archivemetadatakeys"},{"title":"ArchiveMetadataValues","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/metadata-values/archive","href":"/api-reference/metadataservice/archivemetadatavalues"},{"title":"Create a metadata value.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/metadata-values","href":"/api-reference/metadataservice/create-a-metadata-value"},{"title":"CreateMetadataKey","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/metadata-keys","href":"/api-reference/metadataservice/createmetadatakey"},{"title":"DeleteMetadataKeys","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/metadata-keys/delete","href":"/api-reference/metadataservice/deletemetadatakeys"},{"title":"DeleteMetadataValues","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/metadata-values/delete","href":"/api-reference/metadataservice/deletemetadatavalues"},{"title":"ListMetadataKeys","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/metadata-keys","href":"/api-reference/metadataservice/listmetadatakeys"},{"title":"ListMetadataUsage","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/metadata-key-usage","href":"/api-reference/metadataservice/listmetadatausage"},{"title":"ListMetadataValues","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/metadata-values","href":"/api-reference/metadataservice/listmetadatavalues"},{"title":"UnarchiveMetadataKeys","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/metadata-keys/unarchive","href":"/api-reference/metadataservice/unarchivemetadatakeys"},{"title":"UnarchiveMetadataValues","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/metadata-values/unarchive","href":"/api-reference/metadataservice/unarchivemetadatavalues"}]},{"group":"NotificationService","pages":[{"title":"BatchUpdateNotifications","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/notifications:batchUpdate","href":"/api-reference/notificationservice/batchupdatenotifications"},{"title":"ListNotifications","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/notifications","href":"/api-reference/notificationservice/listnotifications"}]},{"group":"PanelConfigurationService","pages":[{"title":"CreatePanelConfiguration","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/panel-configurations","href":"/api-reference/panelconfigurationservice/createpanelconfiguration"},{"title":"GetPanelConfiguration","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/panel-configurations/{panelConfigurationId}","href":"/api-reference/panelconfigurationservice/getpanelconfiguration"},{"title":"ListPanelConfigurations","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/panel-configurations","href":"/api-reference/panelconfigurationservice/listpanelconfigurations"},{"title":"UpdatePanelConfiguration","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/panel-configurations/{panelConfiguration.panelConfigurationId}","href":"/api-reference/panelconfigurationservice/updatepanelconfiguration"}]},{"group":"PingService","pages":[{"title":"PingService_Ping","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/ping","href":"/api-reference/pingservice/pingservice_ping"}]},{"group":"PolicyService","pages":[{"title":"ArchivePolicy","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/policies/{policyId}/archive","href":"/api-reference/policyservice/archivepolicy"},{"title":"CreatePolicy","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/policies","href":"/api-reference/policyservice/createpolicy"},{"title":"GetPolicy","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/policies/{policyId}","href":"/api-reference/policyservice/getpolicy"},{"title":"ListPolicies","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/policies","href":"/api-reference/policyservice/listpolicies"},{"title":"UnarchivePolicy","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/policies/{policyId}/unarchive","href":"/api-reference/policyservice/unarchivepolicy"},{"title":"UpdatePolicy","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/policies","href":"/api-reference/policyservice/updatepolicy"},{"title":"ValidatePolicy","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/policies:validate","href":"/api-reference/policyservice/validatepolicy"}]},{"group":"PrincipalAttributeService","pages":[{"title":"ArchivePrincipalAttributeEnumValue","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/principal-attribute-enum-values/{archivedEnumValueId}/archive","href":"/api-reference/principalattributeservice/archiveprincipalattributeenumvalue"},{"title":"ArchivePrincipalAttributeKeys","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/principal-attribute-keys/archive","href":"/api-reference/principalattributeservice/archiveprincipalattributekeys"},{"title":"ArchivePrincipalAttributeValues","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/principal-attribute-values/archive","href":"/api-reference/principalattributeservice/archiveprincipalattributevalues"},{"title":"BatchArchivePrincipalAttributeEnumValues","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/principal-attribute-enum-values/batch-archive","href":"/api-reference/principalattributeservice/batcharchiveprincipalattributeenumvalues"},{"title":"BatchCreatePrincipalAttributeValue","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/principal-attribute-values/batch","href":"/api-reference/principalattributeservice/batchcreateprincipalattributevalue"},{"title":"BatchUnarchivePrincipalAttributeEnumValues","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/principal-attribute-enum-values/batch-unarchive","href":"/api-reference/principalattributeservice/batchunarchiveprincipalattributeenumvalues"},{"title":"CheckPrincipalAttributeKeyArchiveImpact","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/principal-attribute-keys/{principalAttributeKeyId}/archive-impact","href":"/api-reference/principalattributeservice/checkprincipalattributekeyarchiveimpact"},{"title":"CreatePrincipalAttributeEnumValue","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/principal-attribute-enum-values","href":"/api-reference/principalattributeservice/createprincipalattributeenumvalue"},{"title":"CreatePrincipalAttributeKey","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/principal-attribute-keys","href":"/api-reference/principalattributeservice/createprincipalattributekey"},{"title":"GetPrincipalAttributeEnumValue","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/principal-attribute-enum-values/{principalAttributeEnumValueId}","href":"/api-reference/principalattributeservice/getprincipalattributeenumvalue"},{"title":"GetPrincipalAttributeKey","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/principal-attribute-keys/{principalAttributeKeyId}","href":"/api-reference/principalattributeservice/getprincipalattributekey"},{"title":"GetPrincipalAttributeValue","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/principal-attribute-values/{principalAttributeValueId}","href":"/api-reference/principalattributeservice/getprincipalattributevalue"},{"title":"ListPrincipalAttributeEnumValues","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/principal-attribute-keys/{principalAttributeKeyId}/enum-values","href":"/api-reference/principalattributeservice/listprincipalattributeenumvalues"},{"title":"ListPrincipalAttributeKeyValues","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/principal-attribute-keys/{principalAttributeKeyId}/principal-attribute-values","href":"/api-reference/principalattributeservice/listprincipalattributekeyvalues"},{"title":"ListPrincipalAttributeKeys","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/principal-attribute-keys","href":"/api-reference/principalattributeservice/listprincipalattributekeys"},{"title":"ListPrincipalAttributeValues","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/principal-attribute-values","href":"/api-reference/principalattributeservice/listprincipalattributevalues"},{"title":"UnarchivePrincipalAttributeEnumValue","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/principal-attribute-enum-values/{principalAttributeEnumValueId}/unarchive","href":"/api-reference/principalattributeservice/unarchiveprincipalattributeenumvalue"},{"title":"UnarchivePrincipalAttributeKeys","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/principal-attribute-keys/unarchive","href":"/api-reference/principalattributeservice/unarchiveprincipalattributekeys"},{"title":"UnarchivePrincipalAttributeValues","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/principal-attribute-values/unarchive","href":"/api-reference/principalattributeservice/unarchiveprincipalattributevalues"},{"title":"UpdatePrincipalAttributeEnumValue","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/principal-attribute-enum-values/{principalAttributeEnumValueId}","href":"/api-reference/principalattributeservice/updateprincipalattributeenumvalue"},{"title":"UpdatePrincipalAttributeKey","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/principal-attribute-keys/{principalAttributeKeyId}","href":"/api-reference/principalattributeservice/updateprincipalattributekey"}]},{"group":"ProtobufDescriptorService","pages":[{"group":"v1","pages":[{"title":"AddProtobufDescriptor v1","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/protobuf-descriptors:add","href":"/api-reference/protobufdescriptorservice/addprotobufdescriptor-v1"},{"title":"DeleteProtobufDescriptors v1","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/protobuf-descriptors","href":"/api-reference/protobufdescriptorservice/deleteprotobufdescriptors-v1"},{"title":"ListProtobufDescriptors v1","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/protobuf-descriptors","href":"/api-reference/protobufdescriptorservice/listprotobufdescriptors-v1"}]},{"group":"v2","pages":[{"title":"AddProtobufDescriptor v2","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/protobuf-descriptors:add","href":"/api-reference/protobufdescriptorservice/addprotobufdescriptor-v2"},{"title":"CheckProtobufDescriptorCompatibility","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/protobuf-descriptors:check-compatibility","href":"/api-reference/protobufdescriptorservice/checkprotobufdescriptorcompatibility"},{"title":"DeleteProtobufDescriptors v2","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v2/protobuf-descriptors","href":"/api-reference/protobufdescriptorservice/deleteprotobufdescriptors-v2"},{"title":"ListProtobufDescriptors v2","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/protobuf-descriptors","href":"/api-reference/protobufdescriptorservice/listprotobufdescriptors-v2"}]}]},{"group":"RemoteFileService","pages":[{"title":"BatchDeleteRemoteFiles","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/remote-files:batchDelete","href":"/api-reference/remotefileservice/batchdeleteremotefiles"},{"title":"CreateRemoteFile","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/remote-files","href":"/api-reference/remotefileservice/createremotefile"},{"title":"DeleteRemoteFile","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/remote-files/{remoteFileId}","href":"/api-reference/remotefileservice/deleteremotefile"},{"title":"GetRemoteFile","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/remote-files/{remoteFileId}","href":"/api-reference/remotefileservice/getremotefile"},{"title":"GetRemoteFileUrl","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/remote-files/{remoteFileId}/download-url","href":"/api-reference/remotefileservice/getremotefileurl"},{"title":"ListRemoteFiles","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/remote-files","href":"/api-reference/remotefileservice/listremotefiles"},{"title":"UpdateRemoteFile","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/remote-files","href":"/api-reference/remotefileservice/updateremotefile"}]},{"group":"ReportService","pages":[{"title":"CancelReport","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/reports/{reportId}:cancel","href":"/api-reference/reportservice/cancelreport"},{"title":"CreateReport","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/reports","href":"/api-reference/reportservice/createreport"},{"title":"GetReport","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reports/{reportId}","href":"/api-reference/reportservice/getreport"},{"title":"ListReportMetadataValues","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reports/{reportId}/metadata-values","href":"/api-reference/reportservice/listreportmetadatavalues"},{"title":"ListReportRuleSummaries","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reports/{reportId}/rule-summaries","href":"/api-reference/reportservice/listreportrulesummaries"},{"title":"ListReports","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reports","href":"/api-reference/reportservice/listreports"},{"title":"ListReportsWithCumulativeSummary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reports:with-cumulative-summary","href":"/api-reference/reportservice/listreportswithcumulativesummary"},{"title":"RerunReport","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/reports/{reportId}:rerun","href":"/api-reference/reportservice/rerunreport"},{"title":"UpdateReport","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/reports","href":"/api-reference/reportservice/updatereport"}]},{"group":"ReportTemplateService","pages":[{"title":"CreateReportTemplate","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/report-templates","href":"/api-reference/reporttemplateservice/createreporttemplate"},{"group":"GetReportTemplate","pages":[{"title":"by reportTemplateId","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/report-templates/{reportTemplateId}","href":"/api-reference/reporttemplateservice/by-reporttemplateid"},{"title":"by organizationId, clientKey","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organizationId}/report_templates/{clientKey}","href":"/api-reference/reporttemplateservice/by-organizationid-clientkey"}]},{"title":"ListReportTemplates","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/report-templates","href":"/api-reference/reporttemplateservice/listreporttemplates"},{"title":"UpdateReportTemplate","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/report-templates","href":"/api-reference/reporttemplateservice/updatereporttemplate"}]},{"group":"ResourceAttributeService","pages":[{"title":"Archives a resource_attribute key AND all its associated enum values AND all its associated resource-attributes.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attribute-keys/{resourceAttributeKeyId}/archive","href":"/api-reference/resourceattributeservice/archives-a-resource_attribute-key-and-all-its-associated-enum-values-and-all-its-associated-resource-attributes"},{"title":"Archives an enum value and migrates all resource-attributes with that value to a replacement value.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attribute-enum-values/{archivedEnumValueId}/archive","href":"/api-reference/resourceattributeservice/archives-an-enum-value-and-migrates-all-resource-attributes-with-that-value-to-a-replacement-value"},{"title":"Archives multiple enum values and migrates all resource-attributes with those values to their respective replacement values.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attribute-enum-values/batch-archive","href":"/api-reference/resourceattributeservice/archives-multiple-enum-values-and-migrates-all-resource-attributes-with-those-values-to-their-respective-replacement-values"},{"title":"Archives multiple resource-attributes.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attributes/batch-archive","href":"/api-reference/resourceattributeservice/archives-multiple-resource-attributes"},{"title":"Archives multiple resource_attribute keys AND all their associated enum values AND all their associated resource-attributes.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attribute-keys/batch-archive","href":"/api-reference/resourceattributeservice/archives-multiple-resource_attribute-keys-and-all-their-associated-enum-values-and-all-their-associated-resource-attributes"},{"title":"Batch lists all resource-attributes for multiple entities. Excludes archived by default.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/entities/batch-resource-attributes","href":"/api-reference/resourceattributeservice/batch-lists-all-resource-attributes-for-multiple-entities-excludes-archived-by-default"},{"title":"Creates resource-attributes for multiple entities with the same key-value pair.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attributes/batch","href":"/api-reference/resourceattributeservice/creates-resource-attributes-for-multiple-entities-with-the-same-key-value-pair"},{"title":"Lists all resource-attributes for a specific entity. Excludes archived by default.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/entities/{entity.entityId}/resource-attributes","href":"/api-reference/resourceattributeservice/lists-all-resource-attributes-for-a-specific-entity-excludes-archived-by-default"},{"title":"ResourceAttributeService_ArchiveResourceAttribute","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attributes/{resourceAttributeId}/archive","href":"/api-reference/resourceattributeservice/resourceattributeservice_archiveresourceattribute"},{"title":"ResourceAttributeService_CheckResourceAttributeKeyArchiveImpact","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/resource-attribute-keys/{resourceAttributeKeyId}/archive-impact","href":"/api-reference/resourceattributeservice/resourceattributeservice_checkresourceattributekeyarchiveimpact"},{"title":"ResourceAttributeService_CreateResourceAttributeEnumValue","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attribute-enum-values","href":"/api-reference/resourceattributeservice/resourceattributeservice_createresourceattributeenumvalue"},{"title":"ResourceAttributeService_CreateResourceAttributeKey","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attribute-keys","href":"/api-reference/resourceattributeservice/resourceattributeservice_createresourceattributekey"},{"title":"ResourceAttributeService_GetResourceAttribute","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/resource-attributes/{resourceAttributeId}","href":"/api-reference/resourceattributeservice/resourceattributeservice_getresourceattribute"},{"title":"ResourceAttributeService_GetResourceAttributeEnumValue","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/resource-attribute-enum-values/{resourceAttributeEnumValueId}","href":"/api-reference/resourceattributeservice/resourceattributeservice_getresourceattributeenumvalue"},{"title":"ResourceAttributeService_GetResourceAttributeKey","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/resource-attribute-keys/{resourceAttributeKeyId}","href":"/api-reference/resourceattributeservice/resourceattributeservice_getresourceattributekey"},{"title":"ResourceAttributeService_ListResourceAttributeEnumValues","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/resource-attribute-keys/{resourceAttributeKeyId}/enum-values","href":"/api-reference/resourceattributeservice/resourceattributeservice_listresourceattributeenumvalues"},{"title":"ResourceAttributeService_ListResourceAttributeKeys","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/resource-attribute-keys","href":"/api-reference/resourceattributeservice/resourceattributeservice_listresourceattributekeys"},{"title":"ResourceAttributeService_ListResourceAttributes","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/resource-attributes","href":"/api-reference/resourceattributeservice/resourceattributeservice_listresourceattributes"},{"title":"ResourceAttributeService_UnarchiveResourceAttribute","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attributes/{resourceAttributeId}/unarchive","href":"/api-reference/resourceattributeservice/resourceattributeservice_unarchiveresourceattribute"},{"title":"ResourceAttributeService_UpdateResourceAttributeEnumValue","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/resource-attribute-enum-values/{resourceAttributeEnumValueId}","href":"/api-reference/resourceattributeservice/resourceattributeservice_updateresourceattributeenumvalue"},{"title":"ResourceAttributeService_UpdateResourceAttributeKey","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/resource-attribute-keys/{resourceAttributeKeyId}","href":"/api-reference/resourceattributeservice/resourceattributeservice_updateresourceattributekey"},{"title":"Unarchives a resource_attribute key BUT NOT its associated enum values OR resource-attributes.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attribute-keys/{resourceAttributeKeyId}/unarchive","href":"/api-reference/resourceattributeservice/unarchives-a-resource_attribute-key-but-not-its-associated-enum-values-or-resource-attributes"},{"title":"Unarchives an enum value BUT DOES NOT migrate resource-attributes with a replacement value back to the original value.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attribute-enum-values/{resourceAttributeEnumValueId}/unarchive","href":"/api-reference/resourceattributeservice/unarchives-an-enum-value-but-does-not-migrate-resource-attributes-with-a-replacement-value-back-to-the-original-value"},{"title":"Unarchives multiple enum values BUT DOES NOT migrate resource-attributes with a replacement value back to the original value.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attribute-enum-values/batch-unarchive","href":"/api-reference/resourceattributeservice/unarchives-multiple-enum-values-but-does-not-migrate-resource-attributes-with-a-replacement-value-back-to-the-original-value"},{"title":"Unarchives multiple resource-attributes.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attributes/batch-unarchive","href":"/api-reference/resourceattributeservice/unarchives-multiple-resource-attributes"},{"title":"Unarchives multiple resource_attribute keys BUT NOT their associated enum values OR resource-attributes.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resource-attribute-keys/batch-unarchive","href":"/api-reference/resourceattributeservice/unarchives-multiple-resource_attribute-keys-but-not-their-associated-enum-values-or-resource-attributes"}]},{"group":"RoleService","pages":[{"title":"ListRoles","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/roles","href":"/api-reference/roleservice/listroles"}]},{"group":"RuleEvaluationService","pages":[{"title":"EvaluateRules","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules/evaluate-rules","href":"/api-reference/ruleevaluationservice/evaluaterules"},{"title":"EvaluateRulesPreview","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules/evaluate-rules:preview","href":"/api-reference/ruleevaluationservice/evaluaterulespreview"}]},{"group":"RuleService","pages":[{"title":"ArchiveRule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules/archive","href":"/api-reference/ruleservice/archiverule"},{"title":"BatchArchiveRules","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules/batchArchive","href":"/api-reference/ruleservice/batcharchiverules"},{"title":"BatchDeleteRules","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules/batchDelete","href":"/api-reference/ruleservice/batchdeleterules"},{"title":"BatchGetRuleVersions","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules:batchGetVersions","href":"/api-reference/ruleservice/batchgetruleversions"},{"title":"BatchGetRules","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules:batchGet","href":"/api-reference/ruleservice/batchgetrules"},{"title":"BatchUnarchiveRules","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules/batchUnarchive","href":"/api-reference/ruleservice/batchunarchiverules"},{"title":"BatchUndeleteRules","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules/batchUndelete","href":"/api-reference/ruleservice/batchundeleterules"},{"title":"BatchUpdateRules","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/rules:batchUpdate","href":"/api-reference/ruleservice/batchupdaterules"},{"title":"CreateRule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules","href":"/api-reference/ruleservice/createrule"},{"title":"DeleteRule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules/delete","href":"/api-reference/ruleservice/deleterule"},{"title":"EvaluateRules","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules/evaluate","href":"/api-reference/ruleservice/evaluaterules"},{"title":"GetRule","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/rules","href":"/api-reference/ruleservice/getrule"},{"title":"GetRuleVersion","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/rules:version","href":"/api-reference/ruleservice/getruleversion"},{"title":"ListRuleVersions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/rules/{ruleId}/versions","href":"/api-reference/ruleservice/listruleversions"},{"title":"ListRules","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/rules:list","href":"/api-reference/ruleservice/listrules"},{"title":"SearchRules","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules/search","href":"/api-reference/ruleservice/searchrules"},{"title":"UnarchiveRule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules/unarchive","href":"/api-reference/ruleservice/unarchiverule"},{"title":"UndeleteRule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules/undelete","href":"/api-reference/ruleservice/undeleterule"},{"title":"UpdateHumanFriendlyRules","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules:updateHumanFriendly","href":"/api-reference/ruleservice/updatehumanfriendlyrules"},{"title":"UpdateJsonRules","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules:updateJson","href":"/api-reference/ruleservice/updatejsonrules"},{"title":"UpdateRule","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/rules","href":"/api-reference/ruleservice/updaterule"},{"title":"ValidateJsonRules","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/rules:validateJson","href":"/api-reference/ruleservice/validatejsonrules"},{"title":"ViewHumanFriendlyRules","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/rules:viewHumanFriendly","href":"/api-reference/ruleservice/viewhumanfriendlyrules"},{"title":"ViewJsonRules","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/rules:viewJson","href":"/api-reference/ruleservice/viewjsonrules"}]},{"group":"RunService","pages":[{"title":"CreateAdhocRun","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/runs:adhoc","href":"/api-reference/runservice/createadhocrun"},{"title":"CreateAutomaticRunAssociationForAssets","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/runs/{runId}:create-automatic-run-association-for-assets","href":"/api-reference/runservice/createautomaticrunassociationforassets"},{"title":"CreateRun","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/runs","href":"/api-reference/runservice/createrun"},{"title":"DeleteRun","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v2/runs/{runId}","href":"/api-reference/runservice/deleterun"},{"title":"GetRun","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/runs/{runId}","href":"/api-reference/runservice/getrun"},{"title":"ListRuns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/runs","href":"/api-reference/runservice/listruns"},{"title":"StopRun","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v2/runs:stop","href":"/api-reference/runservice/stoprun"},{"title":"UpdateRun","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v2/runs","href":"/api-reference/runservice/updaterun"},{"title":"ValidateRunFilter","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/runs:validateFilter","href":"/api-reference/runservice/validaterunfilter"}]},{"group":"SavedSearchService","pages":[{"title":"BatchDeleteSavedSearches","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/saved_searches:batchDelete","href":"/api-reference/savedsearchservice/batchdeletesavedsearches"},{"title":"CreateSavedSearch","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/saved_searches","href":"/api-reference/savedsearchservice/createsavedsearch"},{"title":"DeleteSavedSearch","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/saved_searches/{savedSearchId}","href":"/api-reference/savedsearchservice/deletesavedsearch"},{"title":"GetSavedSearch","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/saved_searches/{savedSearchId}","href":"/api-reference/savedsearchservice/getsavedsearch"},{"title":"ListSavedSearches","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/saved_searches","href":"/api-reference/savedsearchservice/listsavedsearches"},{"title":"UpdateSavedSearch","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/saved_searches","href":"/api-reference/savedsearchservice/updatesavedsearch"}]},{"group":"TagService","pages":[{"group":"v1","pages":[{"title":"CreateTag v1","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/tags","href":"/api-reference/tagservice/createtag-v1"},{"title":"ListTags v1","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/tags","href":"/api-reference/tagservice/listtags-v1"}]},{"group":"v2","pages":[{"title":"CreateTag v2","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/tags","href":"/api-reference/tagservice/createtag-v2"},{"title":"ListTags v2","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/tags","href":"/api-reference/tagservice/listtags-v2"}]}]},{"group":"TestReportService","pages":[{"title":"BatchArchiveTestReports","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/test-reports:batchArchive","href":"/api-reference/testreportservice/batcharchivetestreports"},{"title":"BatchUnarchiveTestReports","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/test-reports:batchUnarchive","href":"/api-reference/testreportservice/batchunarchivetestreports"},{"title":"BatchUpdateTestReports","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/test-reports:batchUpdate","href":"/api-reference/testreportservice/batchupdatetestreports"},{"title":"CountTestMeasurements","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/test-measurements/count","href":"/api-reference/testreportservice/counttestmeasurements"},{"title":"CountTestSteps","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/test-steps/count","href":"/api-reference/testreportservice/countteststeps"},{"title":"CreateTestMeasurement","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/test-measurements","href":"/api-reference/testreportservice/createtestmeasurement"},{"title":"CreateTestMeasurements","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/test-measurements:batch","href":"/api-reference/testreportservice/createtestmeasurements"},{"title":"CreateTestReport","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/test-reports","href":"/api-reference/testreportservice/createtestreport"},{"title":"CreateTestStep","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/test-steps","href":"/api-reference/testreportservice/createteststep"},{"title":"DeleteTestMeasurement","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/test-measurements/{measurementId}","href":"/api-reference/testreportservice/deletetestmeasurement"},{"title":"DeleteTestReport","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/test-reports/{testReportId}","href":"/api-reference/testreportservice/deletetestreport"},{"title":"DeleteTestStep","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/test-steps/{testStepId}","href":"/api-reference/testreportservice/deleteteststep"},{"title":"GetTestReport","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/test-reports/{testReportId}","href":"/api-reference/testreportservice/gettestreport"},{"title":"ImportTestReport","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/test-reports:import","href":"/api-reference/testreportservice/importtestreport"},{"title":"ListTestMeasurements","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/test-measurements","href":"/api-reference/testreportservice/listtestmeasurements"},{"title":"ListTestReports","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/test-reports","href":"/api-reference/testreportservice/listtestreports"},{"title":"ListTestSteps","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/test-steps","href":"/api-reference/testreportservice/listteststeps"},{"title":"UpdateTestMeasurement","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/test-measurements","href":"/api-reference/testreportservice/updatetestmeasurement"},{"title":"UpdateTestReport","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/test-reports","href":"/api-reference/testreportservice/updatetestreport"},{"title":"UpdateTestStep","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/test-steps","href":"/api-reference/testreportservice/updateteststep"}]},{"group":"UnitService","pages":[{"title":"CreateUnit","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/units","href":"/api-reference/unitservice/createunit"},{"title":"ListUnits","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/units","href":"/api-reference/unitservice/listunits"}]},{"group":"UserDefinedFunctionService","pages":[{"title":"CheckUpdatableFields","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/user-defined-functions/updatable-fields","href":"/api-reference/userdefinedfunctionservice/checkupdatablefields"},{"title":"CreateUserDefinedFunction","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/user-defined-functions","href":"/api-reference/userdefinedfunctionservice/createuserdefinedfunction"},{"title":"GetUserDefinedFunction","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/user-defined-functions/{userDefinedFunctionId}","href":"/api-reference/userdefinedfunctionservice/getuserdefinedfunction"},{"title":"GetUserDefinedFunctionDependents","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/user-defined-functions/dependents","href":"/api-reference/userdefinedfunctionservice/getuserdefinedfunctiondependents"},{"title":"GetUserDefinedFunctionVersion","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/user-defined-functions/versions/{userDefinedFunctionVersionId}","href":"/api-reference/userdefinedfunctionservice/getuserdefinedfunctionversion"},{"title":"GetUserDefinedFunctionVersions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/user-defined-functions/versions","href":"/api-reference/userdefinedfunctionservice/getuserdefinedfunctionversions"},{"title":"ListUserDefinedFunctionVersions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/user-defined-functions/{userDefinedFunctionId}/versions","href":"/api-reference/userdefinedfunctionservice/listuserdefinedfunctionversions"},{"title":"ListUserDefinedFunctions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/user-defined-functions","href":"/api-reference/userdefinedfunctionservice/listuserdefinedfunctions"},{"title":"UpdateUserDefinedFunction","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/user-defined-functions","href":"/api-reference/userdefinedfunctionservice/updateuserdefinedfunction"},{"title":"ValidateUserDefinedFunction","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/user-defined-functions:validate","href":"/api-reference/userdefinedfunctionservice/validateuserdefinedfunction"}]},{"group":"UserGroupService","pages":[{"title":"AddUserToUserGroup","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/user-groups:add-user","href":"/api-reference/usergroupservice/addusertousergroup"},{"title":"CreateUserGroup","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/user-groups","href":"/api-reference/usergroupservice/createusergroup"},{"title":"DeleteUserGroup","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v2/user-groups/{userGroupId}","href":"/api-reference/usergroupservice/deleteusergroup"},{"title":"GetUserGroup","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/user-groups/{userGroupId}","href":"/api-reference/usergroupservice/getusergroup"},{"title":"GetUserGroupsForAssets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/user-groups:get-for-assets","href":"/api-reference/usergroupservice/getusergroupsforassets"},{"title":"ListUserGroups","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/user-groups","href":"/api-reference/usergroupservice/listusergroups"},{"title":"RemoveUserFromUserGroup","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/user-groups:remove-user","href":"/api-reference/usergroupservice/removeuserfromusergroup"},{"title":"UpdateUserGroup","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v2/user-groups/{userGroup.userGroupId}","href":"/api-reference/usergroupservice/updateusergroup"},{"title":"UpdateUserUserGroups","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/user-groups:update-user","href":"/api-reference/usergroupservice/updateuserusergroups"}]},{"group":"UserService","pages":[{"title":"GetUser","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/users/{userId}","href":"/api-reference/userservice/getuser"},{"title":"ListActiveUsers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/users","href":"/api-reference/userservice/listactiveusers"},{"title":"ListUsers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/users:all","href":"/api-reference/userservice/listusers"},{"title":"UpdateUserOrganizationActive","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/users/{userId}/active","href":"/api-reference/userservice/updateuserorganizationactive"}]},{"group":"ViewService","pages":[{"group":"v1","pages":[{"title":"CreateView v1","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/views","href":"/api-reference/viewservice/createview-v1"},{"title":"DeleteView v1","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/views/{viewId}","href":"/api-reference/viewservice/deleteview-v1"},{"title":"GetView v1","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/views/{viewId}","href":"/api-reference/viewservice/getview-v1"},{"title":"ListViews v1","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/views","href":"/api-reference/viewservice/listviews-v1"},{"title":"Lists views that apply to assets/runs.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/views:applicable","href":"/api-reference/viewservice/lists-views-that-apply-to-assetsruns"},{"title":"PinView v1","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/views/{viewId}/pin","href":"/api-reference/viewservice/pinview-v1"},{"title":"UnpinView v1","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/views/{viewId}/unpin","href":"/api-reference/viewservice/unpinview-v1"},{"title":"UpdateView v1","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/views/{view.viewId}","href":"/api-reference/viewservice/updateview-v1"}]},{"group":"v2","pages":[{"title":"CreateView v2","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/views","href":"/api-reference/viewservice/createview-v2"},{"title":"DeleteView v2","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v2/views/{viewId}","href":"/api-reference/viewservice/deleteview-v2"},{"title":"GetView v2","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/views/{viewId}","href":"/api-reference/viewservice/getview-v2"},{"title":"ListApplicableViews","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/views:applicable","href":"/api-reference/viewservice/listapplicableviews"},{"title":"ListViews v2","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/views","href":"/api-reference/viewservice/listviews-v2"},{"title":"PinView v2","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v2/views/{viewId}/pin","href":"/api-reference/viewservice/pinview-v2"},{"title":"UnpinView v2","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v2/views/{viewId}/unpin","href":"/api-reference/viewservice/unpinview-v2"},{"title":"UpdateView v2","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v2/views/{view.viewId}","href":"/api-reference/viewservice/updateview-v2"}]}]},{"group":"WebhookService","pages":[{"title":"BatchCreateWebhookLogs","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/webhooks/logs:batch-create","href":"/api-reference/webhookservice/batchcreatewebhooklogs"},{"title":"CreateOrUpdateWebhookSignatureKey","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/webhooks/signature-key","href":"/api-reference/webhookservice/createorupdatewebhooksignaturekey"},{"title":"CreateWebhook","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/webhooks","href":"/api-reference/webhookservice/createwebhook"},{"title":"GetWebhook","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhooks/{webhookId}","href":"/api-reference/webhookservice/getwebhook"},{"title":"GetWebhookSignatureKey","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhooks/signature-key","href":"/api-reference/webhookservice/getwebhooksignaturekey"},{"title":"ListWebhookLogs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhooks/logs","href":"/api-reference/webhookservice/listwebhooklogs"},{"title":"ListWebhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhooks","href":"/api-reference/webhookservice/listwebhooks"},{"title":"TestWebhook","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/webhooks:test","href":"/api-reference/webhookservice/testwebhook"},{"group":"ToggleWebhookSignatureKeyActivation","pages":[{"title":"PUT /api/v1/webhooks/signature-key","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/webhooks/signature-key","href":"/api-reference/webhookservice/put-apiv1webhookssignature-key"},{"title":"PATCH /api/v1/webhooks/signature-key","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/webhooks/signature-key","href":"/api-reference/webhookservice/patch-apiv1webhookssignature-key"}]},{"title":"UpdateWebhook","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/webhooks","href":"/api-reference/webhookservice/updatewebhook"}]}]},{"group":"gRPC","expanded":false,"pages":[{"title":"gRPC","sidebarTitle":"Overview","description":"Use Sift's gRPC API with official client libraries or grpcurl.","href":"/api/reference/protocol-buffers/index"},{"title":"action_type","href":"/api/reference/protocol-buffers/action_type"},{"title":"annotation_logs","description":"sift/annotation_logs/v1/annotation_logs.proto","href":"/api/reference/protocol-buffers/annotation_logs"},{"title":"annotations","href":"/api/reference/protocol-buffers/annotations"},{"title":"api_keys","href":"/api/reference/protocol-buffers/api_keys"},{"title":"artifacts","href":"/api/reference/protocol-buffers/artifacts"},{"title":"assets","href":"/api/reference/protocol-buffers/assets"},{"title":"automation","href":"/api/reference/protocol-buffers/automation"},{"title":"calculated_channels","href":"/api/reference/protocol-buffers/calculated_channels"},{"title":"campaigns","href":"/api/reference/protocol-buffers/campaigns"},{"title":"canvas","href":"/api/reference/protocol-buffers/canvas"},{"title":"channel_bit_field_element","href":"/api/reference/protocol-buffers/channel_bit_field_element"},{"title":"channel_config","href":"/api/reference/protocol-buffers/channel_config"},{"title":"channel_data_type","href":"/api/reference/protocol-buffers/channel_data_type"},{"title":"channel_enum_type","href":"/api/reference/protocol-buffers/channel_enum_type"},{"title":"channel_parsing_options","href":"/api/reference/protocol-buffers/channel_parsing_options"},{"title":"channel_schemas","href":"/api/reference/protocol-buffers/channel_schemas"},{"title":"channels","href":"/api/reference/protocol-buffers/channels"},{"title":"comment","href":"/api/reference/protocol-buffers/comment"},{"title":"data","href":"/api/reference/protocol-buffers/data"},{"title":"data_imports","href":"/api/reference/protocol-buffers/data_imports"},{"title":"dlq_errors","href":"/api/reference/protocol-buffers/dlq_errors"},{"title":"docs","href":"/api/reference/protocol-buffers/docs"},{"title":"exports","href":"/api/reference/protocol-buffers/exports"},{"title":"external_sync","href":"/api/reference/protocol-buffers/external_sync"},{"title":"families","href":"/api/reference/protocol-buffers/families"},{"title":"ingest","href":"/api/reference/protocol-buffers/ingest"},{"title":"ingestion_configs","href":"/api/reference/protocol-buffers/ingestion_configs"},{"title":"jobs","href":"/api/reference/protocol-buffers/jobs"},{"title":"me","href":"/api/reference/protocol-buffers/me"},{"title":"metadata","href":"/api/reference/protocol-buffers/metadata"},{"title":"notifications","href":"/api/reference/protocol-buffers/notifications"},{"title":"organization","href":"/api/reference/protocol-buffers/organization"},{"title":"panel_configuration","href":"/api/reference/protocol-buffers/panel_configuration"},{"title":"ping","href":"/api/reference/protocol-buffers/ping"},{"title":"policies","href":"/api/reference/protocol-buffers/policies"},{"title":"principal_attributes","href":"/api/reference/protocol-buffers/principal_attributes"},{"title":"protobuf_descriptors","href":"/api/reference/protocol-buffers/protobuf_descriptors"},{"title":"remote_files","href":"/api/reference/protocol-buffers/remote_files"},{"title":"report_templates","href":"/api/reference/protocol-buffers/report_templates"},{"title":"reports","href":"/api/reference/protocol-buffers/reports"},{"title":"resource_attribute","href":"/api/reference/protocol-buffers/resource_attribute"},{"title":"resource_identifier","href":"/api/reference/protocol-buffers/resource_identifier"},{"title":"resource_ref","href":"/api/reference/protocol-buffers/resource_ref"},{"title":"resource_type","href":"/api/reference/protocol-buffers/resource_type"},{"title":"roles","href":"/api/reference/protocol-buffers/roles"},{"title":"rule_evaluation","href":"/api/reference/protocol-buffers/rule_evaluation"},{"title":"rules","href":"/api/reference/protocol-buffers/rules"},{"title":"runs","href":"/api/reference/protocol-buffers/runs"},{"title":"saved_searches","href":"/api/reference/protocol-buffers/saved_searches"},{"title":"tags","href":"/api/reference/protocol-buffers/tags"},{"title":"test_reports","href":"/api/reference/protocol-buffers/test_reports"},{"title":"unit","href":"/api/reference/protocol-buffers/unit"},{"title":"user","href":"/api/reference/protocol-buffers/user"},{"title":"user_defined_functions","href":"/api/reference/protocol-buffers/user_defined_functions"},{"title":"user_groups","href":"/api/reference/protocol-buffers/user_groups"},{"title":"users","href":"/api/reference/protocol-buffers/users"},{"title":"views","href":"/api/reference/protocol-buffers/views"},{"title":"webhooks","href":"/api/reference/protocol-buffers/webhooks"}]}]}]},{"tab":"Release notes","pages":[{"title":"Release notes","href":"/release-notes/overview"}]},{"tab":"Changelog","hidden":true,"pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"action_type - Sift","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":[],"chunks":[]}