Action Runs

Execute a self-service action

This route allows you to execute a self-service action, thus creating an action run.<br/><br/>To learn more about action runs, check out the documentation.

post/v1/actions/{action_identifier}/runs

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/actions/{action_identifier}/runs
  • Auth: API key in header Authorization

Path parameters

action_identifierstring required

The identifier of the action/automation you want to operate on.

Query parameters

run_asstring email

The executing user of the action. If not provided, the action will be run on behalf of the user/machine who initiated the action (identified by the bearer token used to execute this route).

Request body

propertiesobject required

The action's user inputs, in "key":"value" pairs, where the key is the input's identifier and the value is the input's value.

entitystring

The identifier of the entity that the action will be executed on, if relevant.

Response

OK

okunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.