Add a log to an action run

POST 
/v1/actions/runs/:run_id/logs

This route allows you to send a log message back to Port, which will be displayed in the action run's page. You can also use this route to update the run's termination status (SUCCESS/FAILURE) and label describing the status.

To learn more about action runs, check out the documentation.

Request

Path Parameters

run_id stringrequired

application/json

Body

required

terminationStatusstring

The termination status of the action run. Can be left blank if you only want to send a log message.


Possible values: [SUCCESS, FAILURE]

statusLabelstring

A label to describe the status of the action run. Can be left blank if you only want to send a log message.


messagestringrequired

The log message to send back to Port.

Responses

201

Added successfully.

application/json

Schema

Schema

okanyrequired

Possible values: [true]

runLog

object

idstringrequired

runIdstringrequired

messagestringrequired

createdBystringrequired

createdAtdate-timerequired

Example (from schema)

{
  "ok": true,
  "runLog": {
    "id": "string",
    "runId": "string",
    "message": "string",
    "createdBy": "string",
    "createdAt": "2024-07-29T15:51:28.071Z"
  }
}

404

One of the following errors occurred:

Error	Description
not_found	The action run with the provided identifier was not found

422

One of the following errors occurred:

Error	Description
invalid_request	The data provided does not match the route schema
run_exhausted	Action run already finished execution

500

One of the following errors occurred:

Error	Description
internal_error	An internal error occurred