Endpoint

/v1/smb/sessions/close

POST

The request body must contain a list of sessions to close, as returned from GET /v1/smb/sessions.

Parameters

This resource has no parameters.

Request

Schema

{
  "type": "array",
  "items": {
    "description": "api_smb_session_info",
    "type": "object",
    "properties": {
      "location": {
        "description": "location",
        "type": "string"
      },
      "tenant_id": {
        "description": "tenant_id",
        "type": "number"
      },
      "originator": {
        "description": "originator",
        "type": "string"
      },
      "server_address": {
        "description": "server_address",
        "type": "string"
      },
      "user": {
        "description": "user",
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "enum": [
              "LOCAL",
              "API_NULL_DOMAIN",
              "WORLD",
              "POSIX_USER",
              "POSIX_GROUP",
              "ACTIVE_DIRECTORY",
              "API_INVALID_DOMAIN",
              "API_RESERVED_DOMAIN",
              "API_INTERNAL_DOMAIN",
              "API_OPERATOR_DOMAIN",
              "API_CREATOR_DOMAIN"
            ],
            "description": "domain:\n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY,\n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN,\n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN,\n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN,\n * `API_NULL_DOMAIN` - API_NULL_DOMAIN,\n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN,\n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN,\n * `LOCAL` - LOCAL,\n * `POSIX_GROUP` - POSIX_GROUP,\n * `POSIX_USER` - POSIX_USER,\n * `WORLD` - WORLD"
          },
          "auth_id": {
            "description": "auth_id",
            "type": "string"
          },
          "uid": {
            "description": "uid",
            "type": "number"
          },
          "gid": {
            "description": "gid",
            "type": "number"
          },
          "sid": {
            "description": "sid",
            "type": "string"
          },
          "name": {
            "description": "name",
            "type": "string"
          }
        }
      },
      "num_opens": {
        "description": "num_opens",
        "type": "number"
      },
      "time_open": {
        "description": "time_open",
        "type": "object",
        "properties": {
          "nanoseconds": {
            "description": "nanoseconds",
            "type": "string"
          }
        }
      },
      "time_idle": {
        "description": "time_idle",
        "type": "object",
        "properties": {
          "nanoseconds": {
            "description": "nanoseconds",
            "type": "string"
          }
        }
      },
      "is_guest": {
        "description": "is_guest",
        "type": "boolean"
      },
      "is_encrypted": {
        "description": "is_encrypted",
        "type": "boolean"
      },
      "share_names": {
        "type": "array",
        "items": {
          "description": "share_names",
          "type": "string"
        }
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "type": "array",
  "items": {
    "description": "api_smb2_session_close_result",
    "type": "object",
    "properties": {
      "error_message": {
        "description": "error_message",
        "type": "string"
      }
    }
  }
}