ONoneuptime
Security Playbook Run

Get Security Playbook Run

Endpoint to retrieve a single Security Playbook Run by ID

post/security-playbook-run/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Security Playbook Run to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "playbookName": true,
    "trigger": true,
    "status": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "securityCaseId": "123e4567-e89b-12d3-a456-426614174000",
    "securityPlaybookId": "123e4567-e89b-12d3-a456-426614174000",
    "playbookName": "Example short text",
    "trigger": "Case Opened",
    "triggeredByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "Queued",
    "steps": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "stepResults": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "currentStepIndex": 42,
    "threatIntelMatched": true,
    "startedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "completedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "errorMessage": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

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