Create an ACL destination

post

Authorizations

cookieapi_token

defguard_sessionstringRequired

Body

application/json

An ACL destination, as accepted when creating or updating one.

addressesstringRequired

any_addressbooleanRequired

any_portbooleanRequired

any_protocolbooleanRequired

namestringRequired

portsstringRequired

protocolsinteger · int32[]Required

Responses

201

ACL destination created.

application/json

An ACL destination. All relations represented as arrays of IDs.

addressesstringRequired

any_addressbooleanRequired

any_portbooleanRequired

any_protocolbooleanRequired

idinteger · int64Optional

kindstring · enumRequired

Type of an ACL alias:

• destination: the alias defines a complete destination that an ACL rule applies to.
• component: the alias defines parts of a destination and is combined with the parts defined in the ACL rule itself.

Possible values:

namestringRequired

parent_idinteger · int64 · nullableOptional

portsstringRequired

protocolsinteger · int32[]Required

rulesinteger · int64[]Required

statestring · enumRequired

ACL alias can be in one of the following states:

• Applied: the alias can be used in ACL rules
• Modified: the alias has been modified and the changes have not yet been applied

Unlike ACL rules themselves aliases do not require a New state, since they do not cause any changes to locations until they are used by a rule. Deleted state is also omitted since we don't allow deleting if an alias is used by any rules.

Possible values:

400

Destination addresses, ports or protocols are missing.

application/json

401

Session is missing or invalid.

application/json

403

Requires admin privileges and an active enterprise license.

application/json

422

Invalid addresses, ports or protocols.

application/json

500

Unable to create ACL destination.

application/json

post/api/v1/acl/destination

HTTPcURLJavaScriptPython

POST /api/v1/acl/destination HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "addresses": "10.0.0.0/24",
  "any_address": false,
  "any_port": false,
  "any_protocol": false,
  "name": "internal-web",
  "ports": "80, 443",
  "protocols": [
    6
  ]
}

{
  "addresses": "text",
  "any_address": true,
  "any_port": true,
  "any_protocol": true,
  "id": 1,
  "kind": "Destination",
  "name": "text",
  "parent_id": null,
  "ports": "text",
  "protocols": [
    1
  ],
  "rules": [
    1
  ],
  "state": "Applied"
}