Get Mapped Runbooks
| API | runbooks |
| Purpose | To fetch the mapped runbook to all modules. |
| API URL | https://<API URL>:<API Port>/v2/runbook/orgentityid/{orgentityid} |
| Authentication type | Basic/Token |
| Method Type | GET |
| Input Params in Query String: |
You can pass the following filters in the URL to get desired data: · orgentityid |
Parameters Required in Request body of API
| Column | Column type | Remarks |
| orgentityid | string | The organization entity ID. |
Output:
{
"Status": "Success",
"Message": "Runbooks Fetched successfully",
"Count": 1,
"Result": [
{
"RunbookId": "",
"RunbookToolId": "",
"RunbbokUniqueName": null,
"RunbookUserFriendlyName": "my_Runbook_Name",
"RunbookDescription": "my runbook description.",
"AffectedCICategory": "myCICategory",
"AffectedCISubCategory": "myCISubCategory",
"AffectedCICategoryGranularDetails": "",
"RunbookCategory": "myCategory",
"RunbookAction": "myACtion",
"RunbookTags": "myTags",
"CanBeAutoExecuted": "N",
"RunbbokPath": null,
"TicketNumber": null,
"CreatedFromScript": null,
"ScriptPath": null,
"IsRepositoryRunbook": null,
"UpdateFrequencyInterval": "SS",
"UpdateFrequency": "15",
"NumberOfAttempts": "30",
"IsPushRBAStatus": null,
"IsAdditionalInfo": null,
"IsActive": "Y",
"IsCustom": null,
"CreatedBy": null,
"CreatedDate": "2025-04-10T07:07:57.117",
"ModifiedBy": "47",
"ModifiedDate": "2025-04-16T12:06:14.607",
"RunbookFriendlyDescription": "my runbook description",
"MasterRunbookName": "",
"IsScriptRunbook": "N",
"ResponseFilePath": "my_Path",
"WaitFrequencyInterval": "30",
"WaitFrequency": "30",
"ManualExecutionTimeinMinutes": "20",
"RunbookAutoThresold": null,
"StatusUpdateWaitFrequencyInMin": "15",
"TemplateType": null,
"RunbookToolTypeId": "9",
"NamedEntity": null,
"AutoExecutionTimeInMinutes": "6",
"RunbookFileName": null,
"RunbookFilePath": null,
"RunbookToolOrgName": "",
"PythonFileName": "",
"YAMLFileName": "",
"DirectoryName": "",
"ValutKeyForSDK": null,
"Version": null,
"Mode": "Approved",
"RBAToolRole": null,
"Flag": "Y",
"RunbookParameter":
{
"Parameter":
[
{
"RunbookParamId": "",
"RunbookId": "",
"RunbookParam": "myParam",
"RunbookParamUserFriendlyName": "myParamName", "RunbookParamDescription": "myParamDesciption", "RunbookParamDefaultValue": "myValue",
"IsMandatory": "Y",
"RunbookParamDisplayType": "Text",
"RunbookParameterTypeId": "4",
"IsActive": "Y",
"IsReadOnlyParam": "N",
"IsCIBasedParameter": "Y"
}
]
}
}
]
}
Parameters Returned in Response of API
| Column | Column type | Value | Remarks |
| Count | string | Count of runbooks | Totally count of the runbooks. |
| Result | JSON | All mapped runbooks | Provides all runbooks mapped to organization along with parameters |
| Status | string | Success/Fail | status. |
| Message | string | Runbooks Fetched successfully | info. |