> For the complete documentation index, see [llms.txt](https://docs.balena.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balena.io/reference/sdk/node-sdk/latest/models/apikey.md).

# ApiKey

`balena.models.apiKey` : `object`

**Kind**: static namespace

***

## create

`balena.models.apiKey.create(createApiKeyParams)` ⇒ `Promise`

This method registers a new api key for the current user with the name given.

**Kind**: static method of [`apiKey`](#balena.models.apiKey)\
**Summary**: Creates a new user API key\
**Access**: public\
**Fulfil**: `String` - API key

| Param                             | Type     | Default | Description                                                        |
| --------------------------------- | -------- | ------- | ------------------------------------------------------------------ |
| createApiKeyParams                | `Object` |         | an object containing the parameters for the creation of an API key |
| createApiKeyParams.name           | `String` |         | the API key name                                                   |
| createApiKeyParams.expiryDate     | `String` |         | the API key expiry date                                            |
| \[createApiKeyParams.description] | `String` |         | the API key description                                            |

**Example**

```js
balena.models.apiKey.create({name: apiKeyName, expiryDate: 2030-10-12}).then(function(apiKey) {
	console.log(apiKey);
});
```

**Example**

```js
balena.models.apiKey.create({name: apiKeyName, expiryDate: 2030-10-12, description: apiKeyDescription}).then(function(apiKey) {
	console.log(apiKey);
});
```

***

## getAll

`balena.models.apiKey.getAll([options])` ⇒ `Promise`

**Kind**: static method of [`apiKey`](#balena.models.apiKey)\
**Summary**: Get all accessible API keys\
**Access**: public\
**Fulfil**: `Object[]` - apiKeys

| Param      | Type     | Default | Description               |
| ---------- | -------- | ------- | ------------------------- |
| \[options] | `Object` | `{}`    | extra pine options to use |

**Example**

```js
balena.models.apiKey.getAll().then(function(apiKeys) {
	console.log(apiKeys);
});
```

***

## getAllNamedUserApiKeys

`balena.models.apiKey.getAllNamedUserApiKeys([options])` ⇒ `Promise`

**Kind**: static method of [`apiKey`](#balena.models.apiKey)\
**Summary**: Get all named user API keys of the current user\
**Access**: public\
**Fulfil**: `Object[]` - apiKeys

| Param      | Type     | Default | Description               |
| ---------- | -------- | ------- | ------------------------- |
| \[options] | `Object` | `{}`    | extra pine options to use |

**Example**

```js
balena.models.apiKey.getAllNamedUserApiKeys().then(function(apiKeys) {
	console.log(apiKeys);
});
```

***

## getDeviceApiKeysByDevice

`balena.models.apiKey.getDeviceApiKeysByDevice(uuidOrId, [options])` ⇒ `Promise`

**Kind**: static method of [`apiKey`](#balena.models.apiKey)\
**Summary**: Get all API keys for a device\
**Access**: public\
**Fulfil**: `Object[]` - apiKeys

| Param      | Type                 | Default | Description                          |
| ---------- | -------------------- | ------- | ------------------------------------ |
| uuidOrId   | `String` \| `Number` |         | device, uuid (string) or id (number) |
| \[options] | `Object`             | `{}`    | extra pine options to use            |

**Example**

```js
balena.models.apiKey.getDeviceApiKeysByDevice('7cf02a69e4d34c9da573914963cf54fd').then(function(apiKeys) {
	console.log(apiKeys);
});
```

***

## getProvisioningApiKeysByApplication

`balena.models.apiKey.getProvisioningApiKeysByApplication(slugOrUuidOrId, [options])` ⇒ `Promise`

**Kind**: static method of [`apiKey`](#balena.models.apiKey)\
**Summary**: Get all provisioning API keys for an application\
**Access**: public\
**Fulfil**: `Object[]` - apiKeys

| Param          | Type                 | Default | Description                                             |
| -------------- | -------------------- | ------- | ------------------------------------------------------- |
| slugOrUuidOrId | `String` \| `Number` |         | application slug (string), uuid (string) or id (number) |
| \[options]     | `Object`             | `{}`    | extra pine options to use                               |

**Example**

```js
balena.models.apiKey.getProvisioningApiKeysByApplication('myorganization/myapp').then(function(apiKeys) {
	console.log(apiKeys);
});
```

***

## revoke

`balena.models.apiKey.revoke(id)` ⇒ `Promise`

**Kind**: static method of [`apiKey`](#balena.models.apiKey)\
**Summary**: Revoke an API key\
**Access**: public

| Param | Type     | Description |
| ----- | -------- | ----------- |
| id    | `Number` | API key id  |

**Example**

```js
balena.models.apiKey.revoke(123);
```

***

## update

`balena.models.apiKey.update(id, apiKeyInfo)` ⇒ `Promise`

**Kind**: static method of [`apiKey`](#balena.models.apiKey)\
**Summary**: Update the details of an API key\
**Access**: public

| Param      | Type     | Description                                              |
| ---------- | -------- | -------------------------------------------------------- |
| id         | `Number` | API key id                                               |
| apiKeyInfo | `Object` | an object with the updated name\|description\|expiryDate |

**Example**

```js
balena.models.apiKey.update(123, { name: 'updatedName' });
```

**Example**

```js
balena.models.apiKey.update(123, { description: 'updated description' });
```

**Example**

```js
balena.models.apiKey.update(123, { expiryDate: '2022-04-29' });
```

**Example**

```js
balena.models.apiKey.update(123, { name: 'updatedName', description: 'updated description' });
```

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.balena.io/reference/sdk/node-sdk/latest/models/apikey.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.