{ "opencollection": "1.0.0", "info": { "name": "Fleet Application Management Service Fleet Apps Management Runbooks API", "version": "20250228" }, "items": [ { "info": { "name": "fleetAppsManagementRunbooks", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all versions for a runbook in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/runbookVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources.\nEmpty only if the resource OCID query param is not specified.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "name": "runbookId", "value": "", "type": "query", "description": "A filter to return only schedule definitions whose associated runbookId matches the given runbookId." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return runbook versions whose identifier matches the given identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." } ] }, "docs": "List versions for a runbook in Fleet Application Management.\n" }, { "info": { "name": "Creates a new Runbook Version", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/runbookVersions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add RunbookVersion in Fleet Application Management.\n" }, { "info": { "name": "Import a RunbookVersion", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/runbookVersions/actions/import", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Export the specified version of the runbook.\n" }, { "info": { "name": "Get RunbookVersion", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/runbookVersions/:runbookVersionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runbookVersionId", "value": "", "type": "path", "description": "Unique Runbook Version identifier" } ] }, "docs": "Gets a Runbook Version by identifier." }, { "info": { "name": "Update the RunbookVersion identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/runbookVersions/:runbookVersionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runbookVersionId", "value": "", "type": "path", "description": "Unique Runbook Version identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the RunbookVersion." }, { "info": { "name": "Delete a provisioned Runbook Version", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/runbookVersions/:runbookVersionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runbookVersionId", "value": "", "type": "path", "description": "Unique Runbook Version identifier" } ] }, "docs": "Removes a Runbook Version from the runbook in Fleet Application Management." }, { "info": { "name": "Export a RunbookVersion", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/runbookVersions/:runbookVersionId/actions/export", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runbookVersionId", "value": "", "type": "path", "description": "Unique Runbook Version identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Export the specified version of the runbook.\n" }, { "info": { "name": "Gets a list of all Runbooks in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/runbooks", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources.\nEmpty only if the resource OCID query param is not specified.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single Runbook by id.\nEither compartmentId or id must be provided.\n" }, { "name": "type", "value": "", "type": "query", "description": "A filter to return runbooks whose type matches the given type." }, { "name": "platform", "value": "", "type": "query", "description": "A filter to return runbooks whose platform matches the given platform." }, { "name": "operation", "value": "", "type": "query", "description": "A filter to return runbooks whose operation matches the given lifecycle operation." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of all the runbooks in the specified compartment.\nThe query parameter `compartmentId` is required unless the query parameter `id` is specified.\n" }, { "info": { "name": "Creates a Runbook", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/runbooks", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a runbook.\n" }, { "info": { "name": "Find runbook export Dependencies", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/runbooks/actions/findExportDependencies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Find runbook export Dependencies\n" }, { "info": { "name": "Find runbook import Dependencies", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/runbooks/actions/findImportDependencies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Find runbook import Dependencies\n" }, { "info": { "name": "Import a Runbook", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/runbooks/actions/import", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Import the specified version of the runbook.\n" }, { "info": { "name": "Precheck Runbook import", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/runbooks/actions/importPrecheck", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Precheck for import runbook.\n" }, { "info": { "name": "Publish a Runbook", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/runbooks/actions/publishRunbook", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Publish the specified version of the runbook.\nThe specified version of the runbook becomes acitve when it is published.Only active versions of runbook can be used in execution.\n" }, { "info": { "name": "Set a runbook as default for a platform and operation.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/runbooks/actions/setDefaultRunbook", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set a runbook as default.\n" }, { "info": { "name": "Gets a list of Runbook export status.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/runbooks/exportStatus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single Runbook by id.\nEither compartmentId or id must be provided.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of all the Runbook export status in the specified compartment.\nThe query parameter `compartmentId` is required.\n" }, { "info": { "name": "Gets a list of Runbook import status.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/runbooks/importStatus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single Runbook by id.\nEither compartmentId or id must be provided.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of all the Runbook import status in the specified compartment.\nThe query parameter `compartmentId` is required.\n" }, { "info": { "name": "Get Runbook", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/runbooks/:runbookId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runbookId", "value": "", "type": "path", "description": "Unique Runbook identifier" } ] }, "docs": "Get the details of a runbook in Fleet Application Management." }, { "info": { "name": "Update the Runbook specified by the identifier", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/runbooks/:runbookId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runbookId", "value": "", "type": "path", "description": "Unique Runbook identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the runbook specified by the identifier." }, { "info": { "name": "Delete a provisioned Runbook", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/runbooks/:runbookId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runbookId", "value": "", "type": "path", "description": "Unique Runbook identifier" } ] }, "docs": "Deletes a runbook specified by the identifier." }, { "info": { "name": "Moves a Runbook into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/runbooks/:runbookId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "runbookId", "value": "", "type": "path", "description": "Unique Runbook identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Runbook into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Export a Runbook", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/runbooks/:runbookId/actions/export", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runbookId", "value": "", "type": "path", "description": "Unique Runbook identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Export the specified version of the runbook.\n" }, { "info": { "name": "Get Runbook export status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/runbooks/:runbookId/exports/:exportId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runbookId", "value": "", "type": "path", "description": "Unique Runbook identifier" }, { "name": "exportId", "value": "", "type": "path", "description": "Unique tracking identifier to fetch runbook export status" } ] }, "docs": "Get the runbook export status for provided runbook and exportId." }, { "info": { "name": "Get Runbook import status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/runbooks/:runbookId/imports/:importId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runbookId", "value": "", "type": "path", "description": "Unique Runbook identifier" }, { "name": "importId", "value": "", "type": "path", "description": "Unique tracking identifier to fetch runbook import status" } ] }, "docs": "Get the runbook import status for provided runbook and importId." }, { "info": { "name": "Gets a list of all task records in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/taskRecords", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources.\nEmpty only if the resource OCID query param is not specified.\n" }, { "name": "platform", "value": "", "type": "query", "description": "The platform for the task record." }, { "name": "type", "value": "", "type": "query", "description": "The type of the Task." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "operation", "value": "", "type": "query", "description": "A filter to return task records whose operation matches the given lifecycle operation." }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single task record by id.\nEither compartmentId or id must be provided.\n \n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the task record." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Returns a list of all the task records in the specified compartment.\nThe query parameter `compartmentId` is required unless the query parameter `id` is specified.\n" }, { "info": { "name": "Creates a new task record.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/taskRecords", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new task record.\n" }, { "info": { "name": "Get task tecord.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/taskRecords/:taskRecordId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "taskRecordId", "value": "", "type": "path", "description": "The OCID of the task record." } ] }, "docs": "Gets information for the specified task record." }, { "info": { "name": "Updates certain attributes for the specified task record.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/taskRecords/:taskRecordId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "taskRecordId", "value": "", "type": "path", "description": "The OCID of the task record." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates certain attributes for the specified task record." }, { "info": { "name": "Deletes the task record specified by an identifier.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/taskRecords/:taskRecordId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "taskRecordId", "value": "", "type": "path", "description": "The OCID of the task record." } ] }, "docs": "Deletes the task record specified by an identifier." }, { "info": { "name": "Moves a task record into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/taskRecords/:taskRecordId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "taskRecordId", "value": "", "type": "path", "description": "The OCID of the task record." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a task record into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" } ] } ], "bundled": true }