ONoneuptime
Security Playbook Run

Create Security Playbook Run

Endpoint to create a new Security Playbook Run

post/security-playbook-run

Request

Request body

Example request

{
  "data": {
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "securityCaseId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "securityPlaybookId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}

Response

Created successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "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"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "securityCase": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "securityCaseId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "securityPlaybook": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "securityPlaybookId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "playbookName": "Example Text",
    "trigger": "Example Text",
    "triggeredByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "triggeredByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "status": "Example Text",
    "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 longer text content that provides detailed information.",
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "deletedByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "deletedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}

Changes

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