Staged Signatures.

POST

/api/ml/data/namespaces/{namespace}/virtual_hosts/{vh_name}/staged_signatures

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/ml/data/namespaces/example/virtual_hosts/example/staged_signatures \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "end_time": "example", "namespace": "example", "start_time": "example", "vh_name": "example" }'

• F5 Distributed Cloud Console

API to GET Staged Signatures.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Fetch staged signatures for the given namespace.

vh_name

required

string

Vh_name Virtual Host for current request.

Request Body^required

Media typeapplication/json

StagedSignaturesReq

Request to GET the list of all staged signatures.

object

end_time

end_time

Fetch staged signatures whose timestamp <= end_time format: unix_timestamp|RFC 3339.

string

<= 1024 characters

namespace

namespace

Fetch staged signatures for the given namespace.

string

>= 6 characters <= 1024 characters

start_time

start_time

Fetch staged signatures whose timestamp >= start_time format: unix_timestamp|RFC 3339.

string

<= 1024 characters

vh_name

vh_name

Virtual Host for current request.

string

<= 1024 characters

Example^generated

{
  "end_time": "example",
  "namespace": "example",
  "start_time": "example",
  "vh_name": "example"
}

Responses

200

A successful response.

Media typeapplication/json

StagedSignaturesRsp

Response to GET the list of all staged signatures.

object

staged_signatures

staged_signatures

List of staged signatures.

Array<object>

StagedSignature

Staged signature details.

object

accuracy

accuracy

Detected signature accuracy.

string

<= 1024 characters

attack_type

attack_type

The Signature Attack Type.

string

<= 1024 characters

context

context

Context of the signature detected.

string

<= 1024 characters

count

count

Number of times signature detected in traffic.

integer format: int32

id

id

Detected signature ID.

string

>= 1 <= 4094 <= 1024 characters

id_name

id_name

Signature ID name.

string

<= 1024 characters

matching_info

matching_info

Request details for the matched signature.

string

<= 1024 characters

name

name

Detected signature name.

string

>= 6 characters <= 1024 characters

state

state

State of the signature.

string

<= 1024 characters

Example^generated

{
  "staged_signatures": [
    {
      "accuracy": "example",
      "attack_type": "example",
      "context": "example",
      "count": 1,
      "id": "example",
      "id_name": "example",
      "matching_info": "example",
      "name": "example",
      "state": "example"
    }
  ]
}

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