– PanelAPI

Jb5: CreateAccount

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible values	Example
account	String	REQUIRED Username for the new Linux account.		`account=linuxUsername`

Example Call JETAPI

jetbackup5api -F Panel/CreateAccount -D "account={$USERNAME}"

success: 1
message: Account created successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Panel/CreateAccount&account={$USERNAME}

Jb5: ListTokens

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible values	Example
filter	String	Filter generated access tokens by description, IP, or username.		`filter=My Description` `filter=127.0.0.1` `filter=linuxUsername`

**Returns**
Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of access token items.	To view the parameters returned by this function, click on Token Object.
total	Integer	The total number of access token items.

Example Call JETAPI

jetbackup5api -F Panel/ListTokens -D "filter=example"

success: 1
message:
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  tokens:
    0:
      _id: 67a28e9bf5852b820503b792
      created: 2025-02-04T22:03:07+00:00
      last_access:
      last_access_ip:
      expiry: 0
      description: My Description 
      ip: 127.1.1.1
      username: example
    1:
      _id: 67a29072cf253c1c5207ee02
      created: 2025-02-04T22:10:58+00:00
      last_access:
      last_access_ip:
      expiry: 0
      description: My Description 2
      ip: 127.0.0.1
      username: example2
  total: 2

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Panel/ListTokens&filter=example

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

Jb5: GetToken

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Token ID.		`_id=5f890a19e55cf262863522f2`

Example Call JETAPI

jetbackup5api -F Panel/GetToken -D "_id={$TOKEN_ID}"

success: 1
message:
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  _id: 650a11a2b7a6c72020078ae2
  created: 2025-02-04T22:03:07+00:00
  last_access:
  last_access_ip:
  expiry:
  description: My Description
  ip: 127.1.1.1
  username: example

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Panel/GetToken&_id={$TOKEN_ID}

Jb5: ManageToken

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED on action modify. The ID of the Token.		`_id=5f890a19e55cf262863522f2`
action	String	REQUIRED The action you want to perform.	modify create	`action=create`
description	String	REQUIRED on action create. The description for the access token.		`description=My Description`
ip	Integer	The IP address that the token can be accessed from.		`ip=127.0.0.1`
username	String	The account name that the token can be accessed from. Can be root.		`username=linuxUsername`

Example Call JETAPI

jetbackup5api -F Panel/ManageToken -D "action=create&description={$DESCRIPTION}&ip={$IP}&username={$USERNAME}"

jetbackup5api -F Panel/ManageToken -D "&action=modify&_id={$TOKEN_ID}&description={$DESCRIPTION}&ip={$IP}&username={$USERNAME}"

success: 1
message: Access Token Created/Updated Successfully
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  _id: 650a11a2b7a6c72020078ae2
  created: 2023-09-19T21:24:50+00:00
  last_access:
  last_access_ip:
  expiry:
  description: My Description
  ip: 127.0.0.1
  username: {$USERNAME}
  token: gsDmPhATP5B52W6XkTCjXwHrNRxkL5ku

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Panel/ManageToken&action=create&description={$DESCRIPTION}&ip={$IP}&username={$USERNAME}

https://HOST_NAME:3035/?api=1&function=Panel/ManageToken&action=modify&_id={$TOKEN_ID}&description={$DESCRIPTION}&ip={$IP}&username={$USERNAME}

Jb5: DeleteToken

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Token ID. To find the Token ID, use the ListTokens function.		`_id=61d49d24857d996e6e4e5912`

Example Call JETAPI

jetbackup5api -F Panel/DeleteToken -D "_id={$TOKEN_ID}"

success: 1
message: Access Token Deleted Successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Panel/DeleteToken &_id={$TOKEN_ID}

Jb5: CreateUserSession

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible Values	Example
user	String	The user name to generate a login URL for. If not specified, then a login URL for the currently logged in user will be generated		`user=linuxUsername`

Example Call JETAPI

jetbackup5api -F Panel/CreateUserSession -D "user={$USERNAME}"

success: 1
message: User session created successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: RELEASE
  type: Linux
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  user: {$USERNAME}
  expires: 2025-02-04T21:48:32+00:00
  url: https://example.com:3035/?token=aY7gWozkxtFVtjiyVMtW9E7DIvBwuFhh-c22abd28dfd79ccd0dc7473881b6e182

Example Call HTTP

https://HOST_NAME:3035/?api=1&function=Panel/CreateUserSession&user={$USERNAME}