ACL Profiles

Get ACL Profiles

Get all ACL Profiles in a configuration

GET/api/v4.0/conf/{config}/acl-profiles

Path parameters

config*Config

Response

ACL Profiles retrieved successfully

Body

totalinteger

Example: 1

itemsarray of ACLProfile

Request

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

Response

{
  "total": 1,
  "items": [
    {
      "action": "text",
      "allow": [
        "text"
      ],
      "allow_bot": [
        "text"
      ],
      "deny": [
        "text"
      ],
      "deny_bot": [
        "text"
      ],
      "description": "text",
      "force_deny": [
        "text"
      ],
      "id": "text",
      "name": "text",
      "passthrough": [
        "text"
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

Modify ACL Profiles

Updates an existing set of ACL Profiles for a configuration

PUT/api/v4.0/conf/{config}/acl-profiles

Path parameters

config*Config

Body

actionAction

allowAllow

allow_botAllow Bot

denyDeny

deny_botDeny Bot

descriptionDescription

force_denyForce Deny

id*Id

name*Name

passthroughPassthrough

tagsTags

Response

ACL Profiles updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

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

Response

{
  "message": "Successfully updated entry"
}

Create ACL Profiles

Create a complete set of ACL Profiles for a configuration

POST/api/v4.0/conf/{config}/acl-profiles

Path parameters

config*Config

Body

actionAction

allowAllow

allow_botAllow Bot

denyDeny

deny_botDeny Bot

descriptionDescription

force_denyForce Deny

id*Id

name*Name

passthroughPassthrough

tagsTags

Response

ACL Profiles created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

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

Response

{
  "message": "Successfully created entry"
}

Delete ACL Profiles

Delete all ACL Profiles in a configuration

DELETE/api/v4.0/conf/{config}/acl-profiles

Path parameters

config*Config

Response

ACL Profiles deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

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

Response

{
  "message": "Successfully deleted entry"
}

Get single ACL Profile

Get an individual ACL Profile (not the entire set) from the specified configuration

GET/api/v4.0/conf/{config}/acl-profiles/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

ACL Profile retrieved successfully

Body

actionAction

allowAllow

allow_botAllow Bot

denyDeny

deny_botDeny Bot

descriptionDescription

force_denyForce Deny

id*Id

name*Name

passthroughPassthrough

tagsTags

Request

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

Response

{
  "action": "text",
  "allow": [
    "text"
  ],
  "allow_bot": [
    "text"
  ],
  "deny": [
    "text"
  ],
  "deny_bot": [
    "text"
  ],
  "description": "text",
  "force_deny": [
    "text"
  ],
  "id": "text",
  "name": "text",
  "passthrough": [
    "text"
  ],
  "tags": [
    "text"
  ]
}

Modify a single ACL Profile

Update an individual ACL Profile within a configuration

PUT/api/v4.0/conf/{config}/acl-profiles/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

actionAction

allowAllow

allow_botAllow Bot

denyDeny

deny_botDeny Bot

descriptionDescription

force_denyForce Deny

id*Id

name*Name

passthroughPassthrough

tagsTags

Response

ACL Profile updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

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

Response

{
  "message": "Successfully updated entry"
}

Create single ACL Profile

Create an individual ACL Profile within a configuration

POST/api/v4.0/conf/{config}/acl-profiles/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

actionAction

allowAllow

allow_botAllow Bot

denyDeny

deny_botDeny Bot

descriptionDescription

force_denyForce Deny

id*Id

name*Name

passthroughPassthrough

tagsTags

Response

ACL Profile created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

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

Response

{
  "message": "Successfully created entry"
}

Delete single ACL Profile

Delete an individual ACL Profile (not the entire set) from the specified configuration

DELETE/api/v4.0/conf/{config}/acl-profiles/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

ACL Profile deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

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

Response

{
  "message": "Successfully deleted entry"
}

Get ACL Profiles version list

Get list of versions of ACL Profiles in a configuration

GET/api/v4.0/conf/{config}/acl-profiles/versions

Path parameters

config*Config

Response

ACL Profiles version list retrieved successfully

Body

totalinteger

Example: 1

itemsarray of VersionEntry

Request

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

Response

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2024-11-21T09:17:23.235Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of ACL Profile

Get a specific version of an ACL Profile

GET/api/v4.0/conf/{config}/acl-profiles/versions/{version}

Path parameters

config*Config

version*Version

Response

ACL Profile retrieved successfully

Body

totalinteger

Example: 1

itemsarray of ACLProfile

Request

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

Response

{
  "total": 1,
  "items": [
    {
      "action": "text",
      "allow": [
        "text"
      ],
      "allow_bot": [
        "text"
      ],
      "deny": [
        "text"
      ],
      "deny_bot": [
        "text"
      ],
      "description": "text",
      "force_deny": [
        "text"
      ],
      "id": "text",
      "name": "text",
      "passthrough": [
        "text"
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

Revert an ACL Profile to the specified version

Set a previous ACL Profile version to be the current one

PUT/api/v4.0/conf/{config}/acl-profiles/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

ACL Profile 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}/acl-profiles/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

PreviousNamespace reference NextActions

Last updated 2 months ago