Snapvisor Docs
API ReferenceAutomations

List a project's automation rules

List the automation rules of a project, most recent first. Requires administrator access to the project. Use it to see which actions, such as Slack messages, a project runs automatically on build events.

GET
/projects/{owner}/{project}/automation-rules

List the automation rules of a project, most recent first. Requires administrator access to the project. Use it to see which actions, such as Slack messages, a project runs automatically on build events.

Authorization

AuthorizationBearer <token>

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

In: header

Path Parameters

owner*string
Length1 <= length
project*string
Length1 <= length

Query Parameters

perPage?string

Number of items per page (max 100)

page?string

Page number

active?string

Restrict to rules that still fire (true) or to deactivated ones (false). Omit for both.

Value in

  • "true"
  • "false"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/string/automation-rules"
{  "pageInfo": {    "total": 0,    "page": 0,    "perPage": 0  },  "results": [    {      "id": "string",      "name": "string",      "active": true,      "events": [        "build.completed"      ],      "conditions": [        {          "type": "build-branch",          "value": "string"        }      ],      "actions": [        {          "action": "string",          "actionPayload": {            "property1": null,            "property2": null          }        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Exchange a tokenless GitHub Actions token for a Snapvisor token POST

Called by GitHub Actions to exchange a tokenless bearer token for a short-lived Snapvisor project token. The provided commit and branch must match the GitHub workflow run.

Create an automation rule POST

Create an automation rule on a project. Requires administrator access to the project. Action targets must belong to the project's account. Use it when the user wants a project to react automatically to build events, for example by posting to Slack.