unkey: appmixer.unkey.core.GetKey – Appmixer connector library

Basic Information

Name

appmixer.unkey.core.GetKey

Version

1.0.0

Visibility

Public

Description

Retrieve information about a specific API key by its ID.

Input Ports

in

Field	Type	Description
Key ID	text	The ID of the key to retrieve

Output Ports

out

Field	Type	Description
Key ID	string	-
Start	string	-
Name	string,null	-
Enabled	boolean	-
Meta	object,null	-
Created At	integer	-
Updated At	integer,null	-
Last Used At	integer,null	-
Expires	integer,null	-
Permissions	array	-
Roles	array	-
Credits	object	-
Identity	object	-
Rate Limits	array	-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.unkey.core.GetKey", "author": "Appmixer <info@appmixer.com>", "description": "Retrieve information about a specific API key by its ID.", "version": "1.0.0", "auth": { "service": "appmixer:unkey" }, "quota": { "manager": "appmixer:unkey", "resources": "requests", "scope": { "userId": "{{userId}}" } }, "inPorts": [ { "name": "in", "schema": { "type": "object", "properties": { "keyId": { "type": "string" } }, "required": [ "keyId" ] }, "inspector": { "inputs": { "keyId": { "type": "text", "label": "Key ID", "index": 1, "tooltip": "The ID of the key to retrieve" } } } } ], "outPorts": [ { "name": "out", "schema": { "type": "object", "properties": { "keyId": { "type": "string", "title": "Key ID", "example": "key_2cGKbMxRyIzhCxo1Idjz8q" }, "start": { "type": "string", "title": "Start", "example": "acme_3ZK8" }, "name": { "type": [ "string", "null" ], "title": "Name", "example": "Production API Key" }, "enabled": { "type": "boolean", "title": "Enabled", "example": true }, "meta": { "type": [ "object", "null" ], "title": "Meta", "example": { "plan": "pro" } }, "createdAt": { "type": "integer", "title": "Created At", "example": 1757493000000 }, "updatedAt": { "type": [ "integer", "null" ], "title": "Updated At", "example": 1757579400000 }, "lastUsedAt": { "type": [ "integer", "null" ], "title": "Last Used At", "example": 1757582100000 }, "expires": { "type": [ "integer", "null" ], "title": "Expires", "example": 1789029000000 }, "permissions": { "type": "array", "title": "Permissions", "items": { "type": "string" }, "example": [ "documents.read", "documents.write" ] }, "roles": { "type": "array", "title": "Roles", "items": { "type": "string" }, "example": [ "editor" ] }, "credits": { "type": "object", "title": "Credits", "properties": { "remaining": { "type": [ "integer", "null" ], "title": "Credits.Remaining", "example": 1000 }, "refill": { "type": [ "object", "null" ], "title": "Credits.Refill", "example": { "interval": "monthly", "amount": 1000, "refillDay": 1 } } } }, "identity": { "type": "object", "title": "Identity", "properties": { "id": { "type": "string", "title": "Identity.ID", "example": "id_4Qm7vT2xLp9sRk3N" }, "externalId": { "type": "string", "title": "Identity.External ID", "example": "user_1234" }, "meta": { "type": [ "object", "null" ], "title": "Identity.Meta", "example": { "tier": "pro" } } } }, "ratelimits": { "type": "array", "title": "Rate Limits", "items": { "type": "object" }, "example": [ { "id": "rl_3Tk9wQ2mVx7pLs4N", "name": "requests", "limit": 1000, "duration": 3600000, "autoApply": true } ] } } } } ], "icon": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iNjQiIGhlaWdodD0iNjQiIHZpZXdCb3g9IjAgMCA2NCA2NCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KICA8cmVjdCB3aWR0aD0iNjQiIGhlaWdodD0iNjQiIHJ4PSIxMiIgZmlsbD0iIzAwMDAwMCIvPgogIDxwYXRoIGQ9Ik0yMCAzMkgzMk00NCAzMkg1Mk0zMiAyMFYzMk0zMiAzMlY0NCIgc3Ryb2tlPSIjRkZGRkZGIiBzdHJva2Utd2lkdGg9IjQiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgogIDxjaXJjbGUgY3g9IjMyIiBjeT0iMzIiIHI9IjYiIGZpbGw9IiNGRkZGRkYiLz4KPC9zdmc+" }