ACL Plugin API

v0.0.1OAS 3.0

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

List all ACLs

List all ACLs

get
{protocol}://{hostname}:{port}{path}/acls

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

 
application/json

Create a new ACL

Create a new ACL

post
{protocol}://{hostname}:{port}{path}/acls

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]
 
application/json

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!