Clips API v1.0

Resource: clip

Configuration, status and statistics of a clip.

http://{device}/api/npm.clips/1.0/clips/items/{+id}

JSON

{
  "config": {
    "description": string,
    "end_time": string,
    "filters": {
      "items": filters_list
    },
    "job_id": string,
    "start_time": string
  },
  "id": string,
  "index_stats": {
    "items": [
      {
        "end_time": string,
        "start_time": string,
        "version": string
      }
    ]
  },
  "status": {
    "creation_time": string,
    "estimated_size": integer,
    "locked": boolean,
    "modification_time": string,
    "packets_dropped": integer,
    "packets_written": integer
  }
}

{
  "config": {
    "description": string,
    "end_time": string,
    "filters": {
      "items": filters_list
    },
    "job_id": string,
    "start_time": string
  },
  "id": string,
  "index_stats": {
    "items": [
      {
        "end_time": string,
        "start_time": string,
        "version": string
      }
    ]
  },
  "status": {
    "creation_time": string,
    "estimated_size": integer,
    "locked": boolean,
    "modification_time": string,
    "packets_dropped": integer,
    "packets_written": integer
  }
}

Property Name	Type	Description	Notes
clip	<object>	Configuration, status and statistics of a clip.
clip.config	<object>	Configuration of a clip.	Optional;
clip.config.description	<string>	Description of this clip configuration.	Optional;
clip.config.end_time	<string>	Clip end time.	Optional;
clip.config.filters	<object>	Collection of filter criteria.	Optional;
clip.config.filters.items	<filters_list>	Array of filter criteria.
clip.config.job_id	<string>	Job UUID on which the clip is applied.	Optional;
clip.config.start_time	<string>	Clip start time.	Optional;
clip.id	<string>	Clip unique identifier.	Read-only; Optional;
clip.index_stats	<object>	Collection of microflow index statistics.	Optional;
clip.index_stats.items	<array of <object>>	Array of microflow index statistics.	Optional;
clip.index_stats.items[items]	<object>	Microflow index statistics.	Required properties: [version, start_time, end_time];
clip.index_stats.items[items].end_time	<string>	End time for an indexed interval.
clip.index_stats.items[items].start_time	<string>	Start time for an indexed interval.
clip.index_stats.items[items].version	<string>	Microflow index version.
clip.status	<object>	Status of a clip.	Optional;
clip.status.creation_time	<string>	Clip creation time.	Read-only; Optional;
clip.status.estimated_size	<integer>	Estimated size for this clip in packet storage.	Read-only; Optional;
clip.status.locked	<boolean>	'true' if packets and the index for this clip are locked, 'false' otherwise.	Optional;
clip.status.modification_time	<string>	Clip last modified time.	Read-only; Optional;
clip.status.packets_dropped	<integer>	Statistics for the number of packets that arrived at the capture port but could not be written successfully to the packet storage for this clip.	Read-only; Optional;
clip.status.packets_written	<integer>	Statistics for the number of packets successfully written to the packet storage for this clip.	Read-only; Optional;

Links

clip: delete

DELETE http://{device}/api/npm.clips/1.0/clips/items/{+id}

Response Body

On success, the server does not provide any body in the responses.

clip: get

GET http://{device}/api/npm.clips/1.0/clips/items/{+id}

Response Body

Returns a clip data object.

clip: set

PUT http://{device}/api/npm.clips/1.0/clips/items/{+id}

Request Body

Provide a clip data object.

Response Body

Returns a clip data object.

Resource: clips

Collection of clips on the device.

http://{device}/api/npm.clips/1.0/clips

JSON

{
  "items": [ clip ]
}

{
  "items": [ clip ]
}

Property Name	Type	Description	Notes
clips	<object>	Collection of clips on the device.
clips.items	<array of <clip>>	Array of clips.	Optional;
clips.items[items]	<clip>	Configuration, status and statistics of a clip.

Links

clips: create

POST http://{device}/api/npm.clips/1.0/clips

Request Body

Provide a clip data object.

Response Body

Returns a clip data object.

clips: get

GET http://{device}/api/npm.clips/1.0/clips

Response Body

Returns a clips data object.

Type: filters_list

Array of filter criteria.

JSON

[
  {
    "context": string,
    "id": string,
    "type": string,
    "value": string
  }
]

[
  {
    "context": string,
    "id": string,
    "type": string,
    "value": string
  }
]

Property Name	Type	Description	Notes
filters_list	<array of <object>>	Array of filter criteria.
filters_list[items]	<object>	Filter configuration.	Required properties: [id, type, value];
filters_list[items].context	<string>	Context from which the filter was applied (e.g., user request, data drill-down, etc).	Optional; Values: NONE, INTERNAL, USER, DRILL_DOWN;
filters_list[items].id	<string>	Filter criterion ID.
filters_list[items].type	<string>	The type of filter used on the data.	Values: BPF, STEELFILTER, WIRESHARK;
filters_list[items].value	<string>	Query filter text to use.