API keys
API keys — 5 operations (GET /v1/apps/{appId}/api-keys, POST /v1/apps/{appId}/api-keys, PATCH /v1/apps/{appId}/api-keys/{keyId}, …). Generated from the OpenAPI 3.1.0 contract.
Create app API keys, update scopes and IP allowlists, rotate and revoke. The raw key is returned only in the create and rotation responses.
Base URL: https://api.pushizo.com · Tag: api-keys · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/api-keys | API keys bound to the app |
POST | /v1/apps/{appId}/api-keys | Create an API key bound to the app (the raw key is returned only in this response) |
PATCH | /v1/apps/{appId}/api-keys/{keyId} | Update a key (name, scopes, IP allowlist, expiry) |
DELETE | /v1/apps/{appId}/api-keys/{keyId} | Revoke a key |
POST | /v1/apps/{appId}/api-keys/{keyId}/rotate | Rotate a key (the old value is invalidated immediately) |
Details
API keys bound to the app
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ApiKeyList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].org_id | string | Yes | |
data[].app_id | string | null | Yes | |
data[].name | string | Yes | |
data[].prefix | string | Yes | |
data[].scopes | array<string> | Yes | |
data[].last_used_at | string | null | Yes | |
data[].expires_at | string | null | Yes | |
data[].revoked_at | string | null | Yes | |
data[].ip_allowlist | array<string> | Yes | |
data[].rotated_at | string | null | Yes | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"id": "key_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"prefix": "örnek",
"scopes": [
"notifications:write"
],
"last_used_at": "örnek",
"expires_at": "örnek",
"revoked_at": "örnek",
"ip_allowlist": [
"örnek"
],
"rotated_at": "örnek",
"created_by": "örnek",
"created_at": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/api-keys" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create an API key bound to the app (the raw key is returned only in this response)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateAppApiKeyDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
scopes | array<enum> | Yes | Items: 1–8 |
environment | enum | No | Values: "live", "test"; Default: "live" |
expires_at | string (date-time) | null | No | |
ip_allowlist | array<string> | No | Items: 0–50 |
Example:
{
"name": "Sipariş bildirimleri",
"scopes": [
"admin"
],
"environment": "live",
"expires_at": "2026-10-17T09:00:00Z",
"ip_allowlist": [
"örnek"
]
}Responses
201 — Success.
Schema: CreatedApiKey
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
org_id | string | Yes | |
app_id | string | null | Yes | |
name | string | Yes | |
prefix | string | Yes | |
scopes | array<string> | Yes | |
last_used_at | string | null | Yes | |
expires_at | string | null | Yes | |
revoked_at | string | null | Yes | |
ip_allowlist | array<string> | Yes | |
rotated_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
key | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "key_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"prefix": "örnek",
"scopes": [
"notifications:write"
],
"last_used_at": "örnek",
"expires_at": "örnek",
"revoked_at": "örnek",
"ip_allowlist": [
"örnek"
],
"rotated_at": "örnek",
"created_by": "örnek",
"created_at": "örnek",
"key": "key-2026-10"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/api-keys" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"scopes": [
"admin"
],
"environment": "live",
"expires_at": "2026-10-17T09:00:00Z",
"ip_allowlist": [
"örnek"
]
}'Update a key (name, scopes, IP allowlist, expiry)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
keyId | path | string | Yes | "key_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateApiKeyDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
scopes | array<enum> | No | Items: 1–8 |
ip_allowlist | array<string> | No | Items: 0–50 |
expires_at | string (date-time) | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"scopes": [
"admin"
],
"ip_allowlist": [
"örnek"
],
"expires_at": "2026-10-17T09:00:00Z"
}Responses
200 — Success.
Schema: ApiKey
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
org_id | string | Yes | |
app_id | string | null | Yes | |
name | string | Yes | |
prefix | string | Yes | |
scopes | array<string> | Yes | |
last_used_at | string | null | Yes | |
expires_at | string | null | Yes | |
revoked_at | string | null | Yes | |
ip_allowlist | array<string> | Yes | |
rotated_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "key_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"prefix": "örnek",
"scopes": [
"notifications:write"
],
"last_used_at": "örnek",
"expires_at": "örnek",
"revoked_at": "örnek",
"ip_allowlist": [
"örnek"
],
"rotated_at": "örnek",
"created_by": "örnek",
"created_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/api-keys/key_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"scopes": [
"admin"
],
"ip_allowlist": [
"örnek"
],
"expires_at": "2026-10-17T09:00:00Z"
}'Revoke a key
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
keyId | path | string | Yes | "key_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/api-keys/key_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Rotate a key (the old value is invalidated immediately)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
keyId | path | string | Yes | "key_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CreatedApiKey
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
org_id | string | Yes | |
app_id | string | null | Yes | |
name | string | Yes | |
prefix | string | Yes | |
scopes | array<string> | Yes | |
last_used_at | string | null | Yes | |
expires_at | string | null | Yes | |
revoked_at | string | null | Yes | |
ip_allowlist | array<string> | Yes | |
rotated_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
key | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "key_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"prefix": "örnek",
"scopes": [
"notifications:write"
],
"last_used_at": "örnek",
"expires_at": "örnek",
"revoked_at": "örnek",
"ip_allowlist": [
"örnek"
],
"rotated_at": "örnek",
"created_by": "örnek",
"created_at": "örnek",
"key": "key-2026-10"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/api-keys/key_01JD3W5Q7X9K2M4N6P8R0T1V3W/rotate" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Organization
Organization — 1 operations (GET /v1/organization/usage). Generated from the OpenAPI 3.1.0 contract.
Identity verification keys
Identity verification keys — 3 operations (GET /v1/apps/{appId}/identity-keys, POST /v1/apps/{appId}/identity-keys, DELETE /v1/apps/{appId}/identity-keys/{keyId}). Generated from the OpenAPI 3.1.0 contract.