List Requests

client.CloudforceOne.Requests.List(ctx, params) (*SinglePage[ListItem], error)

POST/accounts/{account_id}/cloudforce-one/requests

List Requests

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

Accepted Permissions (at least one required)

Cloudforce One Write

ParametersExpand Collapse

params RequestListParams

AccountID param.Field[string]

Path param: Identifier.

maxLength32

Page param.Field[int64]

Body param: Page number of results.

PerPage param.Field[int64]

Body param: Number of results per page.

CompletedAfter param.Field[Time]optional

Body param: Retrieve requests completed after this time.

formatdate-time

CompletedBefore param.Field[Time]optional

Body param: Retrieve requests completed before this time.

formatdate-time

CreatedAfter param.Field[Time]optional

Body param: Retrieve requests created after this time.

formatdate-time

CreatedBefore param.Field[Time]optional

Body param: Retrieve requests created before this time.

formatdate-time

RequestType param.Field[string]optional

Body param: Requested information from request.

SortBy param.Field[string]optional

Body param: Field to sort results by.

SortOrder param.Field[RequestListParamsSortOrder]optional

Body param: Sort order (asc or desc).

const RequestListParamsSortOrderAsc RequestListParamsSortOrder = "asc"

const RequestListParamsSortOrderDesc RequestListParamsSortOrder = "desc"

Status param.Field[RequestListParamsStatus]optional

Body param: Request Status.

const RequestListParamsStatusOpen RequestListParamsStatus = "open"

const RequestListParamsStatusAccepted RequestListParamsStatus = "accepted"

const RequestListParamsStatusReported RequestListParamsStatus = "reported"

const RequestListParamsStatusApproved RequestListParamsStatus = "approved"

const RequestListParamsStatusCompleted RequestListParamsStatus = "completed"

const RequestListParamsStatusDeclined RequestListParamsStatus = "declined"

ReturnsExpand Collapse

type ListItem struct{…}

ID string

UUID.

maxLength36

Created Time

Request creation time.

formatdate-time

Priority ListItemPriority

One of the following:

const ListItemPriorityRoutine ListItemPriority = "routine"

const ListItemPriorityHigh ListItemPriority = "high"

const ListItemPriorityUrgent ListItemPriority = "urgent"

Request string

Requested information from request.

Summary string

Brief description of the request.

TLP ListItemTLP

The CISA defined Traffic Light Protocol (TLP).

One of the following:

const ListItemTLPClear ListItemTLP = "clear"

const ListItemTLPAmber ListItemTLP = "amber"

const ListItemTLPAmberStrict ListItemTLP = "amber-strict"

const ListItemTLPGreen ListItemTLP = "green"

const ListItemTLPRed ListItemTLP = "red"

Updated Time

Request last updated time.

formatdate-time

Completed Timeoptional

Request completion time.

formatdate-time

MessageTokens int64optional

Tokens for the request messages.

ReadableID stringoptional

Readable Request ID.

Status ListItemStatusoptional

Request Status.

One of the following:

const ListItemStatusOpen ListItemStatus = "open"

const ListItemStatusAccepted ListItemStatus = "accepted"

const ListItemStatusReported ListItemStatus = "reported"

const ListItemStatusApproved ListItemStatus = "approved"

const ListItemStatusCompleted ListItemStatus = "completed"

const ListItemStatusDeclined ListItemStatus = "declined"

Tokens int64optional

Tokens for the request.

List Requests

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/cloudforce_one"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  page, err := client.CloudforceOne.Requests.List(context.TODO(), cloudforce_one.RequestListParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    Page: cloudflare.F(int64(0)),
    PerPage: cloudflare.F(int64(10)),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "created": "2022-04-01T00:00:00Z",
      "priority": "routine",
      "request": "Victomology",
      "summary": "DoS attack",
      "tlp": "clear",
      "updated": "2022-04-01T00:00:00Z",
      "completed": "2024-01-01T00:00:00Z",
      "message_tokens": 16,
      "readable_id": "RFI-2022-000001",
      "status": "open",
      "tokens": 0
    }
  ]
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "created": "2022-04-01T00:00:00Z",
      "priority": "routine",
      "request": "Victomology",
      "summary": "DoS attack",
      "tlp": "clear",
      "updated": "2022-04-01T00:00:00Z",
      "completed": "2024-01-01T00:00:00Z",
      "message_tokens": 16,
      "readable_id": "RFI-2022-000001",
      "status": "open",
      "tokens": 0
    }
  ]
}