https://backstage.io/assets/js/02e03d11.c6694ab6.js

1"use strict";(self.webpackChunkbackstage_microsite=self.webpackChunkbackstage_microsite||[]).push([["11782"],{886894(e,t,s){s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>n,toc:()=>r});var n=s(947777),i=s(474848),a=s(28453);let o={id:"well-known-actions",title:"Well-known Actions",description:"This section lists a number of well-known actions that are part of the Actions Registry."},l,c={},r=[{value:"Actions",id:"actions",level:2},{value:"Auth",id:"auth",level:3},{value:"Catalog",id:"catalog",level:3},{value:"Notifications",id:"notifications",level:3},{value:"Kubernetes",id:"kubernetes",level:3},{value:"Scaffolder",id:"scaffolder",level:3},{value:"Search",id:"search",level:3}];function d(e){let t={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(t.p,{children:["This section lists a number of well-known ",(0,i.jsx)(t.a,{href:"/docs/next/backend-system/core-services/actions",children:"Actions"})," registered with the ",(0,i.jsx)(t.a,{href:"/docs/next/backend-system/core-services/actions-registry",children:"Actions Registry"}),"."]}),"\n",(0,i.jsx)(t.h2,{id:"actions",children:"Actions"}),"\n",(0,i.jsxs)(t.p,{children:['This is a (non-exhaustive) list of actions that are known to be part of the Actions Registry. Entries are in the format: "',(0,i.jsx)(t.code,{children:"action-name"}),' (Action Title): Shortened Action Description"']}),"\n",(0,i.jsx)(t.h3,{id:"auth",children:"Auth"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"auth.who-am-i"})," (Who Am I): Returns the catalog entity and user info for the currently authenticated user. This action requires user credentials and cannot be used with service or unauthenticated credentials."]}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"catalog",children:"Catalog"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"catalog.get-catalog-entity"})," (Get Catalog Entity): This allows you to get a single entity from the software catalog."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"catalog.query-catalog-entities"})," (Query Catalog Entities): Query entities from the Backstage Software Catalog using predicate filters."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"catalog.register-entity"})," (Register entity in the Catalog): Registers one or more entities in the Backstage catalog by creating a Location entity that points to a remote ",(0,i.jsx)(t.code,{children:"catalog-info.yaml"})," file."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"catalog.unregister-entity"})," (Unregister entity from the Catalog): Unregisters a Location entity and all entities it owns from the Backstage catalog."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"catalog.validate-entity"})," (Validate Catalog Entity): This action can be used to validate ",(0,i.jsx)(t.code,{children:"catalog-info.yaml"})," file contents meant to be used with the software catalog."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"catalog.get-catalog-model-description"})," (Get a Catalog Model Description): Returns a markdown formatted description of the current catalog model, including all registered entity kinds, annotations, labels, tags, and relations."]}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"notifications",children:"Notifications"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"notifications.get-notifications"})," (Get Notifications): Fetches notifications for the currently authenticated user. Defaults to returning only unread notifications. Supports filtering by read status (",(0,i.jsx)(t.code,{children:"unread"}),", ",(0,i.jsx)(t.code,{children:"read"}),", ",(0,i.jsx)(t.code,{children:"saved"}),", ",(0,i.jsx)(t.code,{children:"all"}),"), severity, topic, free-text search, and creation date. Supports pagination via ",(0,i.jsx)(t.code,{children:"offset"})," and ",(0,i.jsx)(t.code,{children:"limit"}),"."]}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"kubernetes",children:"Kubernetes"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"kubernetes.get-kubernetes-clusters"})," (Get Kubernetes Clusters): Lists all Kubernetes clusters registered with this Backstage instance, including their names, optional display titles, and optional dashboard URLs."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"kubernetes.get-kubernetes-resources-for-entity"})," (Get Kubernetes Resources for Entity): Fetches live Kubernetes resources (pods, deployments, services, etc.) associated with a catalog entity across all registered clusters. Takes ",(0,i.jsx)(t.code,{children:"name"}),", optional ",(0,i.jsx)(t.code,{children:"kind"})," (defaults to ",(0,i.jsx)(t.code,{children:"Component"}),"), and optional ",(0,i.jsx)(t.code,{children:"namespace"})," (defaults to ",(0,i.jsx)(t.code,{children:"default"}),"). The entity must have a ",(0,i.jsx)(t.code,{children:"backstage.io/kubernetes-id"})," or ",(0,i.jsx)(t.code,{children:"backstage.io/kubernetes-label-selector"})," annotation."]}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"scaffolder",children:"Scaffolder"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"scaffolder.dry-run-template"})," (Dry Run Scaffolder Template): Dry-runs a scaffolder template to validate it without making changes. Returns success with execution logs, or errors for validation failures."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"scaffolder.list-scaffolder-actions"})," (List Scaffolder Actions): Lists all installed Scaffolder actions."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"scaffolder.list-scaffolder-tasks"})," (List Scaffolder Tasks): This allows you to list scaffolder tasks that have been created."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"scaffolder.execute-template"})," (Execute Scaffolder Template): Executes a Scaffolder template with its template ref and input parameter values."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"scaffolder.get-scaffolder-task-logs"})," (Get Scaffolder Task Logs): This allows you to fetch the logs of a given scaffolder task."]}),"\n"]}),"\n",(0,i.jsx)(t.h3,{id:"search",children:"Search"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"search.query"})," (Query Search Engine): Query the Backstage search engine for documents across all or selected document types."]}),"\n"]})]})}function h(e={}){let{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},28453(e,t,s){s.d(t,{R:()=>o,x:()=>l});var n=s(296540);let i={},a=n.createContext(i);function o(e){let t=n.useContext(a);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),n.createElement(a.Provider,{value:t},e.children)}},947777(e){e.exports=JSON.parse('{"id":"ai/well-known-actions","title":"Well-known Actions","description":"This section lists a number of well-known actions that are part of the Actions Registry.","source":"@site/../docs/ai/well-known-actions.md","sourceDirName":"ai","slug":"/ai/well-known-actions","permalink":"/docs/next/ai/well-known-actions","draft":false,"unlisted":false,"editUrl":"https://github.com/backstage/backstage/edit/master/docs/ai/well-known-actions.md","tags":[],"version":"current","frontMatter":{"id":"well-known-actions","title":"Well-known Actions","description":"This section lists a number of well-known actions that are part of the Actions Registry."},"sidebar":"docs","previous":{"title":"MCP Actions Backend","permalink":"/docs/next/ai/mcp-actions"},"next":{"title":"Published skills","permalink":"/docs/next/ai/skills"}}')}}]);