ACL

Overview Examples Configuration reference Changelog API reference

API for managing ACLs in Kong Gateway.
You can lean more about Kong Gateway at developer.konghq.com.
Give Kong a star at Kong/kong repository.

API Base URL

Server 1:{protocol}://{hostname}:{port}{path}
Default Admin API URL

Additional Information

Contact Kong Inc (support@konghq.com)

Apache 2.0 License ACL Plugin API Specification

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Response

application/json

A successful response listing ACLs

dataarray[object]

Example:{"consumer":{"id":"84a73fb8-50fc-44a7-a4d5-aa17728ee83f"},"group":"foo","id":"b1f34145-0343-41a4-9602-4c69dec2f269"}

* Additional properties are NOT allowed.

Show Child Parameters

nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

Error initializing code snippet

application/json

{
  "data": [
    {
      "consumer": {
        "id": "84a73fb8-50fc-44a7-a4d5-aa17728ee83f"
      },
      "group": "foo",
      "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
    }
  ],
  "next": "next",
  "offset": "offset"
}

Body

application/json

Description of the new ACL for creation

ACL

* Additional properties are NOT allowed.

consumerobject | null

Show Child Parameters

created_atinteger | null

Unix epoch when the resource was created.

groupstringrequired

idstring | null

tagsarray[string]

Response

application/json

Successfully created ACL

ACL

* Additional properties are NOT allowed.

consumerobject | null

Show Child Parameters

created_atinteger | null

Unix epoch when the resource was created.

groupstringrequired

idstring | null

tagsarray[string]

Error initializing code snippet

application/json

{
  "consumer": {
    "id": "84a73fb8-50fc-44a7-a4d5-aa17728ee83f"
  },
  "group": "foo",
  "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

ACL

ACL Plugin API

List all ACLs

Query Parameters

Response

Create a new ACL

Body

ACL

Response

ACL

Did this doc help?

Help us make these docs great!

Still need help