Edit event detail.

PUT

/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/detail/{event_detail_id}

curl --request PUT \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/infraprotect/namespaces/example/infraprotect/event/example/detail/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "attachments": [ { "attachment_id": "example", "attachment_type": "ATTACHMENT_TYPE_UNKNOWN", "end_time": "2026-04-15T12:00:00Z", "gos_name": "example", "gos_version": "example", "name": "example", "size_bytes": "example", "start_time": "2026-04-15T12:00:00Z" } ], "description": "example", "event_detail_id": "example", "event_id": "example", "namespace": "example", "time": "2026-04-15T12:00:00Z", "title": "example" }'

• F5 Distributed Cloud Console

Allows editing of an event detail, setting its title, description and date.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace This request is supported only in system namespace.

event_id

required

string

Event ID Event ID we want to edit the event detail for.

event_detail_id

required

string

Event Detail ID Event detail ID we want to update.

Request Body^required

Media typeapplication/json

Request to update event detail

Request to update a single event detail.

object

attachments

Attachments

All attachments on an event details, missing will be removed, extras will be added.

Array<object>

Event attachment

Event attachment record (pcap, or any arbitrary file)

object

attachment_id

Attachment ID

ID of the attachment.

string

<= 1024 characters

attachment_type

string

default: ATTACHMENT_TYPE_UNKNOWN

Allowed values: ATTACHMENT_TYPE_UNKNOWN ATTACHMENT_TYPE_PCAP ATTACHMENT_TYPE_BINARY ATTACHMENT_TYPE_INVALID_PCAP ATTACHMENT_TYPE_OTHER

end_time

End time

End time as an RFC3339 string.

string format: date-time

<= 1024 characters

gos_name

GOS name

Generic object storage name of the attachment.

string

<= 1024 characters

gos_version

GOS version

Generic object storage version of the attachment.

string

<= 1024 characters

name

Name

Name of the attachment.

string

>= 6 characters <= 1024 characters

size_bytes

Size

Size of the attachment.

string format: int64

<= 1024 characters

start_time

Start time

Start time as an RFC3339 string.

string format: date-time

<= 1024 characters

description

Description

Description of the event detail.

string

>= 21 characters <= 1024 characters

event_detail_id

Event Detail ID

Event detail ID we want to update.

string

<= 1024 characters

event_id

Event ID

Event ID we want to edit the event detail for.

string

<= 1024 characters

namespace

Namespace

This request is supported only in system namespace.

string

>= 6 characters <= 1024 characters

time

Time

Time of the event detail Format: RFC3339.

string format: date-time

<= 1024 characters

title

Title

Title of the event of the event detail.

string

>= 6 characters <= 1024 characters

Responses

200

A successful response.

Media typeapplication/json

Event detail as stored

Event detail as stored in the backend.

object

detail

object

attachments

Attachments

All attachments on an event details.

Array<object>

Event attachment

Event attachment record (pcap, or any arbitrary file)

object

attachment_id

Attachment ID

ID of the attachment.

string

<= 1024 characters

attachment_type

string

default: ATTACHMENT_TYPE_UNKNOWN

Allowed values: ATTACHMENT_TYPE_UNKNOWN ATTACHMENT_TYPE_PCAP ATTACHMENT_TYPE_BINARY ATTACHMENT_TYPE_INVALID_PCAP ATTACHMENT_TYPE_OTHER

end_time

End time

End time as an RFC3339 string.

string format: date-time

<= 1024 characters

gos_name

GOS name

Generic object storage name of the attachment.

string

<= 1024 characters

gos_version

GOS version

Generic object storage version of the attachment.

string

<= 1024 characters

name

Name

Name of the attachment.

string

>= 6 characters <= 1024 characters

size_bytes

Size

Size of the attachment.

string format: int64

<= 1024 characters

start_time

Start time

Start time as an RFC3339 string.

string format: date-time

<= 1024 characters

creator

Creator

Creator of the event detail.

string

<= 1024 characters

description

Description

Textual description of the event detail record.

string

>= 21 characters <= 1024 characters

id

Id

ID of the event detail used to uniquely identify it.

string

>= 1 <= 4094 <= 1024 characters

time

Time

Time the event details applies to. Details can be added retrospectively this fields allow pin point to detail to a specific time. The value must fall within the event time range.

string format: date-time

<= 1024 characters

title

Title

Title of the event detail.

string

>= 6 characters <= 1024 characters

Example

{
  "detail": {
    "attachments": [
      {
        "attachment_type": "ATTACHMENT_TYPE_UNKNOWN"
      }
    ]
  }
}

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