---
id: workflow-engine-metadata
title: Read engine metadata
description: >-
  Returns what the engine supports: API version, how many plugins are installed,
  and feature flags. This is the only endpoint that requires no authentication,
  which makes it a simple connectivity check.
sidebar_label: Read engine metadata
hide_title: true
hide_table_of_contents: true
api: >-
  eJzdVt9v3DYM/lcIvnTD3LvL0KKD37IiHTpgXZAlS4EgWHgWbauRJVWi72Ic7n8fJDuXy29gj7uXM2yK/PjxI6kNCjURyws8d+G6Nm4NbBttGS8LVByroL1oZ7HEE5Y+2AjrlgSk5ckQYu+9CxJLODz+DCsOUTtbQOvW0JEdwJu+0TYCBQZto5AxrAogq6Bmkj4w1IaaOIPTVkfQMTt31gzAVnmnbQpHAoG/9zpwBOuAemnZiq5IcrR1q6sWOrrmCFqAIOrOG4bKWcuV6JWWAaqWq+sZFug8h3zws8IS11Pmb8eEyo6FFAlhgZGrPmgZsLy4LDBw9M5Gjlhu8OfFIv3d5+j0jpZbLyle5aywlWRP3psJ9fxbTIc2GKuWO0pPosUwlniUffxxB0QGn9675TeuBAv0IeUgesRCXv898p6djLZRgrYNFsg3lLjAEhezxWyB2wLHmnx0/QhqOqGtcMNh/8j799sCpwqzOs7HTgc/hp2OUQg0YIFauIuPAWz33F2gBN2MMTqnesOYZFZpxQEvtwV2dPPFKT664apPHMWX4R0sFottgeK8M64ZXs5eDhKWSXP7jp9hVbjzLpDZs1w6Z5hs8hOWVD39peuN6D9D89TX6Vfg+69fH8vnzPKN50pYQeSw4gAcggsvSMgHtzTc/fS8lI5Hiyc09Fi6UcgqCmoMC0unBvjh5NNH+PDL4gNMsUCxkDaxGDEqoAhXz2G6+nH2mNeM43Gl7uM5yhCSDZydfC6AZ80MrloRH8v5fNezcYjC3Uzxap5Bx7tP1snb2vVWXc3u6eA/+UiFnSh9SWNfnMDOPgpJ/4qC3y3ebVPqidLXXMMtLFhraUErWNf/6Pr81+V57ftmYYFvdJSYYudJa6tX4O4SjXPFtbY699z8gdvcwpmYJ7r+ftWOA0e2As7CioxWWRFQkzap50pwNg1ICQN4DuDqmq3StoFas1GzJ4bIM73pSdpXUovCPs5jRXZeOVvrPIk6jpGaV1jp+ijQ0opvV46CKfoAbyqn+M2ukbfZp7QuLZKGM9AMbZ/aewsltXVauBvsg9lTI3k9s70x3pDULnSzynW4vbzbQX+l1h6zXzIFDof9PQ6SoxQhm6WZk42wmB4+udCRYIm/n5/iNiukdun46nZz4EFeDzud45c9OGm5583honSUZ42lHOeEST1ceg91sbmbX/+ne8TEvPCNzL0hnTsll/VWoRe720XErJSRnssCWxclfd9slhT5LJjtNr3+3nOYrhsrCpqWeW2m1dgypS2ZlHPNA5Z4WFXsk+JWZPrckg/vFkk+O3X+dpTq/i9P4nxW
sidebar_class_name: get api-method
info_path: docs/api/nullplatform-api
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/workflow-engine-metadata'
---
<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Read engine metadata"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/workflows/metadata"}
  context={"endpoint"}
>

</MethodEndpoint>

Returns what the engine supports: API version, how many plugins are installed, and feature flags. This is the only endpoint that requires no authentication, which makes it a simple connectivity check.

<ParamsDetails
  parameters={undefined}
>

</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>

</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The engine metadata.","content":{"application/json":{"schema":{"title":"EngineMetadata","type":"object","properties":{"apiVersion":{"type":"string","example":"0.0.0"},"pluginCount":{"type":"integer","example":55},"supportedPluginTypes":{"type":"array","items":{"type":"string"},"example":["trigger","module","decider"]},"maxNodeExecutions":{"type":"integer","example":1000},"topology":{"type":"string","example":"t1"},"features":{"type":"object","properties":{"temporal":{"type":"boolean"},"rbac":{"type":"boolean"},"multiOrg":{"type":"boolean"}}}}}}}},"5XX":{"description":"Unexpected server error.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}}}}
>

</StatusCodes>

