Search + K

Command Palette

Search for a command to run...

Sign In

Add an Access application

POST /accounts/{account_id}/access/apps
Copy endpoint
https://api.cloudflare.com/client/v4

Adds a new application to Access.

Parameters

path Path Parameters

Name Type
account_id required
type AccessIdentifier = string

Request Body

application/json required
type AccessAppRequest = interface AccessBookmarkProps {
app_launcher_visible?: AccessAppLauncherVisible

Displays the application in the App Launcher.

type AccessAppLauncherVisible = boolean
;
domain?: string;
logo_url?: AccessLogoUrl

The image URL for the logo shown in the App Launcher dashboard.

type AccessLogoUrl = string
;
name?: AccessAppsComponentsSchemasName

The name of the application.

type AccessAppsComponentsSchemasName = string
;
tags?: AccessTags

The tags you want assigned to an application. Tags are used to filter applications in the App Launcher dashboard.

type AccessTags = string[]
;
type?: AccessType

The application type.

type AccessType = "self_hosted" | "saas" | "ssh" | "vnc" | "app_launcher" | "warp" | "biso" | "bookmark" | "dash_sso" | "infrastructure" | "rdp"
;
}
& {}

Responses

201 application/json

Add an Access application response

type AccessAppsComponentsSchemasSingleResponse = never & { result?: AccessAppResponse
type AccessAppResponse = never
; }

Client Errors

4XX application/json

Add an Access application response failure

interface AccessApiResponseCommonFailure {
errors: AccessMessages
type AccessMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}
[]
;
messages: AccessMessages
type AccessMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}
[]
;
result: null;
success: false;
}