API Gateway

API Endpoints

apps

GET /apps

Gets all apps

Status Codes:
GET /apps/apis

Get all app apis

Query Parameters:
 
  • page (integer) – page of data to get
Status Codes:
POST /apps/apis

Create app api

Status Codes:
GET /apps/apis/{app}

Get and app’s api

Parameters:
  • app (string) – Name OR ID of the app to get
Status Codes:
PUT /apps/apis/{app}

Replace app api

Parameters:
  • app (string) – Name OR ID of the app to get
Status Codes:
DELETE /apps/apis/{app}

Delete app api

Parameters:
  • app (string) – Name OR ID of the app to get
Status Codes:

authorization

POST /auth

Login and get access and refresh tokens

Status Codes:
POST /auth/refresh

Get a fresh access token

Status Codes:
POST /auth/logout

Logout of walkoff

Status Codes:

configuration

GET /configuration

Reads the configuration

Status Codes:
PUT /configuration

Updates the configuration

Status Codes:
PATCH /configuration

Updates the configuration

Status Codes:

globals

GET /globals

Get all globals

Query Parameters:
 
  • page (integer) – page of data to get
  • to_decrypt (string) – Determine whether or not to decrypt global variable
Status Codes:
POST /globals

Add a global

Status Codes:
GET /globals/{global_var}

Read a global

Parameters:
  • global_var (string) – ID of the global to be fetched
Query Parameters:
 
  • to_decrypt (string) – Determine whether or not to decrypt global variable
Status Codes:
PUT /globals/{global_var}

Update a global

Parameters:
  • global_var (string) – ID of the global to be fetched
Status Codes:
DELETE /globals/{global_var}

Remove a global

Parameters:
  • global_var (string) – ID of the global to be fetched
Status Codes:
GET /globals/templates

Get all global templates

Query Parameters:
 
  • page (integer) – page of data to get
Status Codes:
POST /globals/templates

Add a global

Status Codes:
GET /globals/templates/{global_template}

Read a global template

Parameters:
  • global_template (string) – ID of the global template to be fetched
Status Codes:
PUT /globals/templates/{global_template}

Update a global template

Parameters:
  • global_template (string) – ID of the global template to be fetched
Status Codes:
DELETE /globals/templates/{global_template}

Remove a global

Parameters:
  • global_template (string) – ID of the global template to be fetched
Status Codes:

roles

GET /roles

Read all roles

Status Codes:
POST /roles

Create a role

Status Codes:
GET /roles/{role_id}

Read a role

Parameters:
  • role_id (string) – The name that needs to be fetched.
Status Codes:
PUT /roles/{role_id}

Update a role

Parameters:
  • role_id (string) – The name that needs to be fetched.
Status Codes:
DELETE /roles/{role_id}

Delete a role

Parameters:
  • role_id (string) – The name that needs to be fetched.
Status Codes:
GET /availableresourceactions

Read all available resource actions

Status Codes:

scheduler

GET /scheduler

Get the current scheduler status.

Status Codes:
PUT /scheduler

Update the status of the scheduler

Status Codes:
GET /scheduledtasks

Get all the scheduled tasks

Status Codes:
POST /scheduledtasks

Create a new Scheduled Task

Status Codes:
GET /scheduledtasks/{scheduled_task_id}

Get the scheduled task

Parameters:
  • scheduled_task_id (string) – The ID of the scheduled task.
Status Codes:
PUT /scheduledtasks/{scheduled_task_id}

Update a new Scheduled Task

Parameters:
  • scheduled_task_id (string) – The ID of the scheduled task.
Status Codes:
DELETE /scheduledtasks/{scheduled_task_id}

Delete the scheduled task

Parameters:
  • scheduled_task_id (string) – The ID of the scheduled task.
Status Codes:

users

GET /users

Read all users

Status Codes:
POST /users

Create a user

Status Codes:
GET /users/{user_id}

Get a user

Parameters:
  • user_id (integer) – The id of the user to be fetched
Status Codes:
PUT /users/{user_id}

Update a user

Parameters:
  • user_id (integer) – The id of the user to be fetched
Status Codes:
DELETE /users/{user_id}

Delete a user

Parameters:
  • user_id (integer) – The id of the user to be fetched
Status Codes:

workflows

GET /workflows

Read all workflows in playbook

Query Parameters:
 
  • page (integer) – page of data to get
Status Codes:
POST /workflows

Create a workflow

Query Parameters:
 
  • source (string) – The ID of the workflow to clone
Status Codes:
GET /workflows/{workflow}

Read a workflow

Parameters:
  • workflow (string) – The name or ID of the workflow to get.
Query Parameters:
 
  • mode (string) – Set to export to send as file.
Status Codes:
PUT /workflows/{workflow}

Update a workflow

Parameters:
  • workflow (string) – The name or ID of the workflow to get.
Status Codes:
DELETE /workflows/{workflow}

Delete a workflow

Parameters:
  • workflow (string) – The name or ID of the workflow to get.
Status Codes:

workflowqueue

GET /workflowqueue

Get status information on the workflows currently executing

Query Parameters:
 
  • page (integer) – page of data to get
Status Codes:
POST /workflowqueue

Execute a workflow

Status Codes:
GET /workflowqueue/{execution}

Get status information on a currently executing workflow

Parameters:
  • execution (string) – The ID of the execution to get.
Status Codes:
PATCH /workflowqueue/{execution}

Abort or trigger a workflow

Parameters:
  • execution (string) – The ID of the execution to get.
Status Codes:
DELETE /workflowqueue/cleardb

Removes workflow statuses from the execution database. It will delete all of them or ones older than a certain number of days

Query Parameters:
 
  • all (boolean) – Whether or not to delete all workflow statuses, defaults to false
  • days (integer) – The number of days of workflow statuses to keep
Status Codes:

dashboards

GET /dashboards

Read all dashboards

Retrieves all dashboards currently stored in the database.

Query Parameters:
 
  • page (integer) – page of data to get
Status Codes:
POST /dashboards

Create a dashboard

Creates a dashboard from the JSON in request body

Status Codes:
PUT /dashboards

Update a dashboard

Updates a whole dashboard using the JSON request body

Status Codes:
GET /dashboards/{dashboard}

Get a dashboard by id

Retrieve a single dashboard from database by ID.

Parameters:
  • dashboard (string) – ID of the global to be fetched
Status Codes:
DELETE /dashboards/{dashboard}

Delete a dashboard

Deletes a dashboard by ID

Parameters:
  • dashboard (string) – ID of the global to be fetched
Status Codes:

JSON Formulation