Update an app

PATCH/accounts/{account_id}/realtime/kit/apps/{app_id}

Update the name of an app in your account.

Security

API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Realtime AdminRealtime

Path ParametersExpand Collapse

account_id: string

The account identifier tag.

maxLength32

app_id: string

formatuuid

Body ParametersJSONExpand Collapse

name: string

The app name. Leading and trailing whitespace is removed, and the name must contain at least one non-whitespace character.

maxLength150

ReturnsExpand Collapse

data: object { id, cf_account_tag, created_at, 2 more }

id: optional string

formatuuid

cf_account_tag: optional string

created_at: optional string

formatdate-time

is_org_on_kv: optional boolean

name: optional string

success: true

Update an app

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/realtime/kit/apps/$APP_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "name": "name"
        }'

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "cf_account_tag": "cf_account_tag",
    "created_at": "2019-12-27T18:11:19.117Z",
    "is_org_on_kv": true,
    "name": "name"
  },
  "success": true
}

Returns Examples

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "cf_account_tag": "cf_account_tag",
    "created_at": "2019-12-27T18:11:19.117Z",
    "is_org_on_kv": true,
    "name": "name"
  },
  "success": true
}