Create App

client.realtimeKit.apps.post(, ?): AppPostResponse { data, success }

POST/accounts/{account_id}/realtime/kit/apps

Create new app for your account

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Realtime AdminRealtime

ParametersExpand Collapse

params: AppPostParams { account_id, name }

account_id: string

Path param

name: string

Body param

ReturnsExpand Collapse

AppPostResponse { data, success }

data?: Data { app }

app?: App { id, created_at, name }

id?: string

created_at?: string

name?: string

success?: boolean

Create App

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.realtimeKit.apps.post({ account_id: 'account_id', name: 'name' });

console.log(response.data);

{
  "data": {
    "app": {
      "created_at": "2025-01-01T08:16:40.644Z",
      "id": "my-app-id",
      "name": "my-new-app"
    }
  },
  "success": true
}

Returns Examples

{
  "data": {
    "app": {
      "created_at": "2025-01-01T08:16:40.644Z",
      "id": "my-app-id",
      "name": "my-new-app"
    }
  },
  "success": true
}