Getting Started

Features

Configuration

Introduction

The Script Console is the place for running one-off ad hoc scripts, and for learning and experimenting with the Confluence REST API from ScriptRunner.

script console

Run As User

Script Console can make requests back to Confluence using either the ScriptRunner Add-on user or the user that performed the action to cause the event to be fired. This is useful if you want specific actions (e.g: creating a page) to have the creator as being the current user or a generic ScriptRunner Add-on user

Examples

Get Spaces

What does it do?

It fetches and displays all spaces from an instance.

Why should you use it?

It can be used as a starting point for an automation, for example if you want to delete all spaces that are older than a specific date.

script console get spaces

Create Space

What does it do?

It creates a Space with a space name, key and a description.

Why should you use it?

It could be used rapidly create a number of spaces for different teams during your Confluence setup.

script console create space

Delete Space

What does it do?

It deletes a Space with a certain key.

Why should you use it?

This could be used to rapidly delete multiple old irrelevant spaces or used to periodically delete a space that has been used for archiving.

script console delete space

Get Template Blueprints

What does it do?

This script fetches a template blueprint so that you can automate off it.

Why should you use it?

Combined with the create page example, you can create a page with a specific template.

script console get template blueprints