OpenAPI Specification
swagger: '2.0'
info:
contact:
email: support@nuon.co
name: Nuon Support
description: API for managing nuon apps, components, installs, and actions.
title: Nuon accounts actions API
version: 0.19.1074
host: api.nuon.co
basePath: /
schemes:
- https
tags:
- description: actions
name: actions
paths:
/v1/action-workflows/configs/{action_workflow_config_id}:
get:
consumes:
- application/json
deprecated: true
description: 'Return an action workflow configuration by id.
'
operationId: GetActionWorkflowConfig
parameters:
- description: action workflow config ID
in: path
name: action_workflow_config_id
required: true
type: string
produces:
- application/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/app.ActionWorkflowConfig'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: get an app action workflow config
tags:
- actions
/v1/action-workflows/{action_workflow_id}:
delete:
consumes:
- application/json
deprecated: true
description: 'Delete an action workflow.
'
operationId: DeleteActionWorkflow
parameters:
- description: action workflow ID
in: path
name: action_workflow_id
required: true
type: string
produces:
- application/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/app.EmptyResponse'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: delete an action workflow
tags:
- actions
get:
consumes:
- application/json
deprecated: true
description: 'Return an app action workflow by id.
'
operationId: GetActionWorkflow
parameters:
- description: action workflow ID or name
in: path
name: action_workflow_id
required: true
type: string
produces:
- application/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/app.ActionWorkflow'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: get an app action workflow by action workflow id
tags:
- actions
patch:
consumes:
- application/json
deprecated: true
description: 'Update an app action workflow configuration.
'
operationId: UpdateAppActionWorkflow
parameters:
- description: action workflow ID
in: path
name: action_workflow_id
required: true
type: string
- description: Input
in: body
name: req
required: true
schema:
$ref: '#/definitions/service.UpdateActionWorkflowRequest'
produces:
- application/json
responses:
'201':
description: Created
schema:
$ref: '#/definitions/app.ActionWorkflow'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: patch an app
tags:
- actions
/v1/action-workflows/{action_workflow_id}/configs:
get:
consumes:
- application/json
deprecated: true
description: 'Returns all action workflow configurations.
'
operationId: GetActionWorkflowConfigs
parameters:
- description: action workflow ID
in: path
name: action_workflow_id
required: true
type: string
- default: 0
description: offset of results to return
in: query
name: offset
type: integer
- default: 10
description: limit of results to return
in: query
name: limit
type: integer
- default: 0
description: page number of results to return
in: query
name: page
type: integer
produces:
- application/json
responses:
'200':
description: OK
schema:
items:
$ref: '#/definitions/app.ActionWorkflowConfig'
type: array
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: get action workflow for an app
tags:
- actions
post:
consumes:
- application/json
deprecated: true
description: 'Create an action workflow configuration.
'
operationId: CreateActionWorkflowConfig
parameters:
- description: action workflow ID
in: path
name: action_workflow_id
required: true
type: string
- description: Input
in: body
name: req
required: true
schema:
$ref: '#/definitions/service.CreateActionWorkflowConfigRequest'
produces:
- application/json
responses:
'201':
description: Created
schema:
$ref: '#/definitions/app.ActionWorkflowConfig'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'409':
description: Conflict
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: create action workflow config
tags:
- actions
/v1/action-workflows/{action_workflow_id}/latest-config:
get:
consumes:
- application/json
deprecated: true
description: 'Return the latest config for an action workflow.
'
operationId: GetActionWorkflowLatestConfig
parameters:
- description: action workflow ID
in: path
name: action_workflow_id
required: true
type: string
produces:
- application/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/app.ActionWorkflowConfig'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: get an app action workflow's latest config
tags:
- actions
/v1/apps/{app_id}/action-workflows:
get:
consumes:
- application/json
deprecated: true
description: 'Returns all action workflows for the provided app.
'
operationId: GetActionWorkflows
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: search query to filter action workflows by name or ID
in: query
name: q
type: string
- description: label filter (key:value,key:value)
in: query
name: labels
type: string
- description: filter by action workflow trigger type
in: query
name: trigger_types
type: string
- default: 0
description: offset of results to return
in: query
name: offset
type: integer
- default: 10
description: limit of results to return
in: query
name: limit
type: integer
- default: 0
description: page number of results to return
in: query
name: page
type: integer
produces:
- application/json
responses:
'200':
description: OK
schema:
items:
$ref: '#/definitions/app.ActionWorkflow'
type: array
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: get action workflows for an app
tags:
- actions
post:
consumes:
- application/json
deprecated: true
description: 'Create an action workflow for an app.
'
operationId: CreateAppActionWorkflow
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: Input
in: body
name: req
required: true
schema:
$ref: '#/definitions/service.CreateAppActionWorkflowRequest'
produces:
- application/json
responses:
'201':
description: Created
schema:
$ref: '#/definitions/app.ActionWorkflow'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'409':
description: Conflict
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: create an app action workflow
tags:
- actions
/v1/apps/{app_id}/action-workflows/{action_workflow_id}:
get:
consumes:
- application/json
deprecated: true
description: 'Return an app action workflow by id.
'
operationId: GetAppActionWorkflow
parameters:
- description: app ID or name
in: path
name: app_id
required: true
type: string
- description: action workflow ID or name
in: path
name: action_workflow_id
required: true
type: string
produces:
- application/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/app.ActionWorkflow'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: get an app action workflow
tags:
- actions
/v1/apps/{app_id}/actions:
get:
consumes:
- application/json
description: 'Returns all action workflows for the provided app.
'
operationId: GetAppActions
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: search query to filter action workflows by name or ID
in: query
name: q
type: string
- description: label filter (key:value,key:value)
in: query
name: labels
type: string
- description: filter by action workflow trigger type
in: query
name: trigger_types
type: string
- default: 0
description: offset of results to return
in: query
name: offset
type: integer
- default: 10
description: limit of results to return
in: query
name: limit
type: integer
- default: 0
description: page number of results to return
in: query
name: page
type: integer
produces:
- application/json
responses:
'200':
description: OK
schema:
items:
$ref: '#/definitions/app.ActionWorkflow'
type: array
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: get action workflows for an app
tags:
- actions
post:
consumes:
- application/json
deprecated: true
description: 'Create an action workflow for an app.
'
operationId: CreateAppAction
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: Input
in: body
name: req
required: true
schema:
$ref: '#/definitions/service.CreateAppActionRequest'
produces:
- application/json
responses:
'201':
description: Created
schema:
$ref: '#/definitions/app.ActionWorkflow'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'409':
description: Conflict
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: create an app action
tags:
- actions
/v1/apps/{app_id}/actions/configs/{action_config_id}:
get:
consumes:
- application/json
description: 'Return an action workflow configuration by id.
'
operationId: GetAppActionConfig
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: action config ID
in: path
name: action_config_id
required: true
type: string
produces:
- application/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/app.ActionWorkflowConfig'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: get an app action config
tags:
- actions
/v1/apps/{app_id}/actions/label-keys:
get:
consumes:
- application/json
description: Returns all distinct label key:value pairs for actions in the given app.
operationId: GetActionLabelKeys
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
produces:
- application/json
responses:
'200':
description: OK
schema:
additionalProperties:
items:
type: string
type: array
type: object
security:
- APIKey: []
- OrgID: []
summary: get distinct label key:value pairs across all actions for an app
tags:
- actions
/v1/apps/{app_id}/actions/{action_id}:
delete:
consumes:
- application/json
description: 'Delete an action workflow.
'
operationId: DeleteAction
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: action ID
in: path
name: action_id
required: true
type: string
produces:
- application/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/app.EmptyResponse'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: delete an action
tags:
- actions
get:
consumes:
- application/json
description: 'Return an app action workflow by id.
'
operationId: GetAppAction
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: action ID or name
in: path
name: action_id
required: true
type: string
produces:
- application/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/app.ActionWorkflow'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: get an app action workflow by action workflow id
tags:
- actions
patch:
consumes:
- application/json
deprecated: true
description: 'Update an app action workflow configuration.
'
operationId: UpdateAppAction
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: action ID
in: path
name: action_id
required: true
type: string
- description: Input
in: body
name: req
required: true
schema:
$ref: '#/definitions/service.UpdateActionWorkflowRequest'
produces:
- application/json
responses:
'201':
description: Created
schema:
$ref: '#/definitions/app.ActionWorkflow'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: patch an app action
tags:
- actions
/v1/apps/{app_id}/actions/{action_id}/configs:
get:
consumes:
- application/json
description: 'Returns all action workflow configurations.
'
operationId: GetAppActionConfigs
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: action workflow ID
in: path
name: action_id
required: true
type: string
- default: 0
description: offset of results to return
in: query
name: offset
type: integer
- default: 10
description: limit of results to return
in: query
name: limit
type: integer
- default: 0
description: page number of results to return
in: query
name: page
type: integer
produces:
- application/json
responses:
'200':
description: OK
schema:
items:
$ref: '#/definitions/app.ActionWorkflowConfig'
type: array
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: get action workflow for an app
tags:
- actions
post:
consumes:
- application/json
description: 'Create an action workflow configuration.
'
operationId: CreateActionConfig
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: action ID
in: path
name: action_id
required: true
type: string
- description: Input
in: body
name: req
required: true
schema:
$ref: '#/definitions/service.CreateActionWorkflowConfigRequest'
produces:
- application/json
responses:
'201':
description: Created
schema:
$ref: '#/definitions/app.ActionWorkflowConfig'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'409':
description: Conflict
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: create action config
tags:
- actions
/v1/apps/{app_id}/actions/{action_id}/labels:
delete:
consumes:
- application/json
description: Remove the specified label keys from the action.
operationId: RemoveAppActionLabels
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: action ID
in: path
name: action_id
required: true
type: string
- description: Input
in: body
name: req
required: true
schema:
$ref: '#/definitions/service.RemoveActionLabelsRequest'
produces:
- application/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/app.ActionWorkflow'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: remove labels from an action
tags:
- actions
post:
consumes:
- application/json
description: Merge the provided labels into the action's existing labels. Existing keys are overwritten.
operationId: AddAppActionLabels
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: action ID
in: path
name: action_id
required: true
type: string
- description: Input
in: body
name: req
required: true
schema:
$ref: '#/definitions/service.AddActionLabelsRequest'
produces:
- application/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/app.ActionWorkflow'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/stderr.ErrResponse'
security:
- APIKey: []
- OrgID: []
summary: add labels to an action
tags:
- actions
/v1/apps/{app_id}/actions/{action_id}/latest-config:
get:
consumes:
- application/json
description: 'Return the latest config for an action workflow.
'
operationId: GetActionLatestConfig
parameters:
- description: app ID
in: path
name: app_id
required: true
type: string
- description: action workflow ID
in: path
name: action_id
required: true
type: string
produces:
- application/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/app.ActionWorkflowConfig'
'400':
description: Bad Request
schema:
$ref: '#/definitions/stderr.ErrResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/stderr.ErrResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/stderr.ErrResponse'
'404':
description: Not Found
schema:
$ref: '#/definitions/stderr.ErrResponse'
'500':
description: Internal Server Error
schema
# --- truncated at 32 KB (177 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nuon/refs/heads/main/openapi/nuon-actions-api-openapi.yml