Skip to main content
GET
Error

Authorizations

fastapiusersauth
string
cookie
required

Path Parameters

action_name
string
required

Response

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 string 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
RegistryActionInterface · object
required
implementation
RegistryActionTemplateImpl · object
required
repository_id
string<uuid4>
required

The repository id

id
string<uuid4>
required

The registry action id

action
string
required
read-only

The full action identifier.

is_template
boolean
required
read-only

Whether the action is a template.

secrets
(RegistrySecret · object | RegistryOAuthSecret · object)[] | null

The secrets required by the action

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
RegistryActionOptions · object

The options for the action