API Reference

Zero Trust

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Resource Library

Resource LibraryApplications

List applications

client.zeroTrust.resourceLibrary.applications.list(ApplicationListParams { account_id, fields, filter, 4 more } params, RequestOptionsoptions?): SinglePage<ApplicationListResponse { id, application_confidence_score, application_score_composition, 16 more } >

GET/accounts/{account_id}/resource-library/applications

Get application

client.zeroTrust.resourceLibrary.applications.get(numberid, ApplicationGetParams { account_id } params, RequestOptionsoptions?): ApplicationGetResponse { id, application_confidence_score, application_source, 15 more }

GET/accounts/{account_id}/resource-library/applications/{id}

Create application

client.zeroTrust.resourceLibrary.applications.create(ApplicationCreateParams { account_id, category_id, human_id, 5 more } params, RequestOptionsoptions?): ApplicationCreateResponse { id, application_confidence_score, application_source, 15 more }

POST/accounts/{account_id}/resource-library/applications

Update application

client.zeroTrust.resourceLibrary.applications.update(numberid, ApplicationUpdateParams { account_id, hostnames, ip_subnets, 2 more } params, RequestOptionsoptions?): ApplicationUpdateResponse { id, application_confidence_score, application_source, 15 more }

PATCH/accounts/{account_id}/resource-library/applications/{id}

Delete application

client.zeroTrust.resourceLibrary.applications.delete(numberid, ApplicationDeleteParams { account_id } params, RequestOptionsoptions?): ApplicationDeleteResponse | null

DELETE/accounts/{account_id}/resource-library/applications/{id}

ModelsExpand Collapse

ApplicationListResponse { id, application_confidence_score, application_score_composition, 16 more }

Describes one application in a list response. This endpoint returns every property below unless the fields query parameter narrows the response, so treat all of them except id as optional.

id: number

Returns the application ID.

formatint64

maximum4294967295

minimum0

application_confidence_score?: number

Confidence score for the application. Returns -1 when no score is available.

formatfloat

application_score_composition?: unknown

Returns the score composition breakdown for the application.

application_source?: string

Returns the application source.

application_type?: string

Returns the application type.

application_type_description?: string

Returns the application type description.

category_id?: number

Returns the category ID.

formatint64

maximum4294967295

minimum1

created_at?: string

Returns the application creation time.

gen_ai_score?: number

GenAI score for the application. Returns -1 when no score is available.

formatfloat

hostnames?: Array<string>

Hostnames matched by the application.

human_id?: string

Returns the human readable ID.

ip_subnets?: Array<string>

IP subnets matched by the application.

name?: string

Returns the application name.

port_protocols?: Array<string>

Port and protocol pairs matched by the application.

review_status?: "approved" | "unapproved" | "in_review" | "unreviewed"

The account-specific Gateway review status. Applications with no assigned review status are returned as unreviewed.

One of the following:

"approved"

"unapproved"

"in_review"

"unreviewed"

support_domains?: Array<string>

Support domains matched by the application.

supported?: Array<"GATEWAY" | "ACCESS" | "CASB">

Cloudflare products that support this application.

One of the following:

"GATEWAY"

"ACCESS"

"CASB"

updated_at?: string

Returns the application update time.

version?: string

Returns the application version.

ApplicationGetResponse { id, application_confidence_score, application_source, 15 more }

id: number

Returns the application ID.

formatint64

maximum4294967295

minimum0

application_confidence_score: number

Confidence score for the application. Returns -1 when no score is available.

formatfloat

application_source: string

Returns the application source.

application_type: string

Returns the application type.

application_type_description: string

Returns the application type description.

category_id: number

Returns the category ID.

formatint64

maximum4294967295

minimum1

created_at: string

Returns the application creation time.

gen_ai_score: number

GenAI score for the application. Returns -1 when no score is available.

formatfloat

hostnames: Array<string>

Hostnames matched by the application.

human_id: string

Returns the human readable ID.

ip_subnets: Array<string>

IP subnets matched by the application.

name: string

Returns the application name.

port_protocols: Array<string>

Port and protocol pairs matched by the application.

support_domains: Array<string>

Support domains matched by the application.

supported: Array<"GATEWAY" | "ACCESS" | "CASB">

Cloudflare products that support this application.

One of the following:

"GATEWAY"

"ACCESS"

"CASB"

updated_at: string

Returns the application update time.

version: string

Returns the application version.

application_score_composition?: unknown

Returns the score composition breakdown for the application.

ApplicationCreateResponse { id, application_confidence_score, application_source, 15 more }

id: number

Returns the application ID.

formatint64

maximum4294967295

minimum0

application_confidence_score: number

Confidence score for the application. Returns -1 when no score is available.

formatfloat

application_source: string

Returns the application source.

application_type: string

Returns the application type.

application_type_description: string

Returns the application type description.

category_id: number

Returns the category ID.

formatint64

maximum4294967295

minimum1

created_at: string

Returns the application creation time.

gen_ai_score: number

GenAI score for the application. Returns -1 when no score is available.

formatfloat

hostnames: Array<string>

Hostnames matched by the application.

human_id: string

Returns the human readable ID.

ip_subnets: Array<string>

IP subnets matched by the application.

name: string

Returns the application name.

port_protocols: Array<string>

Port and protocol pairs matched by the application.

support_domains: Array<string>

Support domains matched by the application.

supported: Array<"GATEWAY" | "ACCESS" | "CASB">

Cloudflare products that support this application.

One of the following:

"GATEWAY"

"ACCESS"

"CASB"

updated_at: string

Returns the application update time.

version: string

Returns the application version.

application_score_composition?: unknown

Returns the score composition breakdown for the application.

ApplicationUpdateResponse { id, application_confidence_score, application_source, 15 more }

id: number

Returns the application ID.

formatint64

maximum4294967295

minimum0

application_confidence_score: number

Confidence score for the application. Returns -1 when no score is available.

formatfloat

application_source: string

Returns the application source.

application_type: string

Returns the application type.

application_type_description: string

Returns the application type description.

category_id: number

Returns the category ID.

formatint64

maximum4294967295

minimum1

created_at: string

Returns the application creation time.

gen_ai_score: number

GenAI score for the application. Returns -1 when no score is available.

formatfloat

hostnames: Array<string>

Hostnames matched by the application.

human_id: string

Returns the human readable ID.

ip_subnets: Array<string>

IP subnets matched by the application.

name: string

Returns the application name.

port_protocols: Array<string>

Port and protocol pairs matched by the application.

support_domains: Array<string>

Support domains matched by the application.

supported: Array<"GATEWAY" | "ACCESS" | "CASB">

Cloudflare products that support this application.

One of the following:

"GATEWAY"

"ACCESS"

"CASB"

updated_at: string

Returns the application update time.

version: string

Returns the application version.

application_score_composition?: unknown

Returns the score composition breakdown for the application.

ApplicationDeleteResponse = unknown

Resource LibraryCategories

List application categories

client.zeroTrust.resourceLibrary.categories.list(CategoryListParams { account_id, limit, offset } params, RequestOptionsoptions?): SinglePage<CategoryListResponse { id, created_at, description, name } >

GET/accounts/{account_id}/resource-library/categories

Get application category

client.zeroTrust.resourceLibrary.categories.get(numberid, CategoryGetParams { account_id } params, RequestOptionsoptions?): CategoryGetResponse { id, created_at, description, name }

GET/accounts/{account_id}/resource-library/categories/{id}

ModelsExpand Collapse

CategoryListResponse { id, created_at, description, name }

id: number

Returns the category ID.

formatint64

maximum4294967295

minimum1

created_at: string

Returns the category creation time.

description: string

Returns the category description.

name: string

Returns the category name.

CategoryGetResponse { id, created_at, description, name }

id: number

Returns the category ID.

formatint64

maximum4294967295

minimum1

created_at: string

Returns the category creation time.

description: string

Returns the category description.

name: string

Returns the category name.