Actions

PreviousACL Profiles NextBackend Services

Last updated 4 months ago

Was this helpful?

Get Actions

Get all Actions in a configuration

GET/api/v4.0/conf/{config}/actions

Path parameters

config*Config

Response

Actions retrieved successfully

Body

totalinteger

Example: 1

itemsarray of Action

Request

const response = await fetch('/api/v4.0/conf/{config}/actions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "total": 1,
  "items": [
    {
      "description": "text",
      "id": "text",
      "name": "text",
      "params": {
        "content": "text",
        "status": 0
      },
      "tags": [
        "text"
      ],
      "type": {}
    }
  ]
}

Modify Actions

Update an existing set of Actions for a configuration

PUT/api/v4.0/conf/{config}/actions

Path parameters

config*Config

Body

descriptionDescription

id*Id

name*Name

paramsAction param List

tagsTags List

List of tags to apply

type*Type

Need to be one of predefined strings

Response

Actions updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/actions', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "type": {}
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

Create Actions

Create complete set of Actions for a configuration

POST/api/v4.0/conf/{config}/actions

Path parameters

config*Config

Body

descriptionDescription

id*Id

name*Name

paramsAction param List

tagsTags List

List of tags to apply

type*Type

Need to be one of predefined strings

Response

Actions created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "type": {}
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "Successfully created entry"
}

Delete Actions

Delete all Actions in a configuration

DELETE/api/v4.0/conf/{config}/actions

Path parameters

config*Config

Response

Actions deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/actions', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted entry"
}

Get single Action

Get an individual Action from the specified configuration

GET/api/v4.0/conf/{config}/actions/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Action retrieved successfully

Body

descriptionDescription

id*Id

name*Name

paramsAction param List

tagsTags List

List of tags to apply

type*Type

Need to be one of predefined strings

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "description": "text",
  "id": "text",
  "name": "text",
  "params": {
    "content": "text",
    "status": 0
  },
  "tags": [
    "text"
  ],
  "type": {}
}

Modify a single Action

Update an individual Action within a configuration

PUT/api/v4.0/conf/{config}/actions/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

descriptionDescription

id*Id

name*Name

paramsAction param List

tagsTags List

List of tags to apply

type*Type

Need to be one of predefined strings

Response

Action updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "type": {}
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

Create single Action

Create an individual Action within a configuration

POST/api/v4.0/conf/{config}/actions/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

descriptionDescription

id*Id

name*Name

paramsAction param List

tagsTags List

List of tags to apply

type*Type

Need to be one of predefined strings

Response

Action created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "type": {}
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully created entry"
}

Delete single Action

Delete an individual Action from the specified configuration

DELETE/api/v4.0/conf/{config}/actions/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Action deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted entry"
}

Get Actions version list

Get list of versions of Actions in a configuration

GET/api/v4.0/conf/{config}/actions/versions

Path parameters

config*Config

Response

Actions version list retrieved successfully

Body

totalinteger

Example: 1

itemsarray of VersionEntry

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2025-01-30T14:30:06.027Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Actions

Get a specific version of an Action

GET/api/v4.0/conf/{config}/actions/versions/{version}

Path parameters

config*Config

version*Version

Response

Action version retrieved successfully

Body

totalinteger

Example: 1

itemsarray of Action

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "total": 1,
  "items": [
    {
      "description": "text",
      "id": "text",
      "name": "text",
      "params": {
        "content": "text",
        "status": 0
      },
      "tags": [
        "text"
      ],
      "type": {}
    }
  ]
}

Revert Actions to the specified version

Set a previous Actions version to be the current one

PUT/api/v4.0/conf/{config}/actions/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

Actions reversion was successful

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/actions/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}