nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Help needed with The Automation REST API's

Peter Rossum_ van

I try to create a Automation Rule with the REST API's
The Automation REST API
Getting an existing (example) rule by UID works fine using a personal API token as OAth2 or scoped does not work. But, okay with a personal token I can go on.
So, using the data from that example rule I try te create a new rule.
However I get the "bad request' error.
Before I copy the whole body in here, are there any simple things I can check?
The questions hat come to my mind are:
Should I pass optional properties as null values or empty arrays, or can I simply leave them out?
And should I also add a new UID for the new rule, or is that created when posting?
For the example rule that I use to copy, there are no connections used for the components. Is that okay?
Is de order of the properties an issue? Is is essential that those properties are like the documenation os the API?
So....
Is there anyone that has some expirence with creating an Automation Rule using this API?

Accepted answers

Marc -Devoteam-

Hi @Peter Rossum_ van

Can you show the full rule and in details alls ateps in your rule.

Also show the audit log, what is that revieling.

Also what API cal you using, not al API endpoints can be used. Using a scoped token requires right permissions and scopes.

All comments

Mark B Wager

Hi Peter

Can you provide a screenshot? I'm struggling to understand exactly what you're trying to do.

Are you asking if anyone has successfully created a new Jira "Automation" rule via the Automation REST API, and what common gotchas cause a 400 Bad Request when you copy an existing rule’s JSON and POST it?

EXAMPLE:

POST

/gateway/api/automation/public/{product}/{cloudId}/rest/v1/rule

Ref: community.atlassian.com/forums/Automation-articles

ANSWER:
Not all auth methods work.

Works

Personal API token (user-based)
Must be a user with permission to create automation rules (project admin or Jira admin, depending on scope)

Does NOT work

OAuth 2.0 (3LO)
Forge apps
App-scoped tokens

Atlassian explicitly documents that Forge and OAuth2 apps cannot access these rule management endpoints. [developer....assian.com]

Marc -Devoteam-

Hi @Peter Rossum_ van

Can you show the full rule and in details alls ateps in your rule.

Also show the audit log, what is that revieling.

Also what API cal you using, not al API endpoints can be used. Using a scoped token requires right permissions and scopes.

Peter Rossum_ van

Marc,
Thanks for the response.
Here is my info.

I first retreive an example rule (that is present in Confluence) with this endpoint:

https://api.atlassian.com/automation/public/confluence/$($cloudID)/rest/v1/rule/$($ruleId)

That works fine

I use this endpoint to post a new rule:

https://api.atlassian.com/automation/public/confluence/$($cloudID)/rest/v1/rule

I created the body by copying it from the example rule and changed a few things regarding the ruleScopeARIs.

Finaly I POST this body:
(I initialy set the rule on DISABLED to prevent inmediate executing)

{
"connections": [],
"rule": {
    "authorAccountId": "<copy-from-example>",
    "actor": {
       "type": "ACCOUNT_ID",
       "actor": "<copy-from-example>"
    },
    "notifyOnError": "FIRSTERROR",
    "labels": [],
    "trigger": {
        "component": "TRIGGER",
        "schemaVersion": 1,
        "type": "confluence.page-updated.trigger",
        "value": {
            "eventFilters": [
            "ari:cloud:confluence:$($cloudID):space/<TargetSpaceID>"
            ],
            "enableAdminKey": false
        },
        "connectionId": null,
        "conditions": []
    },
    "uuid": "<new-UUID>",
    "state": "DISABLED",
    "description": "This rule sets the page status to 'Rough draft' when a page is updated and has no status.",
    "ruleScopeARIs": [
        "ari:cloud:confluence:$($cloudID):space/<TargetSpaceID>"
    ],
    "collaborators": [],
    "components": [
      {
        "component": "CONDITION",
        "schemaVersion": 1,
        "type": "platform.comparator.condition",
        "value": {
            "first": "{{page.status}}",
            "second": "",
            "operator": "EQUALS"
        },
        "connectionId": null,
        "conditions": [],
        "parentId": null,
        "conditionParentId": null,
        "children": []
      },
      {
        "component": "ACTION",
        "schemaVersion": -1,
        "type": "confluence.change-page-status.action",
        "value": {
            "pageStatus": {
            "color": "#ffc400",
            "id": "5017600463",
            "label": "Rough draft"
            }
        },
        "connectionId": null,
        "conditions": [],
        "parentId": null,
        "conditionParentId": null,
        "children": []
      }
    ],
    "name": "Test rule PvR",
    "writeAccessType": "OWNER_ONLY",
    "canOtherRuleTrigger": false
  }
}

The result is:

{ "timestamp": "2026-03-24T10:40:50.423\u002B00:00", "status": 400, "error": "Bad Request", "path": "/pro/public/rest/v1/rule" }

Marc -Devoteam-

Hi @Peter Rossum_ van

Did you replace {cloudid} with your cloudid, gotten via using "https://your-site-name.atlassian.net/_edge/tenant_info"

Peter Rossum_ van

Yes I did.
The API to get the example Rule from Confluence works.
But the API to create a new one does not work.

Peter Rossum_ van

@Mark B Wager ,
I am aware of that.
The API to get the example Rule from Confluence DOES work.
But the API to create a new one does not work.
(see above thread with Marc)

Peter Rossum_ van

@Mark B Wager
B.t.w... I try to create a rule within(!) a Confluence Space. For that I asume I need admin permission for that space.
On the other hand, I am also a Confluence Admin. But I do not want to create a global rule, just a rule inside a space.

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

rest-api

automation