# ApiKeyCreateDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Carries the data required to provision a new API key associated with a user or service account. Includes metadata such as a friendly name, activation flag, and optional expiration to enforce key rotation and lifecycle policies.

## Fields
- `name` (string) required: A human-friendly name/label to identify the key (e.g., 'CI Pipeline', 'Backend Service') (nullable, max length 32)
- `active` (boolean): Whether the key should be active upon creation. Inactive keys cannot authenticate.
- `expireAt` (string(date-time)): Optional UTC timestamp after which the key is considered expired and rejected (nullable)
- `allowedCidrs` (array<string>): Gets or sets the source addresses this key may be used from, as CIDR ranges or bare IPv4 or  IPv6 addresses. `null` or empty means the key is not bound to any address and may be  used from anywhere, which is the default and what every existing key carries. (nullable, max items 50)
- `scopes` (array<string>): Gets or sets the capability scopes this key is restricted to. `null` or empty means the  key is unrestricted, which is the default and what every existing key carries. (nullable)
- `key` (string): The raw API key value to be created/registered. If omitted, the server may generate it. (nullable, max length 128)
- `userId` (string(uuid)): Identifier of the user (or owner) the key belongs to

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.