curl --request GET \
--url https://api.example.com/registry/actions/{action_name} \
--cookie fastapiusersauth={
"name": "<string>",
"description": "<string>",
"namespace": "<string>",
"type": "udf",
"origin": "<string>",
"interface": {
"expects": {},
"returns": "<unknown>"
},
"implementation": {
"template_action": {
"definition": {
"name": "<string>",
"namespace": "<string>",
"title": "<string>",
"display_group": "<string>",
"expects": {},
"steps": [
{
"ref": "<string>",
"action": "<string>",
"args": {}
}
],
"returns": "<string>",
"description": "",
"doc_url": "<string>",
"author": "<string>",
"deprecated": "<string>",
"secrets": [
{
"name": "<string>",
"keys": [
"<string>"
],
"optional_keys": [
"<string>"
],
"optional": false
}
]
},
"type": "action"
},
"type": "template"
},
"repository_id": "<string>",
"id": "<string>",
"action": "<string>",
"is_template": true,
"secrets": [
{
"name": "<string>",
"keys": [
"<string>"
],
"optional_keys": [
"<string>"
],
"optional": false
}
],
"default_title": "<string>",
"display_group": "<string>",
"doc_url": "<string>",
"author": "<string>",
"deprecated": "<string>",
"options": {
"include_in_schema": true
}
}Get a specific registry action.
curl --request GET \
--url https://api.example.com/registry/actions/{action_name} \
--cookie fastapiusersauth={
"name": "<string>",
"description": "<string>",
"namespace": "<string>",
"type": "udf",
"origin": "<string>",
"interface": {
"expects": {},
"returns": "<unknown>"
},
"implementation": {
"template_action": {
"definition": {
"name": "<string>",
"namespace": "<string>",
"title": "<string>",
"display_group": "<string>",
"expects": {},
"steps": [
{
"ref": "<string>",
"action": "<string>",
"args": {}
}
],
"returns": "<string>",
"description": "",
"doc_url": "<string>",
"author": "<string>",
"deprecated": "<string>",
"secrets": [
{
"name": "<string>",
"keys": [
"<string>"
],
"optional_keys": [
"<string>"
],
"optional": false
}
]
},
"type": "action"
},
"type": "template"
},
"repository_id": "<string>",
"id": "<string>",
"action": "<string>",
"is_template": true,
"secrets": [
{
"name": "<string>",
"keys": [
"<string>"
],
"optional_keys": [
"<string>"
],
"optional": false
}
],
"default_title": "<string>",
"display_group": "<string>",
"doc_url": "<string>",
"author": "<string>",
"deprecated": "<string>",
"options": {
"include_in_schema": true
}
}Successful Response
API read model for a registered action.
The name of the action
1 - 100The description of the action
1000The namespace of the action
The type of the action
udf, template The origin of the action as a url
1 - 1000Show child attributes
Show child attributes
The repository id
The registry action id
The full action identifier.
Whether the action is a template.
The secrets required by the action
Show child attributes
The default title of the action
1 - 100The presentation group of the action
1 - 100Link to documentation
1 - 1000Author of the action
1 - 100Marks action as deprecated along with message
1 - 1000The options for the action
Show child attributes
Was this page helpful?