Actions

Get Actions

get

Get all Actions in a configuration

Path parameters
configstringRequired
Responses
200
Actions retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/actions HTTP/1.1
Host: 
Accept: */*

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

Modify Actions

put

Update an existing set of Actions for a configuration

Path parameters
configstringRequired
Bodyobject · Action[]
descriptionstringOptional
idstringRequired
namestring · min: 1Required
paramsany ofOptionalDefault: {}
or
objectOptional
tagsstring[]Optional

List of tags to apply

Default: []
typeall ofRequired

Need to be one of predefined strings

string · enumOptionalPossible values:
Responses
200
Actions updated successfully
application/json
put
PUT /api/v4.0/conf/{config}/actions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 160

[
  {
    "description": "text",
    "id": "text",
    "name": "text",
    "params": {
      "content": "",
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "status": 1
    },
    "tags": [
      "text"
    ],
    "type": "skip"
  }
]
{
  "message": "Successfully updated entry"
}

Create Actions

post

Create complete set of Actions for a configuration

Path parameters
configstringRequired
Bodyobject · Action[]
descriptionstringOptional
idstringRequired
namestring · min: 1Required
paramsany ofOptionalDefault: {}
or
objectOptional
tagsstring[]Optional

List of tags to apply

Default: []
typeall ofRequired

Need to be one of predefined strings

string · enumOptionalPossible values:
Responses
201
Actions created successfully
application/json
post
POST /api/v4.0/conf/{config}/actions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 160

[
  {
    "description": "text",
    "id": "text",
    "name": "text",
    "params": {
      "content": "",
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "status": 1
    },
    "tags": [
      "text"
    ],
    "type": "skip"
  }
]
{
  "message": "Successfully created entry"
}

Delete Actions

delete

Delete all Actions in a configuration

Path parameters
configstringRequired
Responses
200
Actions deleted successfully
application/json
delete
DELETE /api/v4.0/conf/{config}/actions HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get single Action

get

Get an individual Action from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Action retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/actions/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "description": "text",
  "id": "text",
  "name": "text",
  "params": {
    "content": "",
    "headers": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "status": 1
  },
  "tags": [
    "text"
  ],
  "type": "skip"
}

Modify a single Action

put

Update an individual Action within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
descriptionstringOptional
idstringRequired
namestring · min: 1Required
paramsany ofOptionalDefault: {}
or
objectOptional
tagsstring[]Optional

List of tags to apply

Default: []
typeall ofRequired

Need to be one of predefined strings

string · enumOptionalPossible values:
Responses
200
Action updated successfully
application/json
put
PUT /api/v4.0/conf/{config}/actions/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "description": "text",
  "id": "text",
  "name": "text",
  "params": {
    "content": "",
    "headers": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "status": 1
  },
  "tags": [
    "text"
  ],
  "type": "skip"
}
{
  "message": "Successfully updated entry"
}

Create single Action

post

Create an individual Action within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
descriptionstringOptional
idstringRequired
namestring · min: 1Required
paramsany ofOptionalDefault: {}
or
objectOptional
tagsstring[]Optional

List of tags to apply

Default: []
typeall ofRequired

Need to be one of predefined strings

string · enumOptionalPossible values:
Responses
200
Action created successfully
application/json
post
POST /api/v4.0/conf/{config}/actions/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "description": "text",
  "id": "text",
  "name": "text",
  "params": {
    "content": "",
    "headers": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "status": 1
  },
  "tags": [
    "text"
  ],
  "type": "skip"
}
{
  "message": "Successfully created entry"
}

Delete single Action

delete

Delete an individual Action from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Action deleted successfully
application/json
delete
DELETE /api/v4.0/conf/{config}/actions/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get Actions version list

get

Get list of versions of Actions in a configuration

Path parameters
configstringRequired
Responses
200
Actions version list retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/actions/versions HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[email protected]",
      "message": "text",
      "date": "2025-07-12T06:43:30.878Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Actions

get

Get a specific version of an Action

Path parameters
configstringRequired
versionstringRequired
Responses
200
Action version retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/actions/versions/{version} HTTP/1.1
Host: 
Accept: */*

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

Revert Actions to the specified version

put

Set a previous Actions version to be the current one

Path parameters
configstringRequired
versionstringRequired
Responses
200
Actions reversion was successful
application/json
put
PUT /api/v4.0/conf/{config}/actions/versions/{version}/revert HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully updated entry"
}
PreviousACL ProfilesNextBackend Services

Last updated

Was this helpful?