Update Access application settings

client.zeroTrust.access.applications.settings.edit(, , ?): SettingEditResponse { allow_iframe, skip_interstitial }

PATCH/{accounts_or_zones}/{account_or_zone_id}/access/apps/{app_id}/settings

Updates Access application settings.

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

ParametersExpand Collapse

app_id: AppID

Identifier.

maxLength32

params: SettingEditParams { account_id, zone_id, allow_iframe, skip_interstitial }

account_id?: string

Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

zone_id?: string

Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

allow_iframe?: boolean

Body param: Enables loading application content in an iFrame.

skip_interstitial?: boolean

Body param: Enables automatic authentication through cloudflared.

ReturnsExpand Collapse

SettingEditResponse { allow_iframe, skip_interstitial }

allow_iframe?: boolean

Enables loading application content in an iFrame.

skip_interstitial?: boolean

Enables automatic authentication through cloudflared.

Update Access application settings

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.zeroTrust.access.applications.settings.edit(
  '023e105f4ecef8ad9ca31a8372d0c353',
  { account_id: 'account_id' },
);

console.log(response.allow_iframe);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "allow_iframe": true,
    "skip_interstitial": true
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "allow_iframe": true,
    "skip_interstitial": true
  }
}