---
title: "Get Registry Action"
method: GET
path: "/registry/actions/{action_name}"
tags: ["registry-actions"]
---

# Get Registry Action

`GET /registry/actions/{action_name}`

## Request

- Base URL: `https://platform.tracecat.com/api`
- URL: `https://platform.tracecat.com/api/registry/actions/{action_name}`
- Auth: API key in cookie `fastapiusersauth`

Get a specific registry action.

## Path parameters

- `action_name` string, required

## Response `200`

Successful Response

- RegistryActionRead: API read model for a registered action.
  - `name` string, required: The name of the action
  - `description` string, required: The description of the action
  - `namespace` string, required: The namespace of the action
  - `type` 'udf' | 'template', required: The type of the action
  - `origin` string, required: The origin of the action as a url
  - `secrets` RegistrySecretType[], nullable: The secrets required by the action
    - union
      - RegistrySecret
        - `type` 'custom'
        - `name` string, required
        - `keys` string[], nullable
        - `optional_keys` string[], nullable
        - `optional` boolean
        - `secret_type` 'custom' | 'ssh_key' | 'mtls' | 'ca_cert'
      - RegistryOAuthSecret: OAuth secret for a provider.
        - `type` 'oauth'
        - `provider_id` string, required
        - `grant_type` 'authorization_code' | 'client_credentials', required
        - `optional` boolean
        - `name` string, required
  - `interface` RegistryActionInterface, required
    - `expects` object, required
    - `returns` unknown, required
  - `implementation` union, required
    - RegistryActionTemplateImpl
      - `type` 'template'
      - `template_action` TemplateAction, required
        - `type` 'action'
        - `definition` TemplateActionDefinition, required
          - `name` string, required: The action name
          - `namespace` string, required: The namespace of the action
          - `title` string, required: The title of the action
          - `description` string: The description of the action
          - `display_group` string, required: The display group of the action
          - `doc_url` string, nullable: Link to documentation
          - `author` string, nullable: Author of the action
          - `deprecated` string, nullable: Marks action as deprecated along with message
          - `secrets` RegistrySecretType[], nullable: The secrets to pass to the action
            - union
              - …
          - `expects` object, required: The arguments to pass to the action
          - `steps` ActionStep[], required: The sequence of steps for the action
            - `ref` string, required: The reference of the step
            - `action` string, required
            - `args` object, required
          - `returns` union, required: The result of the action
            - string
            - string[]
            - object
    - RegistryActionUDFImpl
      - `type` 'udf'
      - `url` string, required: The package url
      - `module` string, required: The module name
      - `name` string, required: The name of the UDF function name
  - `default_title` string, nullable: The default title of the action
  - `display_group` string, nullable: The presentation group of the action
  - `doc_url` string, nullable: Link to documentation
  - `author` string, nullable: Author of the action
  - `deprecated` string, nullable: Marks action as deprecated along with message
  - `options` RegistryActionOptions
    - `include_in_schema` boolean
    - `requires_approval` boolean
    - `required_entitlements` string[], nullable
  - `repository_id` string, uuid4, required: The repository id
  - `id` string, uuid4, required: The registry action id
  - `action` string, required: The full action identifier.
  - `is_template` boolean, required: Whether the action is a template.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/tracecat/apis/tracecat-api.md) - [All operations](https://skmtc.dev/tracecat/apis/tracecat-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tracecat/apis/tracecat-api/revisions/2efdda25045f?raw)