apis » npm.filesystem » 1.0
User filesystem API v1.0
Created Nov 12, 2024 at 09:56 PM

Resource: access_rights

Access rights associated to a file system resource.

http://{device}/api/npm.filesystem/1.0/access_rights/{+id}
  • JSON
    • {
  "effective": {
    "access_right": string,
    <prop>: any
  },
  "id": string,
  "owner": string,
  "public": {
    "access_right": string,
    <prop>: any
  },
  "shared": {
    "read_only": roles_obj,
    "read_write": roles_obj,
    <prop>: any
  }
}
    Property Name Type Description Notes
    access_rights <object> Access rights associated to a file system resource.
    access_rights.effective <object> Provides a summary of user's access to the object. This is a read-only type. Required properties: [access_right]; Optional;
    access_rights.effective.access_right <string> Access right type. Read-only; Values: NONE, READ_ONLY, READ_WRITE;
    access_rights.effective.<prop> <any> Optional;
    access_rights.id <string> Resource unique identifier. Optional;
    access_rights.owner <string> Owner of the object. Read-only; Optional;
    access_rights.public <object> Indicates if an object/resource is public. All public objects/resources are read_only. Required properties: [access_right]; Optional;
    access_rights.public.access_right <string> Access right type. Values: READ_ONLY;
    access_rights.public.<prop> <any> Optional;
    access_rights.shared <object> Property read_only - Specifies a list of roles that have read_only access to the resource/object. Property read_write - Specifies a list of roles that have read_write access to the resource/object. Optional;
    access_rights.shared.read_only <roles_obj> Collections of roles object.
    access_rights.shared.read_write <roles_obj> Collections of roles object.
    access_rights.shared.<prop> <any> Optional;

    access_rights: get

    GET http://{device}/api/npm.filesystem/1.0/access_rights/{+id}
    Response Body

    Returns an access_rights data object.

    access_rights: set

    PUT http://{device}/api/npm.filesystem/1.0/access_rights/{+id}
    Request Body

    Provide an access_rights data object.

    Response Body

    Returns an access_rights data object.

    Resource: checksum

    Status of a checksum computation on a trace file.

    http://{device}/api/npm.filesystem/1.0/checksum/{+id}
  • JSON
    • {
  "id": string,
  "method": string,
  "value": string
}
    Property Name Type Description Notes
    checksum <object> Status of a checksum computation on a trace file. Required properties: [id, value, method];
    checksum.id <string> Resource unique identifier.
    checksum.method <string> Checksum algorithm used. Values: SHA256;
    checksum.value <string> Trace file's checksum.

    checksum: create

    POST http://{device}/api/npm.filesystem/1.0/checksum/{+id}
    Request Body

    Do not provide a request body.

    Response Body

    Returns an async_task_status data object.

    checksum: delete

    DELETE http://{device}/api/npm.filesystem/1.0/checksum/{+id}
    Response Body

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

    checksum: get

    GET http://{device}/api/npm.filesystem/1.0/checksum/{+id}
    Response Body

    Returns a checksum data object.

    checksum: status

    Returns the status of the checksum computation task.

    GET http://{device}/api/npm.filesystem/1.0/checksum_status/{+id}
    Response Body

    Returns an async_task_status data object.

    Resource: file

    File or directory object.

    http://{device}/api/npm.filesystem/1.0/fs/{+id}
  • JSON
    • {
  "dir": file_system_dir,
  "file": virtualfile,
  "id": string,
  "type": string
}
    Property Name Type Description Notes
    file <object> File or directory object. Required properties: [id, type];
    file.dir <file_system_dir> Details about a directory.
    file.file <virtualfile> Details about a trace or virtual file.
    file.id <string> Unique path/name for the file/directory.
    file.type <string> Type discriminator for filesystem items. Values: FILE, DIRECTORY;

    file: copy

    Copies a file or a directory to the destination path.

    POST http://{device}/api/npm.filesystem/1.0/fileop/copy/{+id}
    Request Body

    Provide a request body with the following structure:

    Property Name Type Description Notes
    file.links.copy.request <object> Information required to copy a filesystem item. Required properties: [destination];
    file.links.copy.request.destination <string> Resource's destination id.
    Response Body

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

    file: create

    POST http://{device}/api/npm.filesystem/1.0/fs/{+id}
    Request Body

    Do not provide a request body.

    Response Body

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

    file: delete

    DELETE http://{device}/api/npm.filesystem/1.0/fs/{+id}
    Response Body

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

    file: download

    Downloads a file object.

    GET http://{device}/api/npm.filesystem/1.0/fileop/download/{+id}
    Response Body

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

    file: get

    GET http://{device}/api/npm.filesystem/1.0/fs/{+id}{?access,access_rights,owner}
    Response Body

    Returns a file data object.

    file: move

    Moves a file or a directory to the destination path.

    POST http://{device}/api/npm.filesystem/1.0/fileop/move/{+id}
    Request Body

    Provide a request body with the following structure:

    Property Name Type Description Notes
    file.links.move.request <object> Information required to move a filesystem item. Required properties: [destination];
    file.links.move.request.destination <string> Resource's destination id.
    Response Body

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

    Resource: filesystem

    Collection of directories on the device.

    http://{device}/api/npm.filesystem/1.0/fs
  • JSON
    • {
  "items": [ file_system_dir ]
}
    Property Name Type Description Notes
    filesystem <object> Collection of directories on the device.
    filesystem.items <array of <file_system_dir>> Array of directories. Optional;
    filesystem.items[items] <file_system_dir> Details about a directory.

    filesystem: get

    GET http://{device}/api/npm.filesystem/1.0/fs{?access,access_rights,owner}
    Response Body

    Returns a filesystem data object.

    Resource: index

    Status of a microflow index on a trace file.

    http://{device}/api/npm.filesystem/1.0/index/{+id}
  • JSON
    • {
  "error": async_error,
  "id": string,
  "size": integer,
  "stats": {
    "items": [
      {
        "end_time": string,
        "start_time": string,
        "version": string
      }
    ]
  },
  "status": string
}
    Property Name Type Description Notes
    index <object> Status of a microflow index on a trace file. Required properties: [id, status, stats];
    index.error <async_error> Asynchronous task error object.
    index.id <string> Index unique identifier.
    index.size <integer> Size of index on the OS file system. Optional;
    index.stats <object> Collection of microflow index statistics.
    index.stats.items <array of <object>> Array of microflow index statistics. Optional;
    index.stats.items[items] <object> Microflow index statistics. Required properties: [version, start_time, end_time];
    index.stats.items[items].end_time <string> End time for an indexed interval.
    index.stats.items[items].start_time <string> Start time for an indexed interval.
    index.stats.items[items].version <string> Microflow index version.
    index.status <string> Running state of an index. Values: DONE, RUNNING, STOPPED, ERROR;

    index: create

    POST http://{device}/api/npm.filesystem/1.0/index/{+id}
    Request Body

    Do not provide a request body.

    Response Body

    Returns an async_task_status data object.

    index: delete

    DELETE http://{device}/api/npm.filesystem/1.0/index/{+id}
    Response Body

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

    index: get

    GET http://{device}/api/npm.filesystem/1.0/index/{+id}
    Response Body

    Returns an index data object.

    index: status

    Returns the status of the indexing creation task.

    GET http://{device}/api/npm.filesystem/1.0/index_status/{+id}
    Response Body

    Returns an async_task_status data object.

    Resource: timeskew

    Status of a timeskew estimate on a multi-segment virtual file.

    http://{device}/api/npm.filesystem/1.0/timeskew/{+id}
  • JSON
    • {
  "id": string,
  "results": {
    "items": [ ts_linked_file ]
  }
}
    Property Name Type Description Notes
    timeskew <object> Status of a timeskew estimate on a multi-segment virtual file. Required properties: [id, results];
    timeskew.id <string> Resource unique identifier.
    timeskew.results <object> Collection of linked sources details.
    timeskew.results.items <array of <ts_linked_file>> Array of linked sources. Optional;
    timeskew.results.items[items] <ts_linked_file> Time skew information for linked source.

    timeskew: create

    POST http://{device}/api/npm.filesystem/1.0/timeskew/{+id}{?packet_count}
    Request Body

    Do not provide a request body.

    Response Body

    Returns an async_task_status data object.

    timeskew: delete

    DELETE http://{device}/api/npm.filesystem/1.0/timeskew/{+id}
    Response Body

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

    timeskew: get

    GET http://{device}/api/npm.filesystem/1.0/timeskew/{+id}
    Response Body

    Returns a timeskew data object.

    timeskew: status

    Returns the status of the timeskew estimate task.

    GET http://{device}/api/npm.filesystem/1.0/timeskew_status/{+id}
    Response Body

    Returns an async_task_status data object.

    Resource: virtualfile

    Details about a trace or virtual file.

    http://{device}/api/npm.filesystem/1.0/virtualfile/{+id}
  • JSON
    • {
  "access_rights": access_rights,
  "created": string,
  "format": string,
  "id": string,
  "index": index,
  "link_type": string,
  "linked_sources": file_system_linked_files,
  "modified": string,
  "size": integer,
  "type": string
}
    Property Name Type Description Notes
    virtualfile <object> Details about a trace or virtual file. Required properties: [type, id];
    virtualfile.access_rights <access_rights> Access rights associated to a file system resource.
    virtualfile.created <string> Creation time in Unix time format. Optional;
    virtualfile.format <string> File time format. Optional; Values: PCAP_US, PCAP_NS, PCAPNG_US, PCAPNG_NS, UNKNOWN;
    virtualfile.id <string> File unique identifier (path-like string).
    virtualfile.index <index> Status of a microflow index on a trace file.
    virtualfile.link_type <string> Link layer type. Optional; Values: NONE, EN10MB, JUNIPER_ETHER, RAW, IEEE802_11_RADIO, PPI, PPP_WITH_DIR, LINUX_SLL, C_HDLC, UNKNOWN;
    virtualfile.linked_sources <file_system_linked_files> Collection of linked sources associated to the virtual file.
    virtualfile.modified <string> Modification time in Unix time format. Optional;
    virtualfile.size <integer> File size in bytes. Optional;
    virtualfile.type <string> File type. Values: MULTISEGMENT_FILE, MERGED_FILE, PCAP_FILE, PCAPNG_FILE, ERF_FILE, UNKNOWN_FILE;

    virtualfile: create

    POST http://{device}/api/npm.filesystem/1.0/virtualfile/{+id}
    Request Body

    Provide a file_system_virtual_file_import data object.

    Response Body

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

    virtualfile: set

    PUT http://{device}/api/npm.filesystem/1.0/virtualfile/{+id}
    Request Body

    Provide a file_system_virtual_file_import data object.

    Response Body

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

    Type: async_error

    Asynchronous task error object.

  • JSON
    • {
  "error_id": string,
  "error_metrics": [
    {
      "key": string,
      "value": string
    }
  ],
  "error_text": string
}
    Property Name Type Description Notes
    async_error <object> Asynchronous task error object. Required properties: [error_id, error_text];
    async_error.error_id <string> Error code.
    async_error.error_metrics <array of <object>> Array of key/value error metrics, used for detailed error responses from async tasks. Optional;
    async_error.error_metrics[items] <object> Individual error key/value. Required properties: [key, value];
    async_error.error_metrics[items].key <string> Error metric ID.
    async_error.error_metrics[items].value <string> Error metric value.
    async_error.error_text <string> Error text.

    Type: async_task_status

    The status of an asynchronous task started via API calls.

  • JSON
    • {
  "elapsed_time": integer,
  "error": async_error,
  "message": string,
  "progress": integer,
  "resource_uri": string,
  "status": string,
  "uri": string
}
    Property Name Type Description Notes
    async_task_status <object> The status of an asynchronous task started via API calls. Required properties: [uri, progress];
    async_task_status.elapsed_time <integer> Duration of the task in microseconds. Optional;
    async_task_status.error <async_error> Asynchronous task error object.
    async_task_status.message <string> Message suitable for reporting completion status to a human user, returned only when <progress> returns 100. Optional;
    async_task_status.progress <integer> Integer percent completed indicator, which MUST return 100 *only* when the operation has been completed (either successfully or unsuccessfully). Range: 0 to 100;
    async_task_status.resource_uri <string> a URI upon which the client may perform GET operations to get the final representation of the resource that triggered the asynchronous job. Optional;
    async_task_status.status <string> Asynchronous task status code. Optional; Values: SUCCESS, FAILURE;
    async_task_status.uri <string> URI upon which the client may perform GET operations to poll for completion. Each accepted asynchronous operation will receive a unique status URI, so that multiple operations may be initiated and tracked at once.

    Type: file_system_dir

    Details about a directory.

  • JSON
    • {
  "created": string,
  "description": string,
  "dirs": filesystem,
  "files": {
    "items": file_system_files_list
  },
  "id": string,
  "modified": string
}
    Property Name Type Description Notes
    file_system_dir <object> Details about a directory. Required properties: [id, files, dirs];
    file_system_dir.created <string> Creation time in Unix time format. Optional;
    file_system_dir.description <string> Directory description used as an alias name. Optional;
    file_system_dir.dirs <filesystem> Collection of directories on the device.
    file_system_dir.files <object> Collection of trace and virtual files on the device.
    file_system_dir.files.items <file_system_files_list> Array of trace and virtual files.
    file_system_dir.id <string> Directory unique identifier.
    file_system_dir.modified <string> Modification time in Unix time format. Optional;

    Type: file_system_files_list

    Array of trace and virtual files.

  • JSON
    • Property Name Type Description Notes
    file_system_files_list <array of <virtualfile>> Array of trace and virtual files.
    file_system_files_list[items] <virtualfile> Details about a trace or virtual file.

    Type: file_system_linked_file

    Details about a linked source.

  • JSON
    • {
  "default_source": boolean,
  "description": string,
  "path": string,
  "timeskew": integer
}
    Property Name Type Description Notes
    file_system_linked_file <object> Details about a linked source. Required properties: [path];
    file_system_linked_file.default_source <boolean> The default source is the reference source in a multisegment file collection and it is used as reference for the time skew calculation. Optional;
    file_system_linked_file.description <string> A simple description field associated with the linked source. Optional;
    file_system_linked_file.path <string> Linked source path. It could be either an absolute path (fs/ID) or a relative path starting from the aggregated file folder.
    file_system_linked_file.timeskew <integer> It is the packets timestamps offset associated with the linked source. Optional;

    Type: file_system_linked_files

    Collection of linked sources associated to the virtual file.

  • JSON
    • {
  "items": [ file_system_linked_file ]
}
    Property Name Type Description Notes
    file_system_linked_files <object> Collection of linked sources associated to the virtual file.
    file_system_linked_files.items <array of <file_system_linked_file>> Array of linked sources. Optional;
    file_system_linked_files.items[items] <file_system_linked_file> Details about a linked source.

    Type: file_system_virtual_file_import

    Info about a new multisegment or merged file.

  • JSON
    • {
  "linked_sources": file_system_linked_files,
  "type": string
}
    Property Name Type Description Notes
    file_system_virtual_file_import <object> Info about a new multisegment or merged file. Required properties: [type, linked_sources];
    file_system_virtual_file_import.
    linked_sources    		 <file_system_linked_files> Collection of linked sources associated to the virtual file.
    file_system_virtual_file_import.type <string> Linked file type. Values: MULTISEGMENT_FILE, MERGED_FILE;

    Type: roles_obj

    Collections of roles object.

  • JSON
    • {
  "roles": [
    integer
  ],
  <prop>: any
}
    Property Name Type Description Notes
    roles_obj <object> Collections of roles object. Required properties: [roles];
    roles_obj.roles <array of <integer>> Array of roles.
    roles_obj.roles[items] <integer> Role value.
    roles_obj.<prop> <any> Optional;

    Type: ts_linked_file

    Time skew information for linked source.

  • JSON
    • {
  "path": string,
  "timeskew": integer
}
    Property Name Type Description Notes
    ts_linked_file <object> Time skew information for linked source. Required properties: [path, timeskew];
    ts_linked_file.path <string> Path of the linked source.
    ts_linked_file.timeskew <integer> Estimated time skew compared to the default source.