Skip to main content
PATCH
/
registry
/
actions
/
{action_name}
Update Registry Action
curl --request PATCH \
  --url https://api.example.com/registry/actions/{action_name} \
  --header 'Content-Type: application/json' \
  --cookie fastapiusersauth= \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "secrets": [
    {
      "name": "<string>",
      "keys": [
        "<string>"
      ],
      "optional_keys": [
        "<string>"
      ],
      "optional": false
    }
  ],
  "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"
  },
  "default_title": "<string>",
  "display_group": "<string>",
  "doc_url": "<string>",
  "author": "<string>",
  "deprecated": "<string>",
  "options": {
    "include_in_schema": true
  }
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

fastapiusersauth
string
cookie
required

Path Parameters

action_name
string
required

Body

application/json

API update model for a registered action.

name
string | null

Update the name of the action

Required string length: 1 - 100
description
string | null

Update the description of the action

Maximum string length: 1000
secrets
RegistrySecret · object[] | null

Update the secrets of the action

interface
RegistryActionInterface · object

Update the interface of the action

implementation
RegistryActionTemplateImpl · object

Update the implementation of the action

default_title
string | null

Update the default title of the action

Required string length: 1 - 100
display_group
string | null

Update the display group of the action

Required string length: 1 - 100
doc_url
string | null

Update the doc url of the action

Required string length: 1 - 1000
author
string | null

Update the author of the action

Required string length: 1 - 100
deprecated
string | null

Update the deprecation message of the action

Required string length: 1 - 1000
options
RegistryActionOptions · object

Update the options of the action

Response

Successful Response