API-Schlüssel

Die API-Schlüssel eines Workspaces erstellen, auflisten, umbenennen und widerrufen.

Basis-URLhttps://api.emailit.com/v2Authentifizierung Fehler Rate Limits

POST/api-keys
GET/api-keys/{id}
GET/api-keys
POST/api-keys/{id}
POST/api-keys/{id}/regenerate
DEL/api-keys/{id}

API-Schlüssel erstellen

Erstellt einen API-Schlüssel und gibt sein Secret zurück.

POST/api-keys

Erfordert einen API-Schlüssel mit dem Scope full. Das Secret in key wird nur in dieser Antwort zurückgegeben und wenn Sie den Schlüssel neu generieren. Speichern Sie es deshalb sofort an einem sicheren Ort. Der Schlüssel funktioniert auch als SMTP-Passwort. Was jeder Scope erlaubt, erfahren Sie unter Authentifizierung.

Body-Parameter

namestringerforderlich

Ein Name, an dem Sie erkennen, wo der Schlüssel verwendet wird, etwa Production web app. Muss unter den Schlüsseln des Workspaces eindeutig sein.

scopestringStandardwert: full

full für Zugriff auf alle Endpunkte oder sending nur für die Sende-Endpunkte. Lässt sich später nicht ändern.

sending_domain_idstring

Die ID einer Versanddomain (dom_…), auf die ein Schlüssel mit dem Scope sending beschränkt wird. Der Schlüssel kann dann nur von Adressen dieser Domain senden. Bei Schlüsseln mit dem Scope full wird der Wert ignoriert.

Rückgabe

Gibt 201 mit dem API-Schlüssel-Objekt und seinem Secret zurück:

keystring

Das Secret, beginnend mit secret_. Verwenden Sie es als Bearer-Token. Es wird nie wieder angezeigt.

POST/api-keys

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const apiKey = await emailit.apiKeys.create({
  name: 'Production web app',
  scope: 'sending',
});

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

api_key = client.api_keys.create({
  "name": "Production web app",
  "scope": "sending",
})

PHP

$emailit = Emailit::client('your_api_key');

$apiKey = $emailit->apiKeys()->create([
  'name' => 'Production web app',
  'scope' => 'sending',
]);

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

api_key = client.api_keys.create(
  name: "Production web app",
  scope: "sending"
)

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

apiKey, err := client.ApiKeys.Create(&emailit.CreateApiKeyRequest{
  Name:  "Production web app",
  Scope: "sending",
})

Rust

use emailit::Emailit;

let emailit = Emailit::new("your_api_key");

let api_key = emailit.api_keys.create(
  emailit::types::CreateApiKeyParams::new("Production web app")
    .with_scope("sending")
).await?;

Java

import com.emailit.*;
import com.emailit.params.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject apiKey = emailit.apiKeys().create(
  ApiKeyCreateParams.builder()
    .setName("Production web app")
    .setScope("sending")
    .build()
);

using Emailit;

var emailit = new EmailitClient("your_api_key");

var apiKey = emailit.ApiKeys.Create(new ApiKeyCreateOptions {
  Name = "Production web app",
  Scope = "sending",
});

PHP

use Emailit\Laravel\Facades\Emailit;

$apiKey = Emailit::apiKeys()->create([
  'name' => 'Production web app',
  'scope' => 'sending',
]);

Terminal

curl -X POST https://api.emailit.com/v2/api-keys \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production web app",
    "scope": "sending"
  }'

Terminal

curl -X POST https://api.emailit.com/v2/api-keys \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production web app",
    "scope": "sending",
    "sending_domain_id": "dom_4K468YrjOkR1wwdhqiO0G9XEUey"
  }'

JavaScript

const apiKey = await emailit.apiKeys.create({
  name: 'Production web app',
  scope: 'sending',
  sending_domain_id: 'dom_4K468YrjOkR1wwdhqiO0G9XEUey',
});

Python

api_key = client.api_keys.create({
  "name": "Production web app",
  "scope": "sending",
  "sending_domain_id": "dom_4K468YrjOkR1wwdhqiO0G9XEUey",
})

JSON

{
  "object": "api_key",
  "id": "key_4KEaYMnfrxQGkuB0svwiuyt0ZhB",
  "name": "Production web app",
  "scope": "sending",
  "sending_domain_id": "dom_4K468YrjOkR1wwdhqiO0G9XEUey",
  "last_used_at": null,
  "created_at": "2026-10-01T09:40:18.204917Z",
  "updated_at": "2026-10-01T09:40:18.204917Z",
  "key": "secret_Xq7pL2mN9vB4kR8tW1yZ6cH3jF5dS0aG"
}

JSON

{
  "error": "Invalid sending_domain_id. Domain not found in workspace"
}

JSON

{
  "error": "API key with this name already exists",
  "existing": {
    "object": "api_key",
    "id": "key_4Kw6E8FodRivXbJlwPdn79gOxi1",
    "name": "Production web app"
  }
}

API-Schlüssel abrufen

Ruft die Details eines API-Schlüssels ab. Das Secret ist nicht enthalten.

GET/api-keys/{id}

Erfordert einen API-Schlüssel mit dem Scope full. Gelöschte Schlüssel werden nicht gefunden.

Pfadparameter

idstringerforderlich

Die ID des API-Schlüssels (key_…) oder sein Name. Kodieren Sie Namen mit Leerzeichen für die URL.

Rückgabe

Gibt das API-Schlüssel-Objekt zurück.

objectstring

Immer api_key.

idstring

Die ID des API-Schlüssels.

namestring

Der Name des Schlüssels.

scopestring

full oder sending.

sending_domain_idstring | null

Die ID der Versanddomain, auf die der Schlüssel beschränkt ist, oder null.

last_used_atstring | null

Zeitpunkt, zu dem der Schlüssel zuletzt eine Anfrage authentifiziert hat, oder null, wenn er seit dem Erstellen oder Neugenerieren nicht verwendet wurde.

created_atstring

Zeitpunkt der Erstellung des Schlüssels.

updated_atstring

Zeitpunkt, zu dem der Schlüssel zuletzt umbenannt oder neu generiert wurde.

GET/api-keys/{id}

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const apiKey = await emailit.apiKeys.get('key_4KEaYMnfrxQGkuB0svwiuyt0ZhB');

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

api_key = client.api_keys.get("key_4KEaYMnfrxQGkuB0svwiuyt0ZhB")

PHP

$emailit = Emailit::client('your_api_key');

$apiKey = $emailit->apiKeys()->get('key_4KEaYMnfrxQGkuB0svwiuyt0ZhB');

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

api_key = client.api_keys.get("key_4KEaYMnfrxQGkuB0svwiuyt0ZhB")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

apiKey, err := client.ApiKeys.Get("key_4KEaYMnfrxQGkuB0svwiuyt0ZhB")

Rust

use emailit::Emailit;

let emailit = Emailit::new("your_api_key");

let api_key = emailit.api_keys.get("key_4KEaYMnfrxQGkuB0svwiuyt0ZhB").await?;

Java

import com.emailit.*;
import com.emailit.params.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject apiKey = emailit.apiKeys().get("key_4KEaYMnfrxQGkuB0svwiuyt0ZhB");

using Emailit;

var emailit = new EmailitClient("your_api_key");

var apiKey = emailit.ApiKeys.Get("key_4KEaYMnfrxQGkuB0svwiuyt0ZhB");

PHP

use Emailit\Laravel\Facades\Emailit;

$apiKey = Emailit::apiKeys()->get('key_4KEaYMnfrxQGkuB0svwiuyt0ZhB');

Terminal

curl https://api.emailit.com/v2/api-keys/key_4KEaYMnfrxQGkuB0svwiuyt0ZhB \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JSON

{
  "object": "api_key",
  "id": "key_4KEaYMnfrxQGkuB0svwiuyt0ZhB",
  "name": "Production web app",
  "scope": "sending",
  "sending_domain_id": "dom_4K468YrjOkR1wwdhqiO0G9XEUey",
  "last_used_at": "2026-10-01T11:58:02.000000Z",
  "created_at": "2026-10-01T09:40:18.204917Z",
  "updated_at": "2026-10-01T09:40:18.204917Z"
}

JSON

{
  "error": "API key not found"
}

API-Schlüssel auflisten

Gibt eine Seite mit den API-Schlüsseln des Workspaces zurück, die neuesten zuerst.

GET/api-keys

Erfordert einen API-Schlüssel mit dem Scope full. Gelöschte Schlüssel und Secrets sind nicht enthalten. Prüfen Sie last_used_at, um Schlüssel zu finden, die Sie nicht mehr verwenden.

Query-Parameter

pageintegerStandardwert: 1

Die abzurufende Seite.

limitintegerStandardwert: 10

Schlüssel pro Seite, von 1 bis 100.

searchstring

Abgleich mit dem Namen des Schlüssels, ohne Beachtung der Groß-/Kleinschreibung.

matchstringStandardwert: all

all oder or. Wie die Filter unten kombiniert werden.

orderstring

Ein Filterschlüssel, nach dem sortiert wird.

directionstring

asc oder desc.

Filter

Fügen Sie Filter in der Form key.condition=value hinzu, zum Beispiel scope.exact=sending. Siehe Filtern.

Schlüssel	Typ	Hinweise
`name`	String
`scope`	String	`full` oder `sending`.
`type`	String	Art der Zugangsdaten. In der Weboberfläche oder per API erstellte Schlüssel haben den Typ `api`.
`created_at`	Datum

Jeder Schlüssel ist auch ein Sortierschlüssel.

Rückgabe

Gibt ein Array data mit API-Schlüssel-Objekten sowie next_page_url und previous_page_url zurück. Siehe Paginierung.

GET/api-keys

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const apiKeys = await emailit.apiKeys.list();

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

api_keys = client.api_keys.list()

PHP

$emailit = Emailit::client('your_api_key');

$apiKeys = $emailit->apiKeys()->list();

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

api_keys = client.api_keys.list

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

apiKeys, err := client.ApiKeys.List(nil)

Rust

use emailit::Emailit;

let emailit = Emailit::new("your_api_key");

let api_keys = emailit.api_keys.list(None).await?;

Java

import com.emailit.*;
import com.emailit.params.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject apiKeys = emailit.apiKeys().list();

using Emailit;

var emailit = new EmailitClient("your_api_key");

var apiKeys = emailit.ApiKeys.List();

PHP

use Emailit\Laravel\Facades\Emailit;

$apiKeys = Emailit::apiKeys()->list();

Terminal

curl https://api.emailit.com/v2/api-keys \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JSON

{
  "data": [
    {
      "object": "api_key",
      "id": "key_4KEaYMnfrxQGkuB0svwiuyt0ZhB",
      "name": "Production web app",
      "scope": "sending",
      "sending_domain_id": "dom_4K468YrjOkR1wwdhqiO0G9XEUey",
      "last_used_at": "2026-10-01T11:58:02.000000Z",
      "created_at": "2026-10-01T09:40:18.204917Z",
      "updated_at": "2026-10-01T09:40:18.204917Z"
    },
    {
      "object": "api_key",
      "id": "key_4Kw6E8FodRivXbJlwPdn79gOxi1",
      "name": "Back office",
      "scope": "full",
      "sending_domain_id": null,
      "last_used_at": null,
      "created_at": "2026-09-02T14:21:07.613508Z",
      "updated_at": "2026-09-02T14:21:07.613508Z"
    }
  ],
  "next_page_url": null,
  "previous_page_url": null
}

API-Schlüssel aktualisieren

Benennt einen API-Schlüssel um.

POST/api-keys/{id}

Erfordert einen API-Schlüssel mit dem Scope full. Nur der Name lässt sich ändern. Um den Scope oder die Domain-Beschränkung zu ändern, erstellen Sie einen neuen Schlüssel und löschen diesen. Um das Secret zu ersetzen, generieren Sie es neu.

Pfadparameter

idstringerforderlich

Die ID des API-Schlüssels oder sein aktueller Name.

Body-Parameter

namestringerforderlich

Der neue Name. Muss unter den Schlüsseln des Workspaces eindeutig sein.

Rückgabe

Gibt das aktualisierte API-Schlüssel-Objekt zurück.

POST/api-keys/{id}

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const apiKey = await emailit.apiKeys.update('key_4KEaYMnfrxQGkuB0svwiuyt0ZhB', {
  name: 'Production web app (EU)',
});

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

api_key = client.api_keys.update("key_4KEaYMnfrxQGkuB0svwiuyt0ZhB", {
  "name": "Production web app (EU)",
})

PHP

$emailit = Emailit::client('your_api_key');

$apiKey = $emailit->apiKeys()->update('key_4KEaYMnfrxQGkuB0svwiuyt0ZhB', [
  'name' => 'Production web app (EU)',
]);

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

api_key = client.api_keys.update("key_4KEaYMnfrxQGkuB0svwiuyt0ZhB", name: "Production web app (EU)")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

apiKey, err := client.ApiKeys.Update("key_4KEaYMnfrxQGkuB0svwiuyt0ZhB", &emailit.UpdateApiKeyRequest{
  Name: "Production web app (EU)",
})

Rust

use emailit::Emailit;

let emailit = Emailit::new("your_api_key");

let api_key = emailit.api_keys.update("key_4KEaYMnfrxQGkuB0svwiuyt0ZhB",
  emailit::types::UpdateApiKeyParams {
    name: Some("Production web app (EU)".into()),
    ..Default::default()
  }
).await?;

Java

import com.emailit.*;
import com.emailit.params.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject apiKey = emailit.apiKeys().update("key_4KEaYMnfrxQGkuB0svwiuyt0ZhB",
  ApiKeyUpdateParams.builder()
    .setName("Production web app (EU)")
    .build()
);

using Emailit;

var emailit = new EmailitClient("your_api_key");

var apiKey = emailit.ApiKeys.Update("key_4KEaYMnfrxQGkuB0svwiuyt0ZhB", new ApiKeyUpdateOptions {
  Name = "Production web app (EU)",
});

PHP

use Emailit\Laravel\Facades\Emailit;

$apiKey = Emailit::apiKeys()->update('key_4KEaYMnfrxQGkuB0svwiuyt0ZhB', [
  'name' => 'Production web app (EU)',
]);

Terminal

curl -X POST https://api.emailit.com/v2/api-keys/key_4KEaYMnfrxQGkuB0svwiuyt0ZhB \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production web app (EU)"
  }'

JSON

{
  "object": "api_key",
  "id": "key_4KEaYMnfrxQGkuB0svwiuyt0ZhB",
  "name": "Production web app (EU)",
  "scope": "sending",
  "sending_domain_id": "dom_4K468YrjOkR1wwdhqiO0G9XEUey",
  "last_used_at": "2026-10-01T11:58:02.000000Z",
  "created_at": "2026-10-01T09:40:18.204917Z",
  "updated_at": "2026-10-01T12:10:33.000000Z"
}

JSON

{
  "error": "API key not found"
}

JSON

{
  "error": "Another API key with this name already exists"
}

API-Schlüssel neu generieren

Ersetzt das Secret des Schlüssels durch ein neues. Das bisherige Secret funktioniert für API-Anfragen und neue SMTP-Anmeldungen sofort nicht mehr. Der Schlüssel behält seine ID, seinen Namen, seinen Scope und seine Versanddomain, und last_used_at wird zurückgesetzt. Erfordert einen API-Schlüssel mit dem Scope full.

Das neue Secret wird nur in dieser Antwort zurückgegeben. Speichern Sie es sofort und aktualisieren Sie dann jede App und jeden SMTP-Client, die das alte Secret verwendet haben. Wenn Sie den Schlüssel neu generieren, mit dem Sie diese Anfrage senden, verwenden Sie für spätere Anfragen das neue Secret.

POST/api-keys/{id}/regenerate

Pfadparameter

idstringerforderlich

Die ID des API-Schlüssels (key_…) oder der Name des Schlüssels.

Rückgabe

Gibt das API-Schlüssel-Objekt mit dem neuen Secret in key zurück.

keystring

Das neue Secret: secret_, gefolgt von 32 Buchstaben und Ziffern. Wird nur einmal angezeigt.

scopestring

full oder sending.

sending_domain_idstring | null

Die Versanddomain, auf die ein Schlüssel mit dem Scope sending beschränkt ist, oder null.

last_used_atnull

Nach dem Neugenerieren immer null.

Gibt 404 zurück, wenn kein aktiver API-Schlüssel zu id passt.

POST/api-keys/{id}/regenerate

Terminal

curl -X POST https://api.emailit.com/v2/api-keys/key_3t4p05pmtgBssZzXRT0QmJn3UgH/regenerate \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JavaScript

const res = await fetch('https://api.emailit.com/v2/api-keys/key_3t4p05pmtgBssZzXRT0QmJn3UgH/regenerate', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.EMAILIT_API_KEY}` },
});
const { key } = await res.json();

Python

import os, requests

r = requests.post(
    "https://api.emailit.com/v2/api-keys/key_3t4p05pmtgBssZzXRT0QmJn3UgH/regenerate",
    headers={"Authorization": f"Bearer {os.environ['EMAILIT_API_KEY']}"},
)
new_secret = r.json()["key"]

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://api.emailit.com/v2/']);

$response = $client->post('api-keys/key_3t4p05pmtgBssZzXRT0QmJn3UgH/regenerate', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('EMAILIT_API_KEY')],
]);
$newSecret = json_decode($response->getBody(), true)['key'];

JSON

{
  "object": "api_key",
  "id": "key_3t4p05pmtgBssZzXRT0QmJn3UgH",
  "name": "Production server",
  "key": "secret_tbgPKVFk7QMi1nneTKdFcUWTyh8XoPz3",
  "scope": "sending",
  "sending_domain_id": "dom_3bTLTaNUAcCiXuokxifeIYdFOYf",
  "last_used_at": null,
  "created_at": "2026-09-12 08:01:44.120931+00",
  "updated_at": "2026-10-01T13:15:07.402881Z"
}

JSON

{
  "error": "API key not found"
}

API-Schlüssel löschen

Widerruft einen API-Schlüssel. Anfragen und SMTP-Anmeldungen mit seinem Secret schlagen ab sofort fehl.

DELETE/api-keys/{id}

Erfordert einen API-Schlüssel mit dem Scope full. Sie können auch den Schlüssel löschen, mit dem Sie die Anfrage senden. Stellen Sie deshalb vorher sicher, dass Ihre Integration einen anderen Schlüssel hat. Ein gelöschter Schlüssel erscheint nicht mehr unter API-Schlüssel auflisten, und sein Name wird für einen neuen Schlüssel frei. Bereits mit dem Schlüssel gesendete E-Mails sind nicht betroffen.

Pfadparameter

idstringerforderlich

Die ID des API-Schlüssels oder sein Name.

Rückgabe

objectstring

Immer api_key.

idstring

Die ID des gelöschten Schlüssels.

namestring

Der Name des Schlüssels.

deletedboolean

Immer true.

DELETE/api-keys/{id}

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

await emailit.apiKeys.delete('key_4Kw6E8FodRivXbJlwPdn79gOxi1');

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

client.api_keys.delete("key_4Kw6E8FodRivXbJlwPdn79gOxi1")

PHP

$emailit = Emailit::client('your_api_key');

$emailit->apiKeys()->delete('key_4Kw6E8FodRivXbJlwPdn79gOxi1');

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

client.api_keys.delete("key_4Kw6E8FodRivXbJlwPdn79gOxi1")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

err := client.ApiKeys.Delete("key_4Kw6E8FodRivXbJlwPdn79gOxi1")

Rust

use emailit::Emailit;

let emailit = Emailit::new("your_api_key");

emailit.api_keys.delete("key_4Kw6E8FodRivXbJlwPdn79gOxi1").await?;

Java

import com.emailit.*;
import com.emailit.params.*;

EmailitClient emailit = new EmailitClient("your_api_key");

emailit.apiKeys().delete("key_4Kw6E8FodRivXbJlwPdn79gOxi1");

using Emailit;

var emailit = new EmailitClient("your_api_key");

emailit.ApiKeys.Delete("key_4Kw6E8FodRivXbJlwPdn79gOxi1");

PHP

use Emailit\Laravel\Facades\Emailit;

Emailit::apiKeys()->delete('key_4Kw6E8FodRivXbJlwPdn79gOxi1');

Terminal

curl -X DELETE https://api.emailit.com/v2/api-keys/key_4Kw6E8FodRivXbJlwPdn79gOxi1 \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JSON

{
  "object": "api_key",
  "id": "key_4Kw6E8FodRivXbJlwPdn79gOxi1",
  "name": "Back office",
  "deleted": true
}

JSON

{
  "error": "API key not found"
}