--- title: "Update Security Playbook Run" method: PUT path: "/security-playbook-run/{id}" tags: ["Security Playbook Run"] --- # Update Security Playbook Run `PUT /security-playbook-run/{id}` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/security-playbook-run/{id}` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to update an existing Security Playbook Run ## Path parameters - `id` string, uuid, required ## Request body - object - `data` SecurityPlaybookRunUpdateSchema, required: Update schema for SecurityPlaybookRun model. Update ## Response `200` Updated successfully - object - `data` SecurityPlaybookRunReadSchema: Read schema for SecurityPlaybookRun model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Run Security Playbook], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [Project Owner, Project Admin, Security Admin, Security Member, Approve Security Playbook Steps] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Run Security Playbook], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [Project Owner, Project Admin, Security Admin, Security Member, Approve Security Playbook Steps] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Run Security Playbook], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [Project Owner, Project Admin, Security Admin, Security Member, Approve Security Playbook Steps] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Run Security Playbook], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [Project Owner, Project Admin, Security Admin, Security Member, Approve Security Playbook Steps] - `projectId` string, uuid: ID of the project this run belongs to. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Run Security Playbook], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `securityCaseId` string, uuid, required: ID of the case the playbook runs on. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Run Security Playbook], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `securityPlaybookId` string, uuid, required: ID of the playbook being run. Permissions - Create: [Project Owner, Project Admin, Security Admin, Security Member, Run Security Playbook], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `playbookName` string: The playbook's name when the run started, kept if the playbook is renamed or deleted. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `trigger` 'Case Opened' | 'Detection Added' | 'Triaged as Likely Malicious' | 'Manual': What started the run: Case Opened, Detection Added, or Manual for a person. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `triggeredByUserId` string, uuid: ID of the person who ran the playbook. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `status` 'Queued' | 'Running' | 'Waiting for Approval' | 'Succeeded' | 'Failed' | 'Cancelled': Queued, Running, Waiting for Approval, Succeeded, Failed or Cancelled. Set it to Cancelled to stop a run that has not finished. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [Project Owner, Project Admin, Security Admin, Security Member, Approve Security Playbook Steps] - `steps` object: The playbook's steps as they were when the run started. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `stepResults` object: What each step did: its status, when it started and finished, what it reported, and who decided on its approval. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `currentStepIndex` number: The step the run is on, counting from 0. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `threatIntelMatched` boolean: Whether a Check Threat Intel step of this run found a known-bad entity. Steps set to run only on a match read it. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `startedAt` object: When the run started its first step. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `completedAt` object: When the run finished, failed or was cancelled. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `errorMessage` string: Why the run failed, when it did. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `createdByUserId` string, uuid: ID of the person who started the run. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] - `deletedByUserId` string, uuid: Unused: runs are not deleted. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Security Playbook Run], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)