Skip to content
Cloudflare API
Start here
API Reference
Cloudforce One

Requests

List Requests
client.cloudforceOne.requests.list(RequestListParams { account_id, page, per_page, 8 more } params, RequestOptionsoptions?): SinglePage<ListItem { id, created, priority, 9 more } >
POST/accounts/{account_id}/cloudforce-one/requests
Get a Request
client.cloudforceOne.requests.get(stringrequestId, RequestGetParams { account_id } params, RequestOptionsoptions?): Item { id, content, created, 10 more }
GET/accounts/{account_id}/cloudforce-one/requests/{request_id}
Create a New Request.
client.cloudforceOne.requests.create(RequestCreateParams { account_id, content, priority, 3 more } params, RequestOptionsoptions?): Item { id, content, created, 10 more }
POST/accounts/{account_id}/cloudforce-one/requests/new
Update a Request
client.cloudforceOne.requests.update(stringrequestId, RequestUpdateParams { account_id, content, priority, 3 more } params, RequestOptionsoptions?): Item { id, content, created, 10 more }
PUT/accounts/{account_id}/cloudforce-one/requests/{request_id}
Delete a Request
client.cloudforceOne.requests.delete(stringrequestId, RequestDeleteParams { account_id } params, RequestOptionsoptions?): RequestDeleteResponse { errors, messages, success }
DELETE/accounts/{account_id}/cloudforce-one/requests/{request_id}
Get Request Quota
client.cloudforceOne.requests.quota(RequestQuotaParams { account_id } params, RequestOptionsoptions?): Quota { anniversary_date, quarter_anniversary_date, quota, remaining }
GET/accounts/{account_id}/cloudforce-one/requests/quota
Get Request Types
client.cloudforceOne.requests.types(RequestTypesParams { account_id } params, RequestOptionsoptions?): SinglePage<RequestTypesResponse>
GET/accounts/{account_id}/cloudforce-one/requests/types
Get Request Priority, Status, and TLP constants
client.cloudforceOne.requests.constants(RequestConstantsParams { account_id } params, RequestOptionsoptions?): RequestConstants { priority, status, tlp }
GET/accounts/{account_id}/cloudforce-one/requests/constants
ModelsExpand Collapse
Item { id, content, created, 10 more }
id: string

UUID.

maxLength36
content: string

Request content.

created: string
formatdate-time
priority: string
formatdate-time
request: string

Requested information from request.

summary: string

Brief description of the request.

tlp: "clear" | "amber" | "amber-strict" | 2 more

The CISA defined Traffic Light Protocol (TLP).

One of the following:
"clear"
"amber"
"amber-strict"
"green"
"red"
updated: string
formatdate-time
completed?: string
formatdate-time
message_tokens?: number

Tokens for the request messages.

readable_id?: string

Readable Request ID.

status?: "open" | "accepted" | "reported" | 3 more

Request Status.

One of the following:
"open"
"accepted"
"reported"
"approved"
"completed"
"declined"
tokens?: number

Tokens for the request.

ListItem { id, created, priority, 9 more }
id: string

UUID.

maxLength36
created: string

Request creation time.

formatdate-time
priority: "routine" | "high" | "urgent"
One of the following:
"routine"
"high"
"urgent"
request: string

Requested information from request.

summary: string

Brief description of the request.

tlp: "clear" | "amber" | "amber-strict" | 2 more

The CISA defined Traffic Light Protocol (TLP).

One of the following:
"clear"
"amber"
"amber-strict"
"green"
"red"
updated: string

Request last updated time.

formatdate-time
completed?: string

Request completion time.

formatdate-time
message_tokens?: number

Tokens for the request messages.

readable_id?: string

Readable Request ID.

status?: "open" | "accepted" | "reported" | 3 more

Request Status.

One of the following:
"open"
"accepted"
"reported"
"approved"
"completed"
"declined"
tokens?: number

Tokens for the request.

Quota { anniversary_date, quarter_anniversary_date, quota, remaining }
anniversary_date?: string

Anniversary date is when annual quota limit is refreshed.

formatdate-time
quarter_anniversary_date?: string

Quarter anniversary date is when quota limit is refreshed each quarter.

formatdate-time
quota?: number

Tokens for the quarter.

remaining?: number

Tokens remaining for the quarter.

RequestConstants { priority, status, tlp }
priority?: Array<"routine" | "high" | "urgent">
One of the following:
"routine"
"high"
"urgent"
status?: Array<"open" | "accepted" | "reported" | 3 more>
One of the following:
"open"
"accepted"
"reported"
"approved"
"completed"
"declined"
tlp?: Array<"clear" | "amber" | "amber-strict" | 2 more>
One of the following:
"clear"
"amber"
"amber-strict"
"green"
"red"
RequestTypes = Array<RequestTypesResponse>
RequestDeleteResponse { errors, messages, success }
errors: Array<Error>
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
messages: Array<Message>
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
success: true

Whether the API call was successful.

RequestTypesResponse = string

Request Types.

RequestsMessage

List Request Messages
client.cloudforceOne.requests.message.get(stringrequestId, MessageGetParams { account_id, page, per_page, 4 more } params, RequestOptionsoptions?): SinglePage<Message { id, author, content, 3 more } >
POST/accounts/{account_id}/cloudforce-one/requests/{request_id}/message
Create a New Request Message
client.cloudforceOne.requests.message.create(stringrequestId, MessageCreateParams { account_id, content } params, RequestOptionsoptions?): Message { id, author, content, 3 more }
POST/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/new
Update a Request Message
client.cloudforceOne.requests.message.update(stringrequestId, numbermessageId, MessageUpdateParams { account_id, content } params, RequestOptionsoptions?): Message { id, author, content, 3 more }
PUT/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id}
Delete a Request Message
client.cloudforceOne.requests.message.delete(stringrequestId, numbermessageId, MessageDeleteParams { account_id } params, RequestOptionsoptions?): MessageDeleteResponse { errors, messages, success }
DELETE/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id}
ModelsExpand Collapse
Message { id, author, content, 3 more }
id: number

Message ID.

author: string

Author of message.

content: string

Content of message.

is_follow_on_request: boolean

Whether the message is a follow-on request.

updated: string

Defines the message last updated time.

formatdate-time
created?: string

Defines the message creation time.

formatdate-time
MessageDeleteResponse { errors, messages, success }
errors: Array<Error>
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
messages: Array<Message>
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
success: true

Whether the API call was successful.

RequestsPriority

Get a Priority Intelligence Requirement
client.cloudforceOne.requests.priority.get(stringpriorityId, PriorityGetParams { account_id } params, RequestOptionsoptions?): Item { id, content, created, 10 more }
GET/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}
Create a New Priority Intelligence Requirement
client.cloudforceOne.requests.priority.create(PriorityCreateParams { account_id, labels, priority, 2 more } params, RequestOptionsoptions?): Priority { id, created, labels, 4 more }
POST/accounts/{account_id}/cloudforce-one/requests/priority/new
Update a Priority Intelligence Requirement
client.cloudforceOne.requests.priority.update(stringpriorityId, PriorityUpdateParams { account_id, labels, priority, 2 more } params, RequestOptionsoptions?): Item { id, content, created, 10 more }
PUT/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}
Delete a Priority Intelligence Requirement
client.cloudforceOne.requests.priority.delete(stringpriorityId, PriorityDeleteParams { account_id } params, RequestOptionsoptions?): PriorityDeleteResponse { errors, messages, success }
DELETE/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}
Get Priority Intelligence Requirement Quota
client.cloudforceOne.requests.priority.quota(PriorityQuotaParams { account_id } params, RequestOptionsoptions?): Quota { anniversary_date, quarter_anniversary_date, quota, remaining }
GET/accounts/{account_id}/cloudforce-one/requests/priority/quota
ModelsExpand Collapse
Label = string
Priority { id, created, labels, 4 more }
id: string

UUID.

maxLength36
created: string

Priority creation time.

formatdate-time
labels: Array<Label>

List of labels.

priority: number

Priority.

requirement: string

Requirement.

tlp: "clear" | "amber" | "amber-strict" | 2 more

The CISA defined Traffic Light Protocol (TLP).

One of the following:
"clear"
"amber"
"amber-strict"
"green"
"red"
updated: string

Priority last updated time.

formatdate-time
PriorityEdit { labels, priority, requirement, tlp }
labels: Array<Label>

List of labels.

priority: number

Priority.

requirement: string

Requirement.

tlp: "clear" | "amber" | "amber-strict" | 2 more

The CISA defined Traffic Light Protocol (TLP).

One of the following:
"clear"
"amber"
"amber-strict"
"green"
"red"
PriorityDeleteResponse { errors, messages, success }
errors: Array<Error>
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
messages: Array<Message>
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
success: true

Whether the API call was successful.

RequestsAssets

Get a Request Asset
client.cloudforceOne.requests.assets.get(stringrequestId, stringassetId, AssetGetParams { account_id } params, RequestOptionsoptions?): SinglePage<AssetGetResponse { id, name, created, 2 more } >
GET/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}
List Request Assets
client.cloudforceOne.requests.assets.create(stringrequestId, AssetCreateParams { account_id, page, per_page } params, RequestOptionsoptions?): SinglePage<AssetCreateResponse { id, name, created, 2 more } >
POST/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset
Update a Request Asset
client.cloudforceOne.requests.assets.update(stringrequestId, stringassetId, AssetUpdateParams { account_id, source } params, RequestOptionsoptions?): AssetUpdateResponse { id, name, created, 2 more }
PUT/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}
Delete a Request Asset
client.cloudforceOne.requests.assets.delete(stringrequestId, stringassetId, AssetDeleteParams { account_id } params, RequestOptionsoptions?): AssetDeleteResponse { errors, messages, success }
DELETE/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}
ModelsExpand Collapse
AssetGetResponse { id, name, created, 2 more }
id: number

Asset ID.

name: string

Asset name.

created?: string

Defines the asset creation time.

formatdate-time
description?: string

Asset description.

file_type?: string

Asset file type.

AssetCreateResponse { id, name, created, 2 more }
id: number

Asset ID.

name: string

Asset name.

created?: string

Defines the asset creation time.

formatdate-time
description?: string

Asset description.

file_type?: string

Asset file type.

AssetUpdateResponse { id, name, created, 2 more }
id: number

Asset ID.

name: string

Asset name.

created?: string

Defines the asset creation time.

formatdate-time
description?: string

Asset description.

file_type?: string

Asset file type.

AssetDeleteResponse { errors, messages, success }
errors: Array<Error>
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
messages: Array<Message>
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
success: true

Whether the API call was successful.