API Gateway¶
API Endpoints¶
apps¶
-
GET
/apps/apis
¶ Get all app apis
Query Parameters: - page (integer) – page of data to get
Status Codes: - 200 OK – Success
-
GET
/apps/apis/{app}
¶ Get and app’s api
Parameters: - app (string) – Name OR ID of the app to get
Status Codes: - 200 OK – Success
- 404 Not Found – App does not exist
-
PUT
/apps/apis/{app}
¶ Replace app api
Parameters: - app (string) – Name OR ID of the app to get
Status Codes: - 200 OK – Success
- 400 Bad Request – AppApi already exists.
- 404 Not Found – AppApi does not exist.
-
DELETE
/apps/apis/{app}
¶ Delete app api
Parameters: - app (string) – Name OR ID of the app to get
Status Codes: - 204 No Content – Success
- 404 Not Found – AppApi does not exist.
authorization¶
-
POST
/auth
¶ Login and get access and refresh tokens
Status Codes: - 201 Created – Success
- 401 Unauthorized – Unauthorized
-
POST
/auth/refresh
¶ Get a fresh access token
Status Codes: - 200 OK – Success
- 401 Unauthorized – Unauthorized
-
POST
/auth/logout
¶ Logout of walkoff
Status Codes: - 204 No Content – Success
- 400 Bad Request – Invalid refresh token
configuration¶
-
GET
/configuration
¶ Reads the configuration
Status Codes: - 200 OK – Success
- 401 Unauthorized – Unauthorized access
-
PUT
/configuration
¶ Updates the configuration
Status Codes: - 200 OK – Success
- 401 Unauthorized – Unauthorized access
- 515 – Could not write configuration to file
-
PATCH
/configuration
¶ Updates the configuration
Status Codes: - 200 OK – Success
- 401 Unauthorized – Unauthorized access
- 515 – Could not write configuration to file
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: - 200 OK – Success
-
POST
/globals
¶ Add a global
Status Codes: - 201 Created – Object created
- 400 Bad Request – GlobalVariable already exists
-
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: - 200 OK – Success
- 404 Not Found – GlobalVariable does not exist.
-
PUT
/globals/{global_var}
¶ Update a global
Parameters: - global_var (string) – ID of the global to be fetched
Status Codes: - 200 OK – Success
- 404 Not Found – GlobalVariable does not exist
-
DELETE
/globals/{global_var}
¶ Remove a global
Parameters: - global_var (string) – ID of the global to be fetched
Status Codes: - 204 No Content – Success
- 404 Not Found – GlobalVariable does not exist
-
GET
/globals/templates
¶ Get all global templates
Query Parameters: - page (integer) – page of data to get
Status Codes: - 200 OK – Success
-
POST
/globals/templates
¶ Add a global
Status Codes: - 201 Created – Object created
- 400 Bad Request – GlobalVariable already exists
-
GET
/globals/templates/{global_template}
¶ Read a global template
Parameters: - global_template (string) – ID of the global template to be fetched
Status Codes: - 200 OK – Success
- 404 Not Found – GlobalVariableTemplate does not exist.
-
PUT
/globals/templates/{global_template}
¶ Update a global template
Parameters: - global_template (string) – ID of the global template to be fetched
Status Codes: - 200 OK – Success
- 404 Not Found – GlobalVariableTemplate does not exist
-
DELETE
/globals/templates/{global_template}
¶ Remove a global
Parameters: - global_template (string) – ID of the global template to be fetched
Status Codes: - 204 No Content – Success
- 404 Not Found – GlobalVariableTemplate does not exist
roles¶
-
POST
/roles
¶ Create a role
Status Codes: - 201 Created – Object created.
- 400 Bad Request – Object exists.
-
GET
/roles/{role_id}
¶ Read a role
Parameters: - role_id (string) – The name that needs to be fetched.
Status Codes: - 200 OK – Success
- 404 Not Found – Object does not exist.
-
PUT
/roles/{role_id}
¶ Update a role
Parameters: - role_id (string) – The name that needs to be fetched.
Status Codes: - 200 OK – Success
- 404 Not Found – Object does not exist.
-
DELETE
/roles/{role_id}
¶ Delete a role
Parameters: - role_id (string) – The name that needs to be fetched.
Status Codes: - 204 No Content – Success
- 404 Not Found – Object does not exist.
scheduler¶
-
POST
/scheduledtasks
¶ Create a new Scheduled Task
Status Codes: - 201 Created – Success
- 400 Bad Request – Scheduled task already exists
-
GET
/scheduledtasks/{scheduled_task_id}
¶ Get the scheduled task
Parameters: - scheduled_task_id (string) – The ID of the scheduled task.
Status Codes: - 200 OK – Success
- 404 Not Found – Scheduled task does not exist
-
PUT
/scheduledtasks/{scheduled_task_id}
¶ Update a new Scheduled Task
Parameters: - scheduled_task_id (string) – The ID of the scheduled task.
Status Codes: - 200 OK – Success
- 400 Bad Request – Scheduled task name already exists
- 404 Not Found – Scheduled task does not exist
-
DELETE
/scheduledtasks/{scheduled_task_id}
¶ Delete the scheduled task
Parameters: - scheduled_task_id (string) – The ID of the scheduled task.
Status Codes: - 204 No Content – Success
- 404 Not Found – Scheduled task does not exist
users¶
-
POST
/users
¶ Create a user
Status Codes: - 201 Created – User created.
- 400 Bad Request – Could not create user <username>. User already exists.
-
GET
/users/{user_id}
¶ Get a user
Parameters: - user_id (integer) – The id of the user to be fetched
Status Codes: - 200 OK – Success
- 404 Not Found – Could not display user <username>. User does not exist.
-
PUT
/users/{user_id}
¶ Update a user
Parameters: - user_id (integer) – The id of the user to be fetched
Status Codes: - 200 OK – Success
- 400 Bad Request – Invalid password
- 404 Not Found – Could not edit user <username>. User does not exist.
-
DELETE
/users/{user_id}
¶ Delete a user
Parameters: - user_id (integer) – The id of the user to be fetched
Status Codes: - 204 No Content – Success
- 401 Unauthorized – Could not delete user <username>. User is current user.
- 404 Not Found – Could not delete user <username>. User does not exist.
workflows¶
-
GET
/workflows
¶ Read all workflows in playbook
Query Parameters: - page (integer) – page of data to get
Status Codes: - 200 OK – Success
- 404 Not Found – No workflows exist.
-
POST
/workflows
¶ Create a workflow
Query Parameters: - source (string) – The ID of the workflow to clone
Status Codes: - 201 Created – Workflow created.
- 400 Bad Request – Workflow already exists.
-
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: - 200 OK – Success
- 404 Not Found – Workflow does not exist.
-
PUT
/workflows/{workflow}
¶ Update a workflow
Parameters: - workflow (string) – The name or ID of the workflow to get.
Status Codes: - 200 OK – Success
- 400 Bad Request – Workflow already exists.
- 404 Not Found – Workflow does not exist.
-
DELETE
/workflows/{workflow}
¶ Delete a workflow
Parameters: - workflow (string) – The name or ID of the workflow to get.
Status Codes: - 204 No Content – Success
- 404 Not Found – Workflow does not exist.
workflowqueue¶
-
GET
/workflowqueue
¶ Get status information on the workflows currently executing
Query Parameters: - page (integer) – page of data to get
Status Codes: - 200 OK – Success
-
POST
/workflowqueue
¶ Execute a workflow
Status Codes: - 202 Accepted – Success asynchronous.
- 400 Bad Request – Invalid input error.
- 404 Not Found – Workflow does not exist.
-
GET
/workflowqueue/{execution}
¶ Get status information on a currently executing workflow
Parameters: - execution (string) – The ID of the execution to get.
Status Codes: - 200 OK – Success
- 404 Not Found – Object does not exist.
-
PATCH
/workflowqueue/{execution}
¶ Abort or trigger a workflow
Parameters: - execution (string) – The ID of the execution to get.
Status Codes: - 204 No Content – Success.
- 400 Bad Request – Invalid input error.
- 404 Not Found – Workflow does not exist.
-
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: - 204 No Content – Success
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: - 200 OK – Success
- 404 Not Found – No dashboards exist.
-
POST
/dashboards
¶ Create a dashboard
Creates a dashboard from the JSON in request body
Status Codes: - 201 Created – Workflow created.
- 400 Bad Request – Workflow already exists.
-
PUT
/dashboards
¶ Update a dashboard
Updates a whole dashboard using the JSON request body
Status Codes: - 200 OK – Success
- 404 Not Found – Dashboard does not exist.
-
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: - 200 OK – Success
- 404 Not Found – No dashboard with that ID exist.
-
DELETE
/dashboards/{dashboard}
¶ Delete a dashboard
Deletes a dashboard by ID
Parameters: - dashboard (string) – ID of the global to be fetched
Status Codes: - 201 Created – Workflow updated.
- 404 Not Found – Dashboard does not exist.