key-auth

    This works well with a . Consumers of the API can then add their key to the query string or the header to authenticate their requests.

    For Consumer:

    NOTE: encrypt_fields = {"key"} is also defined in the schema, which means that the field will be stored encrypted in etcd. See .

    For Route:

    NameTypeRequirementDefaultValidDescription
    headerstringoptionalapikeyThe header to get the key from.
    querystringoptionalapikeyThe query string to get the key from. Lower priority than header.
    hide_credentialsbooloptionalfalseApache APISIX will pass the request header or query string that contains the authentication information to the Upstream if hide_credentials is false. Otherwise the authentication information will be removed before proxying.

    First you can create a Consumer object through the with a unique key:

    You can also use the APISIX Dashboard to complete the operation through a web UI.

    First, create a Consumer object:

    enable key-auth plugin

    Once you have created a Consumer object, you can then configure a Route or a Service to authenticate requests:

    1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    2. {
    3.     "methods": ["GET"],
    4.     "uri": "/index.html",
    5.     "id": 1,
    7.     },
    8.     "upstream": {
    9.         "type": "roundrobin",
    10.         "nodes": {
    11.             "127.0.0.1:1980": 1
    12.         }
    13.     }
    14. }'

    To fetch the key from a different header than apikey, change the header in the configuration:

    2.         "header": "Authorization"
    3.     }
    4. }

    After you have configured the Plugin as mentioned above, you can make a request as shown:

    1. HTTP/1.1 200 OK
    2. ...
    1. curl http://127.0.0.2:9080/index.html -i
    1. curl http://127.0.0.2:9080/index.html -H 'apikey: abcabcabc' -i
    1. HTTP/1.1 401 Unauthorized
    2. ...

    To disable the key-auth Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.