Skip to content

Scroll

Medium Risk

Some operations on this resource may modify or delete data.

The response for audit log query contain no more than 500 messages. One can use scroll request to scroll through more than 500 messages or all messages in multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).

Tools

Tool Description
f5xc-api-blindfold-scroll-create Audit Log Scroll Query.
f5xc-api-blindfold-scroll-list Audit Log Scroll Query.

Parameters

Path Parameters

Parameter Description Example
namespace Namespace -

Query Parameters

Parameter Description Example
scroll_id Long Base-64 encoded string which can be used to retrieve next batch of log messages. -

Side Effects

Operations on this resource may have the following effects:

Creates:

  • scroll

Example Usage

Ask Claude to help you work with Scroll resources:

Create Scroll

"Create a scroll named 'example' in the 'production' namespace"

List Scrolls

"List all scrolls in the 'production' namespace"

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/scrolls" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/scrolls/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/scrolls" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @scroll.json

# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/scrolls/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"