ATB

POST

/api/shape/bot/namespaces/{namespace}/reporting/atb

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/bot/namespaces/example/reporting/atb \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "daily": { "report_generation_time": "example" }, "enable": true, "monthly": { "date": "DATE_NONE", "report_generation_time": "example" }, "namespace": "example", "resource_id": "example", "virtual_host": "example", "weekly": { "day": "WEEKDAY_NONE", "report_generation_time": "example" } }'

• F5 Distributed Cloud Console

Enable/disable ATB.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace

x-required namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.

Request Body^required

Media typeapplication/json

ATBRequest

Request for ATB.

object

daily

object

report_generation_time

report generation time

Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set. Required: YES.

string

<= 1024 characters

enable

Enable

Enable ATB or not.

boolean format: boolean

monthly

object

date

string

default: DATE_NONE

Allowed values: DATE_NONE DATE_ONE DATE_TWO DATE_THREE DATE_FOUR DATE_FIVE DATE_SIX DATE_SEVEN DATE_EIGHT DATE_NINE DATE_TEN DATE_ELEVEN DATE_TWELVE DATE_THIRTEEN DATE_FOURTEEN DATE_FIFTEEN DATE_SIXTEEN DATE_SEVENTEEN DATE_EIGHTEEN DATE_NINETEEN DATE_TWENTY DATE_TWENTYONE DATE_TWENTYTWO DATE_TWENTYTHREE DATE_TWENTYFOUR DATE_TWENTYFIVE DATE_TWENTYSIX DATE_TWENTYSEVEN DATE_TWENTYEIGHT DATE_LAST

report_generation_time

time report is generated

Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set. Required: YES.

string

<= 1024 characters

namespace

Namespace

Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered. Required: YES.

string

>= 6 characters <= 1024 characters

resource_id

Resource ID

Resource ID of ATB report configuration object.

string

<= 1024 characters

virtual_host

Virtual Host Name

Name of Virtual Host to scope traffic overview query Required: YES.

string

<= 1024 characters

weekly

object

day

string

default: WEEKDAY_NONE

Allowed values: WEEKDAY_NONE WEEKDAY_MONDAY WEEKDAY_TUESDAY WEEKDAY_WEDNESDAY WEEKDAY_THURSDAY WEEKDAY_FRIDAY WEEKDAY_SATURDAY WEEKDAY_SUNDAY

report_generation_time

report generation time

Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set. Required: YES.

string

<= 1024 characters

Responses

200

A successful response.

Media typeapplication/json

ATBResponse

Response for ATB.

object

enable

Enable

Enable ATB or not.

boolean format: boolean

Example^generated

{
  "enable": true
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example