{ "info": { "_postman_id": "40a8bbaf-25f5-4821-bc62-a879f2ccc605", "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": "Rest", "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." }, "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.", "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": "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." }, "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.", "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/" } ] }