WinkPG Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-23 00:19 UTC.

API reference Models

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.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description
name required string A human-friendly name/label to identify the key (e.g., 'CI Pipeline', 'Backend Service') nullablemax length 32
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
active required boolean Whether the key should be active upon creation. Inactive keys cannot authenticate.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
expireAt required string (date-time) Optional UTC timestamp after which the key is considered expired and rejected nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
allowedCidrs required array of string array of 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. nullablemax items 50
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
scopes required array of string array of 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
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
key required string The raw API key value to be created/registered. If omitted, the server may generate it. nullablemax length 128
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
userId required string (uuid) Identifier of the user (or owner) the key belongs to
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.