Skip to content
Cloudflare API
Start here
API Reference
Cloudforce One

Requests

List Requests
cloudforce_one.requests.list(RequestListParams**kwargs) -> SyncSinglePage[ListItem]
POST/accounts/{account_id}/cloudforce-one/requests
Get a Request
cloudforce_one.requests.get(strrequest_id, RequestGetParams**kwargs) -> Item
GET/accounts/{account_id}/cloudforce-one/requests/{request_id}
Create a New Request.
cloudforce_one.requests.create(RequestCreateParams**kwargs) -> Item
POST/accounts/{account_id}/cloudforce-one/requests/new
Update a Request
cloudforce_one.requests.update(strrequest_id, RequestUpdateParams**kwargs) -> Item
PUT/accounts/{account_id}/cloudforce-one/requests/{request_id}
Delete a Request
cloudforce_one.requests.delete(strrequest_id, RequestDeleteParams**kwargs) -> RequestDeleteResponse
DELETE/accounts/{account_id}/cloudforce-one/requests/{request_id}
Get Request Quota
cloudforce_one.requests.quota(RequestQuotaParams**kwargs) -> Quota
GET/accounts/{account_id}/cloudforce-one/requests/quota
Get Request Types
cloudforce_one.requests.types(RequestTypesParams**kwargs) -> SyncSinglePage[RequestTypesResponse]
GET/accounts/{account_id}/cloudforce-one/requests/types
Get Request Priority, Status, and TLP constants
cloudforce_one.requests.constants(RequestConstantsParams**kwargs) -> RequestConstants
GET/accounts/{account_id}/cloudforce-one/requests/constants
ModelsExpand Collapse
class Item: …
id: str

UUID.

maxLength36
content: str

Request content.

created: datetime
formatdate-time
priority: datetime
formatdate-time
request: str

Requested information from request.

summary: str

Brief description of the request.

tlp: Literal["clear", "amber", "amber-strict", 2 more]

The CISA defined Traffic Light Protocol (TLP).

One of the following:
"clear"
"amber"
"amber-strict"
"green"
"red"
updated: datetime
formatdate-time
completed: Optional[datetime]
formatdate-time
message_tokens: Optional[int]

Tokens for the request messages.

readable_id: Optional[str]

Readable Request ID.

status: Optional[Literal["open", "accepted", "reported", 3 more]]

Request Status.

One of the following:
"open"
"accepted"
"reported"
"approved"
"completed"
"declined"
tokens: Optional[int]

Tokens for the request.

class ListItem: …
id: str

UUID.

maxLength36
created: datetime

Request creation time.

formatdate-time
priority: Literal["routine", "high", "urgent"]
One of the following:
"routine"
"high"
"urgent"
request: str

Requested information from request.

summary: str

Brief description of the request.

tlp: Literal["clear", "amber", "amber-strict", 2 more]

The CISA defined Traffic Light Protocol (TLP).

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

Request last updated time.

formatdate-time
completed: Optional[datetime]

Request completion time.

formatdate-time
message_tokens: Optional[int]

Tokens for the request messages.

readable_id: Optional[str]

Readable Request ID.

status: Optional[Literal["open", "accepted", "reported", 3 more]]

Request Status.

One of the following:
"open"
"accepted"
"reported"
"approved"
"completed"
"declined"
tokens: Optional[int]

Tokens for the request.

class Quota: …
anniversary_date: Optional[datetime]

Anniversary date is when annual quota limit is refreshed.

formatdate-time
quarter_anniversary_date: Optional[datetime]

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

formatdate-time
quota: Optional[int]

Tokens for the quarter.

remaining: Optional[int]

Tokens remaining for the quarter.

class RequestConstants: …
priority: Optional[List[Literal["routine", "high", "urgent"]]]
One of the following:
"routine"
"high"
"urgent"
status: Optional[List[Literal["open", "accepted", "reported", 3 more]]]
One of the following:
"open"
"accepted"
"reported"
"approved"
"completed"
"declined"
tlp: Optional[List[Literal["clear", "amber", "amber-strict", 2 more]]]
One of the following:
"clear"
"amber"
"amber-strict"
"green"
"red"
class RequestDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

str

Request Types.

RequestsMessage

List Request Messages
cloudforce_one.requests.message.get(strrequest_id, MessageGetParams**kwargs) -> SyncSinglePage[Message]
POST/accounts/{account_id}/cloudforce-one/requests/{request_id}/message
Create a New Request Message
cloudforce_one.requests.message.create(strrequest_id, MessageCreateParams**kwargs) -> Message
POST/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/new
Update a Request Message
cloudforce_one.requests.message.update(intmessage_id, MessageUpdateParams**kwargs) -> Message
PUT/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id}
Delete a Request Message
cloudforce_one.requests.message.delete(intmessage_id, MessageDeleteParams**kwargs) -> MessageDeleteResponse
DELETE/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id}
ModelsExpand Collapse
class Message: …
id: int

Message ID.

author: str

Author of message.

content: str

Content of message.

is_follow_on_request: bool

Whether the message is a follow-on request.

updated: datetime

Defines the message last updated time.

formatdate-time
created: Optional[datetime]

Defines the message creation time.

formatdate-time
class MessageDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

RequestsPriority

Get a Priority Intelligence Requirement
cloudforce_one.requests.priority.get(strpriority_id, PriorityGetParams**kwargs) -> Item
GET/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}
Create a New Priority Intelligence Requirement
cloudforce_one.requests.priority.create(PriorityCreateParams**kwargs) -> Priority
POST/accounts/{account_id}/cloudforce-one/requests/priority/new
Update a Priority Intelligence Requirement
cloudforce_one.requests.priority.update(strpriority_id, PriorityUpdateParams**kwargs) -> Item
PUT/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}
Delete a Priority Intelligence Requirement
cloudforce_one.requests.priority.delete(strpriority_id, PriorityDeleteParams**kwargs) -> PriorityDeleteResponse
DELETE/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}
Get Priority Intelligence Requirement Quota
cloudforce_one.requests.priority.quota(PriorityQuotaParams**kwargs) -> Quota
GET/accounts/{account_id}/cloudforce-one/requests/priority/quota
ModelsExpand Collapse
str
class Priority: …
id: str

UUID.

maxLength36
created: datetime

Priority creation time.

formatdate-time
labels: List[Label]

List of labels.

priority: int

Priority.

requirement: str

Requirement.

tlp: Literal["clear", "amber", "amber-strict", 2 more]

The CISA defined Traffic Light Protocol (TLP).

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

Priority last updated time.

formatdate-time
class PriorityEdit: …
labels: List[Label]

List of labels.

priority: int

Priority.

requirement: str

Requirement.

tlp: Literal["clear", "amber", "amber-strict", 2 more]

The CISA defined Traffic Light Protocol (TLP).

One of the following:
"clear"
"amber"
"amber-strict"
"green"
"red"
class PriorityDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

RequestsAssets

Get a Request Asset
cloudforce_one.requests.assets.get(strasset_id, AssetGetParams**kwargs) -> SyncSinglePage[AssetGetResponse]
GET/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}
List Request Assets
cloudforce_one.requests.assets.create(strrequest_id, AssetCreateParams**kwargs) -> SyncSinglePage[AssetCreateResponse]
POST/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset
Update a Request Asset
cloudforce_one.requests.assets.update(strasset_id, AssetUpdateParams**kwargs) -> AssetUpdateResponse
PUT/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}
Delete a Request Asset
cloudforce_one.requests.assets.delete(strasset_id, AssetDeleteParams**kwargs) -> AssetDeleteResponse
DELETE/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}
ModelsExpand Collapse
class AssetGetResponse: …
id: int

Asset ID.

name: str

Asset name.

created: Optional[datetime]

Defines the asset creation time.

formatdate-time
description: Optional[str]

Asset description.

file_type: Optional[str]

Asset file type.

class AssetCreateResponse: …
id: int

Asset ID.

name: str

Asset name.

created: Optional[datetime]

Defines the asset creation time.

formatdate-time
description: Optional[str]

Asset description.

file_type: Optional[str]

Asset file type.

class AssetUpdateResponse: …
id: int

Asset ID.

name: str

Asset name.

created: Optional[datetime]

Defines the asset creation time.

formatdate-time
description: Optional[str]

Asset description.

file_type: Optional[str]

Asset file type.

class AssetDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.