For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd GBAC to a job
        • POSTAdd watchers to a job
        • POSTAssign a task to a user
        • POSTBulk delete root jobs
        • POSTCancel jobs
        • POSTClaim a task
        • POSTClone automation
        • POSTContinue a job from a specified task
        • POSTCreate automation
        • POSTCreate trigger
        • DELDelete a root job and all related items
        • DELDelete automation
        • POSTDelete root jobs and related items
        • DELDelete trigger
        • DELDelete triggers by action ID
        • GETExport automation
        • GETExport large data for a job or task variable
        • GETExport trigger
        • POSTFinish a manual task
        • GETGet a job
        • GETGet a task by ID
        • GETGet automation
        • GETGet automations
        • GETGet event definition
        • GETGet jobs
        • GETGet manual task controller
        • GETGet tasks
        • GETGet trigger
        • GETGet triggers
        • PUTImport automations
        • PUTImport triggers
        • POSTPauses jobs
        • POSTRelease a currently assigned task
        • DELRemove all GBAC from a job
        • DELRemove GBAC from a job
        • PUTReplace all GBAC from a job with the provided list
        • POSTResume jobs
        • POSTRetry a task
        • POSTRevert a job
        • POSTRun endpoint trigger with POST
        • POSTRun manual trigger
        • GETSearch system events
        • POSTStart a job
        • POSTUnwatch job
        • POSTUnwatch jobs
        • PATCHUpdate automation
        • PATCHUpdate trigger
        • POSTValidate automation
        • POSTValidate trigger
        • POSTWatch a job
        • POSTWatch jobs
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceOperations Manager

Update automation

PATCH
http://localhost:3000/operations-manager/automations/:id
PATCH
/operations-manager/automations/:id
$curl -X PATCH http://localhost:3000/operations-manager/automations/id \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{}'
1{
2  "message": "Successfully created the requested item",
3  "data": {
4    "name": "Cisco IOS upgrade",
5    "description": "Turn up the port",
6    "componentType": null,
7    "createdBy": null,
8    "created": "2024-01-15T09:30:00Z",
9    "lastUpdatedBy": null,
10    "lastUpdated": "2024-01-15T09:30:00Z",
11    "_id": "string",
12    "gbac": {
13      "write": [
14        "string"
15      ],
16      "read": [
17        "string"
18      ]
19    },
20    "componentId": "string"
21  },
22  "metadata": {}
23}
Updates an Automation.
Was this page helpful?
Previous

Update trigger

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

idstringRequiredformat: "^[0-9a-f]{24}$"
The id of the Automation to update.

Request

updates
namestringOptional>=1 character
The name of the document
descriptionstringOptional
The description of the document
componentTypeany or nullOptional
The type of component linked to this Automation.
gbacobjectOptional
componentIdstring or any or nullOptional
The id of the component linked to this Automation.

Response

The result of the update operation.
messagestring

A human-readable message summarizing the result of the operation

dataany
Any successfully retrieved information related to the request.
metadatamap from strings to any

Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.

Errors

500
Internal Server Error