--- WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/istio' REPO source_repo: https://github.com/istio/istio title: API Key description: A template that represents a single API key. location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/apikey.html layout: protoc-gen-docs generator: protoc-gen-docs aliases: - /zh/docs/reference/config/template/apikey.html number_of_entries: 1 ---

The `apikey` template represents a single API key, which is used for authorization checks.

Example config:

    apiVersion: "config.istio.io/v1alpha2"
    kind: instance
    metadata:
      name: validate-apikey
      namespace: istio-system
    spec:
      compiledTemplate: apikey
      params:
        api: api.service | ""
        api_version: api.version | ""
        api_operation: api.operation | ""
        api_key: api.key | ""
        timestamp: request.time

## Template

The `apikey` template represents a single API key, used to authorize API calls.

Field | Type | Description | Required
--- | --- | --- | ---
`api` | `string` | The API being called (api.service). | No
`apiVersion` | `string` | The version of the API (api.version). | No
`apiOperation` | `string` | The API operation is being called. | No
`apiKey` | `string` | API key used in API call. | No
`timestamp` | `TimeStamp` | Timestamp of API call. | No