{
  "info": {
    "_postman_id": "e36171d2-9e12-4827-83a2-f1016540a043",
    "name": "New public APIs",
    "description": "New public APIs currently offering manual rules and templates functionality",
    "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json"
  },
  "item": [
    {
      "name": "Manual rules",
      "description": "This resource represents manually triggered rules. Use this to search for and invoke \nmanual rules.",
      "item": [
        {
          "name": "Search for manual rules",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/rule/manual/search",
              "query": [
                {
                  "key": "cursor",
                  "value": "{{cursor}}",
                  "disabled": false,
                  "description": "The pagination cursor to use to fetch a page of results.\n\nCursors are obtained via requests to the search API and should not be constructed manually."
                },
                {
                  "key": "limit",
                  "value": "{{limit}}",
                  "disabled": true,
                  "description": "Optional page size limit"
                }
              ],
              "variable": []
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Search for manually-triggered rules using the given query params.\n\n**Note:** Currently only `cursor` is allowed as parameter for the GET operation. \nUse the POST operation to perform the initial search.\n\n**Deprecated:** The `links` field in the response body has recently changed to return just the query parameters instead of absolute links. See [the changelog notice](/cloud/automation/api/changelog/#1-august-2025)."
          },
          "response": []
        },
        {
          "name": "Search for manual rules",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/rule/manual/search",
              "query": [],
              "variable": []
            },
            "method": "POST",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Search for manually-triggered rules using the given criteria via POST.\n\nCurrently only `issue` and `alert` objects are supported.\n\n**Deprecated:** The `links` field in the response body has recently changed to return just the query parameters instead of absolute links. See [the changelog notice](/cloud/automation/api/changelog/#1-august-2025).",
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        },
        {
          "name": "Invoke a manual rule",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/rule/manual/:ruleId/invocation",
              "query": [],
              "variable": []
            },
            "method": "POST",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Invoke a manual rule with one or more target objects and optional inputs.\nA rule will be executed for each target object provided.",
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        }
      ]
    },
    {
      "name": "Rule management",
      "description": "This resource represents rule management operations. Use this to:\n- search for rule summaries\n- get and create a rule\n- update and enable/disable a rule",
      "item": [
        {
          "name": "List rule summaries",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/rule/summary",
              "query": [
                {
                  "key": "cursor",
                  "value": "{{cursor}}",
                  "disabled": true,
                  "description": "The pagination cursor to use to fetch a page of results.\n\nThe first call should be made without a cursor. Cursors are returned in the response body \nand should not be constructed manually."
                },
                {
                  "key": "limit",
                  "value": "{{limit}}",
                  "disabled": true,
                  "description": "Optional page size limit"
                }
              ],
              "variable": []
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Get rule summaries for all rules.\n\n**Deprecated:** The `links` field in the response body has recently changed to return just the query parameters instead of absolute links. See [the changelog notice](/cloud/automation/api/changelog/#1-august-2025)."
          },
          "response": []
        },
        {
          "name": "Search for rule summaries",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/rule/summary",
              "query": [],
              "variable": []
            },
            "method": "POST",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Get rule summaries for rules that match the given criteria via POST.\n\nSupports filtering by trigger, rule state, and rule scope (single ARI).\n\n**Deprecated:** The `links` field in the response body has recently changed to return just the query parameters instead of absolute links. See [the changelog notice](/cloud/automation/api/changelog/#1-august-2025).",
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        },
        {
          "name": "Create a new rule",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/rule",
              "query": [],
              "variable": []
            },
            "method": "POST",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "description": "Create a new rule from the provided Rule Payload.\n\nIf providing a UUID for your new rule, it must be unique and V7. The time-based nature of V7 will impact sorting and pagination of your rule.\n\nAccepts a rule payload, which has the same structure as the get a rule by UUID response.",
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        },
        {
          "name": "Get a rule by UUID",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/rule/:ruleUuid",
              "query": [
                {
                  "key": "redactSensitiveFields",
                  "value": "{{redactSensitiveFields}}",
                  "disabled": true,
                  "description": "Indicates if sensitive fields, such as the hidden header values in the send web request action, in the rule config should be redacted. If not set, no fields will be redacted."
                }
              ],
              "variable": [
                {
                  "key": "ruleUuid",
                  "value": "{{ruleUuid}}",
                  "description": "The UUID of the rule to retrieve",
                  "disabled": false
                }
              ]
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Performs a request to retrieve the rule with the provided UUID.\nThis includes the rule payload, trigger, components, and other metadata."
          },
          "response": []
        },
        {
          "name": "Update an existing rule",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/rule/:ruleUuid",
              "query": [],
              "variable": [
                {
                  "key": "ruleUuid",
                  "value": "{{ruleUuid}}",
                  "description": "The UUID of the rule to update",
                  "disabled": false
                }
              ]
            },
            "method": "PUT",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Updates an existing rule by accepting a rule payload, which has the same structure as the get a rule by UUID response.\nComponentIds are only required for pre-existing components.\nNew components will be created or deleted as needed.",
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        },
        {
          "name": "Delete disabled rule",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/rule/:ruleUuid",
              "query": [],
              "variable": [
                {
                  "key": "ruleUuid",
                  "value": "{{ruleUuid}}",
                  "description": "The UUID of the rule to delete",
                  "disabled": false
                }
              ]
            },
            "method": "DELETE",
            "header": [],
            "description": "Delete a disabled rule by UUID."
          },
          "response": []
        },
        {
          "name": "Enable or disable a rule",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/rule/:ruleUuid/state",
              "query": [],
              "variable": []
            },
            "method": "PUT",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "description": "Enable or disable a rule by rule UUID.",
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        },
        {
          "name": "Update rule scope",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/rule/:ruleUuid/rule-scope",
              "query": [],
              "variable": []
            },
            "method": "PUT",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "description": "Update the scope of a rule by UUID.",
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        }
      ]
    },
    {
      "name": "Templates",
      "description": "This resource represents automation templates. Use this to search for templates, and \ncreate rules from a template.",
      "item": [
        {
          "name": "Get template by template ID",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/template/:templateId",
              "query": [],
              "variable": [
                {
                  "key": "templateId",
                  "value": "{{templateId}}",
                  "description": "The ID of the template to retrieve",
                  "disabled": false
                }
              ]
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Performs a request to retrieve the metadata associated with the provided template ID.\nThis includes any parameters the template has."
          },
          "response": []
        },
        {
          "name": "Search for templates",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/template/search",
              "query": [
                {
                  "key": "cursor",
                  "value": "{{cursor}}",
                  "disabled": true,
                  "description": "The pagination cursor to use to fetch a page of results.\n\nCursors are obtained via requests to the search API and should not be constructed manually."
                },
                {
                  "key": "limit",
                  "value": "{{limit}}",
                  "disabled": true,
                  "description": "Optional page size limit"
                },
                {
                  "key": "categories",
                  "value": "{{categories}}",
                  "disabled": true,
                  "description": "Optional categories filter parameter"
                },
                {
                  "key": "ruleHome",
                  "value": "{{ruleHome}}",
                  "disabled": true,
                  "description": "If provided, only templates that apply to the ruleHome represented by the ARI will be returned.\n\nUsed to limit results to templates applicable for a given project or product etc."
                }
              ],
              "variable": []
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Search for templates rules using the given query params.\n\nAccepts either a combination of filter parameters, or a cursor, but not both.\n\n**Deprecated:** The `links` field in the response body has recently changed to return just the query parameters instead of absolute links. See [the changelog notice](/cloud/automation/api/changelog/#1-august-2025)."
          },
          "response": []
        },
        {
          "name": "Search for templates",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/template/search",
              "query": [],
              "variable": []
            },
            "method": "POST",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Search for templates using the given criteria via POST.\n\nCurrently `categories` and `ruleHome ARI` filters are supported.\n\n**Deprecated:** The `links` field in the response body has recently changed to return just the query parameters instead of absolute links. See [the changelog notice](/cloud/automation/api/changelog/#1-august-2025).",
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        },
        {
          "name": "Create a rule from a template",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}rest/v1/template/create",
              "query": [],
              "variable": []
            },
            "method": "POST",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Create a rule from a template. This template may optionally accept parameters.",
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        }
      ]
    }
  ],
  "variable": [
    {
      "key": "protocol",
      "name": "Protocol",
      "description": "The HTTP Protocol that should be used for this REST API.",
      "type": "string",
      "value": "https"
    },
    {
      "key": "host",
      "name": "Host",
      "description": "The HTTP host that should be used for this REST API.",
      "type": "string",
      "value": "api.atlassian.com"
    },
    {
      "key": "basePath",
      "name": "Base Path",
      "description": "The path, after the host, of the base of the REST API.",
      "type": "string",
      "value": "automation/public/%7Bproduct%7D/%7Bcloudid%7D/"
    }
  ]
}