Numberlist API

create new entry

POST /api/rest/admin/numberlists

Parameters

Name	Description
data[type]	Resource type (numberlist)
data[attributes][name]	Name
data[attributes][default-action-id]	Default action id
data[attributes][mode-id]	Mode id
data[attributes][default-src-rewrite-rule]	Default src rewrite rule
data[attributes][default-src-rewrite-result]	Default src rewrite result
data[attributes][defer-src-rewrite]	Defer src rewrite
data[attributes][default-dst-rewrite-rule]	Default dst rewrite rule
data[attributes][default-dst-rewrite-result]	Default dst rewrite result
data[attributes][defer-dst-rewrite]	Defer dst rewrite
data[attributes][tag-action-value]	Tag action value
data[attributes][variables]	Variables
data[attributes][external-id]	External id
data[attributes][external-type]	External type
data[relationships][tag-action]	Tag action

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE2NSwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc2NzM1ODU2OX0.2jGqW0Wt4TnDJdjWJ45ZlTioE9sPasnpdEAGAWY1O3Y
Host: example.org
Cookie: 

Route

POST /api/rest/admin/numberlists

Body

{"data":{"type":"numberlists","attributes":{"name":"name","variables":{"var1":"value1","var2":10}}}}

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
location: http://example.org/api/rest/admin/numberlists/12
vary: Accept
etag: W/"63297025a34f8ab1d89871f1ed985959"
cache-control: max-age=0, private, must-revalidate
x-request-id: bc51546b-f18d-493a-af3c-8a12f4f3caa7
x-runtime: 0.011678
content-length: 736

Status

201 Created

Body

{
  "data": {
    "id": "12",
    "type": "numberlists",
    "links": {
      "self": "http://example.org/api/rest/admin/numberlists/12"
    },
    "attributes": {
      "name": "name",
      "default-action-id": 1,
      "mode-id": 1,
      "created-at": "2026-01-02T12:46:09.206Z",
      "updated-at": "2026-01-02T12:46:09.206Z",
      "default-src-rewrite-rule": null,
      "default-src-rewrite-result": null,
      "defer-src-rewrite": false,
      "default-dst-rewrite-rule": null,
      "default-dst-rewrite-result": null,
      "defer-dst-rewrite": false,
      "tag-action-value": [

      ],
      "variables": {
        "var1": "value1",
        "var2": 10
      },
      "external-id": null,
      "external-type": null
    },
    "relationships": {
      "tag-action": {
        "links": {
          "self": "http://example.org/api/rest/admin/numberlists/12/relationships/tag-action",
          "related": "http://example.org/api/rest/admin/numberlists/12/tag-action"
        }
      }
    }
  }
}