PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/api-keysAPI keys bound to the app
POST/v1/apps/{appId}/api-keysCreate 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}/rotateRotate a key (the old value is invalidated immediately)

Details

API keys bound to the app

GET/v1/apps/{appId}/api-keysTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ApiKeyList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].org_idstringYes
data[].app_idstring | nullYes
data[].namestringYes
data[].prefixstringYes
data[].scopesarray<string>Yes
data[].last_used_atstring | nullYes
data[].expires_atstring | nullYes
data[].revoked_atstring | nullYes
data[].ip_allowlistarray<string>Yes
data[].rotated_atstring | nullYes
data[].created_bystring | nullYes
data[].created_atstringYes

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)

POST/v1/apps/{appId}/api-keysTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateAppApiKeyDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
scopesarray<enum>YesItems: 1–8
environmentenumNoValues: "live", "test"; Default: "live"
expires_atstring (date-time) | nullNo
ip_allowlistarray<string>NoItems: 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

FieldTypeRequiredDescription
idstringYes
org_idstringYes
app_idstring | nullYes
namestringYes
prefixstringYes
scopesarray<string>Yes
last_used_atstring | nullYes
expires_atstring | nullYes
revoked_atstring | nullYes
ip_allowlistarray<string>Yes
rotated_atstring | nullYes
created_bystring | nullYes
created_atstringYes
keystringYes

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)

PATCH/v1/apps/{appId}/api-keys/{keyId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
keyIdpathstringYes"key_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateApiKeyDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
scopesarray<enum>NoItems: 1–8
ip_allowlistarray<string>NoItems: 0–50
expires_atstring (date-time) | nullNo

Example:

{
  "name": "Sipariş bildirimleri",
  "scopes": [
    "admin"
  ],
  "ip_allowlist": [
    "örnek"
  ],
  "expires_at": "2026-10-17T09:00:00Z"
}

Responses

200 — Success.

Schema: ApiKey

FieldTypeRequiredDescription
idstringYes
org_idstringYes
app_idstring | nullYes
namestringYes
prefixstringYes
scopesarray<string>Yes
last_used_atstring | nullYes
expires_atstring | nullYes
revoked_atstring | nullYes
ip_allowlistarray<string>Yes
rotated_atstring | nullYes
created_bystring | nullYes
created_atstringYes

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

DELETE/v1/apps/{appId}/api-keys/{keyId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
keyIdpathstringYes"key_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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)

POST/v1/apps/{appId}/api-keys/{keyId}/rotateTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
keyIdpathstringYes"key_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CreatedApiKey

FieldTypeRequiredDescription
idstringYes
org_idstringYes
app_idstring | nullYes
namestringYes
prefixstringYes
scopesarray<string>Yes
last_used_atstring | nullYes
expires_atstring | nullYes
revoked_atstring | nullYes
ip_allowlistarray<string>Yes
rotated_atstring | nullYes
created_bystring | nullYes
created_atstringYes
keystringYes

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"

On this page