Cloudflare API | Cloudforce One › Requests

Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided, a default will be assigned.

Security

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

Parameters

account_identifier: string

Identifier

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

success: true

Whether the API call was successful

result:

Item

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_IDENTIFIER/cloudforce-one/requests/new \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "content": "What regions were most effected by the recent DoS?",
      "priority": "routine",
      "request_type": "Victomology",
      "summary": "DoS attack"
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "content": "What regions were most effected by the recent DoS?",
    "created": "2022-04-01T05:20:00Z",
    "priority": "2022-04-01T05:20:00Z",
    "request": "Victomology",
    "summary": "DoS attack",
    "tlp": "clear",
    "updated": "2022-04-01T05:20:00Z",
    "completed": "2022-04-01T05:20:00Z",
    "message_tokens": 1,
    "readable_id": "RFI-2022-000001",
    "status": "open",
    "tokens": 16
  }
}

Delete A Request -> { errors, messages, success }

delete/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}

Delete a Request

Get A Request -> Envelope<

Item

get/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}

Get a Request

List Requests -> V4PagePaginationArray<

ListItem

post/accounts/{account_identifier}/cloudforce-one/requests

List Requests

Get Request Quota -> Envelope<

Quota

get/accounts/{account_identifier}/cloudforce-one/requests/quota

Get Request Quota

Get Request Types -> Envelope<

RequestTypes

get/accounts/{account_identifier}/cloudforce-one/requests/types

Get Request Types

Update A Request -> Envelope<

Item

put/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}

Updating a request alters the request in the Cloudforce One queue. This API may be used to update any attributes of the request after the initial submission. Only fields that you choose to update need to be add to the request body.

Domain types

Item = { id, content, created, 10 more... }

ListItem = { id, created, priority, 9 more... }

Quota = { anniversary_date, quarter_anniversary_date, quota, 1 more... }

RequestConstants = { priority, status, tlp }

RequestTypes = Array<string>

Cloudforce One Requests

Assets

cloudforce_one.requests.assets

Methods

List Request Assets -> Envelope<Array<{ id, name, created, 2 more... }>>

post/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset

List Request Assets

Delete A Request Asset -> { errors, messages, success }

delete/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset/{asset_identifer}

Delete a Request Asset

Get A Request Asset -> Envelope<Array<{ id, name, created, 2 more... }>>

get/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset/{asset_identifer}

Get a Request Asset

Update A Request Asset -> Envelope<{ id, name, created, 2 more... }>

put/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset/{asset_identifer}

Update a Request Asset

Cloudforce One Requests

Message

cloudforce_one.requests.message

Methods

Create A New Request Message -> Envelope<

Message

post/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/new

Create a New Request Message

Delete A Request Message -> { errors, messages, success }

delete/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/{message_identifer}

Delete a Request Message

List Request Messages -> Envelope<Array<

Message

post/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message

List Request Messages

Update A Request Message -> Envelope<

Message

put/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/{message_identifer}

Update a Request Message

Domain types

Message = { id, author, content, 3 more... }

Cloudforce One Requests

Priority

cloudforce_one.requests.priority

Methods

Create A New Priority Intelligence Requirement -> Envelope<

Priority

post/accounts/{account_identifier}/cloudforce-one/requests/priority/new

Create a New Priority Intelligence Requirement

Delete A Priority Intelligence Requirement -> { errors, messages, success }

delete/accounts/{account_identifier}/cloudforce-one/requests/priority/{priority_identifer}

Delete a Priority Intelligence Requirement

Get A Priority Intelligence Requirement -> Envelope<

Item

get/accounts/{account_identifier}/cloudforce-one/requests/priority/{priority_identifer}

Get a Priority Intelligence Requirement

Get Priority Intelligence Requirement Quota -> Envelope<

Quota

get/accounts/{account_identifier}/cloudforce-one/requests/priority/quota

Get Priority Intelligence Requirement Quota

Update A Priority Intelligence Requirement -> Envelope<

Item

put/accounts/{account_identifier}/cloudforce-one/requests/priority/{priority_identifer}

Update a Priority Intelligence Requirement

Domain types

Label = string

Priority = { id, created, labels, 4 more... }

PriorityEdit = { labels, priority, requirement, 1 more... }