GET
/
registry
/
actions
/
{action_name}
{
  "name": "<string>",
  "description": "<string>",
  "namespace": "<string>",
  "type": "udf",
  "origin": "<string>",
  "secrets": [
    {
      "name": "<string>",
      "keys": [
        "<string>"
      ],
      "optional_keys": [
        "<string>"
      ],
      "optional": true
    }
  ],
  "interface": {
    "expects": {},
    "returns": "<any>"
  },
  "implementation": {
    "type": "<any>",
    "template_action": {
      "type": "<any>",
      "definition": {
        "name": "<string>",
        "namespace": "<string>",
        "title": "<string>",
        "description": "",
        "display_group": "<string>",
        "doc_url": "<string>",
        "author": "<string>",
        "deprecated": "<string>",
        "secrets": [
          {
            "name": "<string>",
            "keys": [
              "<string>"
            ],
            "optional_keys": [
              "<string>"
            ],
            "optional": true
          }
        ],
        "expects": {},
        "steps": [
          {
            "ref": "<string>",
            "action": "<string>",
            "args": {}
          }
        ],
        "returns": "<string>"
      }
    }
  },
  "default_title": "<string>",
  "display_group": "<string>",
  "doc_url": "<string>",
  "author": "<string>",
  "deprecated": "<string>",
  "options": {
    "include_in_schema": true
  },
  "repository_id": "<string>",
  "action": "<string>",
  "is_template": true
}

Authorizations

​
fastapiusersauth
string
cookie
required

Path Parameters

​
action_name
string
required

Response

200
application/json
Successful Response

API read model for a registered action.

​
name
string
required

The name of the action

Required string length: 1 - 100
​
description
string
required

The description of the action

Maximum length: 1000
​
namespace
string
required

The namespace of the action

​
type
enum<string>
required

The type of the action

Available options:
udf,
template
​
origin
string
required

The origin of the action as a url

Required string length: 1 - 1000
​
interface
object
required
​
repository_id
string
required

The repository id

​
action
string
required

The full action identifier.

​
is_template
boolean
required

Whether the action is a template.

​
secrets
object[] | null

The secrets required by the action

​
implementation
object
​
default_title
string | null

The default title of the action

Required string length: 1 - 100
​
display_group
string | null

The presentation group of the action

Required string length: 1 - 100
​
doc_url
string | null

Link to documentation

Required string length: 1 - 1000
​
author
string | null

Author of the action

Required string length: 1 - 100
​
deprecated
string | null

Marks action as deprecated along with message

Required string length: 1 - 1000
​
options
object

The options for the action

Was this page helpful?