Delete Active Passage (v2.0)

DELETE 
/v2.0/api/tenants/:tenant_id/elements/:element_id/toolkitsessions/:session_id

Delete Active Passage

Request

Path Parameters

tenant_id stringrequired

Tenant Id

element_id stringrequired

Element Id

session_id stringrequired

Session Id

Responses

202

Accepted

application/json

Schema

Schema

cols integer

The col value.

debug_host_ip string

The debug host IP address.

debug_host_service_port int32

The debug host service port.

debug_host_sshd_port int32

The debug host SSh port.

element_id string

The element ID.

expiry_time int64

The expiry time.

id string

Id

instance_id stringrequired

The instance ID.

rows integer

The row value.

serial_no string

The serial number.

session_id stringrequired

The session ID.

tenant_id stringrequired

Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)

time_left int64

The time left value.

tunnel_pub_key string

The tunnel pub key.

user_name stringrequired

The mandatory user name.

Example (from schema)

{
  "cols": 0,
  "debug_host_ip": "string",
  "debug_host_service_port": 0,
  "debug_host_sshd_port": 0,
  "element_id": "string",
  "expiry_time": 0,
  "id": "string",
  "instance_id": "string",
  "rows": 0,
  "serial_no": "string",
  "session_id": "string",
  "tenant_id": "string",
  "time_left": 0,
  "tunnel_pub_key": "string",
  "user_name": "string"
}

404

Element/session Not Found

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Loading...