applications

Update an app action

Update one application action

patch/applications/{app_id}/actions/{action_id}

Request

Base URL
https://api.webscale.com/v2
Auth
none declared
TypeScript
https://skmtc.dev/webscale/apis/webscale-apis/docs/applications/:app_id/actions/:action_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

app_idstring required

Application id

action_idstring required

Action id

Request body

urlstring

An http/https URL giving the address of the agent receiving the request to initiate the action

namestring

A human-readable name. If not specified, a name will be generated from the id

http_methodstring

The request method name to be used when making the action request to an agent. Usually POST. Defaults to POST

descriptionstring

A textual description of an action. This should describe the effect of the action because it will be presented to the operator who requests running the action before confirming it

secret_keystring

A key used to sign requests made to an agent. This is 44 characters (32-bytes, base64-encoded). If not specified, a secret will be generated at creation

certificatesstring

A chain of PEM-encoded certificates that can be used to authenticate the agent receiving action requests. If the agent uses a publicly valid X509 certificate that matches the hostname specified in its URL, then this is not needed. This is necessary for self-signed certificates using HTTPS, because the agent is always authenticated. Multiple certificates may be used, for example, when migrating from one certificate to another

Response

The action was successfully updated.

idstring required

An unchanging identifier for an action that is used when creating a task to run it. All action ids for a subject must be unique

urlstring required