ACL

List Acls in a network

get

Authorizations

oauth

Query parameters

networkstringRequired

Network ID

Responses

200

OK

application/json

allowed_traffic_directioninteger · enumOptionalPossible values:

created_atstringOptional

created_bystringOptional

defaultbooleanOptional

enabledbooleanOptional

idstringOptional

meta_datastringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

policy_typestring · enumOptionalPossible values:

portsstring[]Optional

protocolstring · enumOptionalPossible values:

typestringOptional

500

Internal Server Error

application/json

get/api/v1/acls

HTTPcURLJavaScriptPython

GET /api/v1/acls?network=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "allowed_traffic_direction": 0,
    "created_at": "text",
    "created_by": "text",
    "default": true,
    "dst_type": [
      {
        "id": "user",
        "value": "text"
      }
    ],
    "enabled": true,
    "id": "text",
    "meta_data": "text",
    "name": "text",
    "network_id": "all_networks",
    "policy_type": "user-policy",
    "ports": [
      "text"
    ],
    "protocol": "all",
    "src_type": [
      {
        "id": "user",
        "value": "text"
      }
    ],
    "type": "text"
  }
]

Create Acl

post

Authorizations

oauth

Body

application/json

allowed_traffic_directioninteger · enumOptionalPossible values:

created_atstringOptional

created_bystringOptional

defaultbooleanOptional

enabledbooleanOptional

idstringOptional

meta_datastringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

policy_typestring · enumOptionalPossible values:

portsstring[]Optional

protocolstring · enumOptionalPossible values:

typestringOptional

Responses

200

OK

application/json

allowed_traffic_directioninteger · enumOptionalPossible values:

created_atstringOptional

created_bystringOptional

defaultbooleanOptional

enabledbooleanOptional

idstringOptional

meta_datastringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

policy_typestring · enumOptionalPossible values:

portsstring[]Optional

protocolstring · enumOptionalPossible values:

typestringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post/api/v1/acls

HTTPcURLJavaScriptPython

POST /api/v1/acls HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "allowed_traffic_direction": 0,
  "created_at": "text",
  "created_by": "text",
  "default": true,
  "dst_type": [
    {
      "id": "user",
      "value": "text"
    }
  ],
  "enabled": true,
  "id": "text",
  "meta_data": "text",
  "name": "text",
  "network_id": "all_networks",
  "policy_type": "user-policy",
  "ports": [
    "text"
  ],
  "protocol": "all",
  "src_type": [
    {
      "id": "user",
      "value": "text"
    }
  ],
  "type": "text"
}

{
  "allowed_traffic_direction": 0,
  "created_at": "text",
  "created_by": "text",
  "default": true,
  "dst_type": [
    {
      "id": "user",
      "value": "text"
    }
  ],
  "enabled": true,
  "id": "text",
  "meta_data": "text",
  "name": "text",
  "network_id": "all_networks",
  "policy_type": "user-policy",
  "ports": [
    "text"
  ],
  "protocol": "all",
  "src_type": [
    {
      "id": "user",
      "value": "text"
    }
  ],
  "type": "text"
}

Update Acl

put

Authorizations

oauth

Body

application/json

allowed_traffic_directioninteger · enumOptionalPossible values:

created_atstringOptional

created_bystringOptional

defaultbooleanOptional

enabledbooleanOptional

idstringOptional

meta_datastringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

new_namestringOptional

policy_typestring · enumOptionalPossible values:

portsstring[]Optional

protocolstring · enumOptionalPossible values:

typestringOptional

Responses

200

OK

application/json

codeintegerOptional

messagestringOptional

responseanyOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

put/api/v1/acls

HTTPcURLJavaScriptPython

PUT /api/v1/acls HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 352

{
  "allowed_traffic_direction": 0,
  "created_at": "text",
  "created_by": "text",
  "default": true,
  "dst_type": [
    {
      "id": "user",
      "value": "text"
    }
  ],
  "enabled": true,
  "id": "text",
  "meta_data": "text",
  "name": "text",
  "network_id": "all_networks",
  "new_name": "text",
  "policy_type": "user-policy",
  "ports": [
    "text"
  ],
  "protocol": "all",
  "src_type": [
    {
      "id": "user",
      "value": "text"
    }
  ],
  "type": "text"
}

{
  "code": 1,
  "message": "text",
  "response": null
}

Delete Acl

delete

Authorizations

oauth

Query parameters

acl_idstringRequired

ACL ID

Responses

200

OK

application/json

codeintegerOptional

messagestringOptional

responseanyOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

delete/api/v1/acls

HTTPcURLJavaScriptPython

DELETE /api/v1/acls?acl_id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

List Egress Acls

get

Authorizations

oauth

Query parameters

egress_idstringRequired

Egress ID

Responses

200

OK

application/json

allowed_traffic_directioninteger · enumOptionalPossible values:

created_atstringOptional

created_bystringOptional

defaultbooleanOptional

enabledbooleanOptional

idstringOptional

meta_datastringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

policy_typestring · enumOptionalPossible values:

portsstring[]Optional

protocolstring · enumOptionalPossible values:

typestringOptional

500

Internal Server Error

application/json

get/api/v1/acls/egress

HTTPcURLJavaScriptPython

GET /api/v1/acls/egress?egress_id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "allowed_traffic_direction": 0,
    "created_at": "text",
    "created_by": "text",
    "default": true,
    "dst_type": [
      {
        "id": "user",
        "value": "text"
      }
    ],
    "enabled": true,
    "id": "text",
    "meta_data": "text",
    "name": "text",
    "network_id": "all_networks",
    "policy_type": "user-policy",
    "ports": [
      "text"
    ],
    "protocol": "all",
    "src_type": [
      {
        "id": "user",
        "value": "text"
      }
    ],
    "type": "text"
  }
]

List Acl Policy types

get

Authorizations

oauth

Responses

200

OK

application/json

500

Internal Server Error

application/json

get/api/v1/acls/policy_types

HTTPcURLJavaScriptPython

GET /api/v1/acls/policy_types HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "dst_grp_types": [
    "user"
  ],
  "policy_types": [
    "user-policy"
  ],
  "protocolTypes": [
    {
      "allow_port_setting": true,
      "allowed_protocols": [
        "all"
      ],
      "name": "text",
      "port_range": "text"
    }
  ],
  "src_grp_types": [
    "user"
  ]
}