Users

Collect User metrics

get
/clients/v1/dashboard/collect-metrics

Collects metrics for the authenticated client.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Metrics collected successfully.

No content
get
/clients/v1/dashboard/collect-metrics
GET /clients/v1/dashboard/collect-metrics HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Create directory

post
/clients/v1/directories

Creates a new directory in the specified parent directory. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
directory_idstringOptional

The parent directory ID where the new directory will be created. If not provided, the new directory will be created in the root directory.

Example: 682aa5a96ef58914bf648be7
namestringRequired

The name of the new directory.

Example: Documents
allow_duplicate_with_suffixbooleanOptional

If true, allows creating directories with duplicate names by adding a suffix. Defaults to false.

Example: true
Responses
post
/clients/v1/directories
POST /clients/v1/directories HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "directory_id": "682aa5a96ef58914bf648be7",
  "name": "Documents"
}
No content

Read directory

get
/clients/v1/directories/{directory_id}

Retrieves details of a specific directory by its ID. Requires authentication.

Path parameters
directory_idstringRequired

The ID of the directory to retrieve. Pass 'root' to retrieve the root directory.

Example: 682aa5a96ef58914bf648be7
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Directory details retrieved successfully.

No content
get
/clients/v1/directories/{directory_id}
GET /clients/v1/directories/{directory_id} HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Update directory

put
/clients/v1/directories/{directory_id}

Updates the name or parent directory of a specified directory. Requires authentication.

Path parameters
directory_idstringRequired

The ID of the directory to update.

Example: 682b503c77f3a1ad221e2557
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
directory_idstringOptional

The target directory ID to move this directory to.

Example: 682aa5a96ef58914bf648be7
namestringOptional

The new name for the directory.

Example: Documents
Responses
200

Directory updated successfully. Returns the updated directory details.

No content
put
/clients/v1/directories/{directory_id}
PUT /clients/v1/directories/{directory_id} HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "directory_id": "682aa5a96ef58914bf648be7",
  "name": "Documents"
}
No content

Delete directory

delete
/clients/v1/directories/{directory_id}

Deletes a directory by its ID. Requires authentication.

Path parameters
directory_idstringRequired

The ID of the directory to delete.

Example: 682b503c77f3a1ad221e2557
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
delete
/clients/v1/directories/{directory_id}
DELETE /clients/v1/directories/{directory_id} HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Delete multiple directories

delete
/clients/v1/directories/delete

Deletes multiple directories by their IDs. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_0RA3jR4NthjbME6MVg7r4EQ0DXlepaIj
Client-SecretstringRequiredExample: sk_ZfKAFeZ6pGb2YJ5Hq1smRLyjGUeo0V81
Body
directory_idsstring[]Optional

List of directory IDs to delete.

Example: ["688344475123816c01c8529"]
Responses
200

Directories deleted successfully. Returns a success message with details.

No content
delete
/clients/v1/directories/delete
DELETE /clients/v1/directories/delete HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "directory_ids": [
    "688344475123816c01c8529"
  ]
}
No content

Move multiple directories files

post
/clients/v1/directories/move

Moves multiple directories to a specified directory. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
target_directory_idstringRequired

The ID of the target directory to move the directories to.

Example: 688093f98283cbe0f596faa0
directory_idsstring[]Required

List of directory IDs to move.

Example: ["6880a6d940f95c4b1b6e08c3","6880a6bc40f95c4b1b6e08c2"]
Responses
200

Directories moved successfully. Returns the updated file details.

No content
post
/clients/v1/directories/move
POST /clients/v1/directories/move HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "target_directory_id": "688093f98283cbe0f596faa0",
  "directory_ids": [
    "6880a6d940f95c4b1b6e08c3",
    "6880a6bc40f95c4b1b6e08c2"
  ]
}
No content

Upload file

post
/clients/v1/files

Uploads a new file to the specified directory. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
filestring · binaryRequired
directory_idstringOptional

The ID of the directory to upload the file to. If not provided, the file will be uploaded to the root directory.

Example: 682aa5a96ef58914bf648be7
passphrasestringOptional

If provided, the file upload will be encrypted with this passphrase. Must be at least 8 characters long, include 1 uppercase letter, 1 number, and 1 special character (!@#$%^&*()_+). Encrypted files are limited to 50MB.

Example: Passphrase123!
replace_existingbooleanOptional

If true, replaces existing files with the same name. Defaults to false.

Example: true
Responses
post
/clients/v1/files
POST /clients/v1/files HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 113

{
  "file": "binary",
  "directory_id": "682aa5a96ef58914bf648be7",
  "passphrase": "Passphrase123!",
  "replace_existing": true
}
No content

Download file

get
/clients/v1/files/{file_id}/download

Downloads a file by its ID. Requires authentication. For encrypted files, use stream=false and provide the Passphrase header.

Path parameters
file_idstringRequired

The ID of the file to download.

Example: 682c304bbf71b6b7ac80dc97
Query parameters
streambooleanOptional

Set to false to download encrypted files. Defaults to true for streaming.

Example: false
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
PassphrasestringOptional

Passphrase to decrypt the file if it was uploaded with encryption.

Example: Password123!
Responses
200

File downloaded successfully. Returns the downloaded file.

No content
get
/clients/v1/files/{file_id}/download
GET /clients/v1/files/{file_id}/download HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Read file

get
/clients/v1/files/{file_id}

Retrieves details of a specific file by its ID. Requires authentication.

Path parameters
file_idstringRequired

The ID of the file to retrieve.

Example: 682c304bbf71b6b7ac80dc97
Query parameters
include_chunksbooleanOptional

Set to true to include the IPFS chunks in the response. Defaults to false if not provided.

Default: false
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

File details retrieved successfully.

No content
get
/clients/v1/files/{file_id}
GET /clients/v1/files/{file_id} HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Update file

put
/clients/v1/files/{file_id}

Updates the name or parent directory of a specified file. Requires authentication.

Path parameters
file_idstringRequired

The ID of the file to update.

Example: 682c304bbf71b6b7ac80dc97
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
directory_idstringOptional

The target directory ID to move this file to.

Example: 682c86bec39bd0d59b3d6567
namestringOptional

The new name for the file.

Example: Profile.jpg
Responses
200

File updated successfully. Returns the updated file details.

No content
put
/clients/v1/files/{file_id}
PUT /clients/v1/files/{file_id} HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "directory_id": "682c86bec39bd0d59b3d6567",
  "name": "Profile.jpg"
}
No content

Delete file

delete
/clients/v1/files/{file_id}

Deletes a file by its ID. Requires authentication.

Path parameters
file_idstringRequired

The ID of the file to delete.

Example: 682c304bbf71b6b7ac80dc97
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
delete
/clients/v1/files/{file_id}
DELETE /clients/v1/files/{file_id} HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Delete multiple files

delete
/clients/v1/files/delete

Deletes multiple files by their IDs. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_0RA3jR4NthjbME6MVg7r4EQ0DXlepaIj
Client-SecretstringRequiredExample: sk_ZfKAFeZ6pGb2YJ5Hq1smRLyjGUeo0V81
Body
file_idsstring[]Optional

List of file IDs to delete.

Example: ["688344475123816c01c8529"]
Responses
200

Files deleted successfully. Returns a success message with details.

No content
delete
/clients/v1/files/delete
DELETE /clients/v1/files/delete HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "file_ids": [
    "688344475123816c01c8529"
  ]
}
No content

Move multiple files

post
/clients/v1/files/move

Moves multiple files to a specified directory. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
directory_idstringRequired

The ID of the target directory to move the files to.

Example: 688093f98283cbe0f596faa0
file_idsstring[]Required

List of file IDs to move.

Example: ["6880a6d940f95c4b1b6e08c3","6880a6bc40f95c4b1b6e08c2"]
Responses
200

Files moved successfully. Returns the updated file details.

No content
post
/clients/v1/files/move
POST /clients/v1/files/move HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "directory_id": "688093f98283cbe0f596faa0",
  "file_ids": [
    "6880a6d940f95c4b1b6e08c3",
    "6880a6bc40f95c4b1b6e08c2"
  ]
}
No content

Generate temporary token

post
/clients/v1/files/{file_id}/generate-link

Generates a temporary token with a specified duration for downloading a file. Requires a valid Bearer token for authentication.

Path parameters
file_idstringRequired

The ID of the file to generate a link for.

Example: 682c304bbf71b6b7ac80dc97
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
durationintegerRequired

Duration of the link validity in seconds.

Example: 3600
Responses
200

Successfully generated a temporary token.

No content
post
/clients/v1/files/{file_id}/generate-link
POST /clients/v1/files/{file_id}/generate-link HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "duration": 3600
}
No content

Share file

post
/clients/v1/files/{file}/share

Shares a file with specified access settings. Requires authentication. Request body is optional unless access is 'password' (requires password) or 'email' (requires emails).

Path parameters
filestringRequired

The ID of the file to share.

Example: 6853e14d78e8cc3e4c66fb
Query parameters
accessstring · enumRequired

The access level for the shared file (public, private, password, email).

Example: passwordPossible values:
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
passwordstringOptional

Password required for 'password' access. Must be at least 8 characters long, include 1 uppercase letter, 1 number, and 1 special character (!@#$%^&*()_+). Required if access is 'password'.

Example: Password123!
emailsstring[]Optional

List of email addresses for 'email' access. Required if access is 'email'. The email must have an account in Koneksi.

Example: ["alex@ardata.tech","paulinquit@gmail.com"]
Responses
200

File shared successfully.

No content
post
/clients/v1/files/{file}/share
POST /clients/v1/files/{file}/share?access=public HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "password": "Password123!",
  "emails": [
    "alex@ardata.tech",
    "paulinquit@gmail.com"
  ]
}
No content

Create recovery request

post
/clients/v1/recovery/request

Creates a new recovery request. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
recovery_pathstringRequired

The path to recover.

Example: /Users/aldrickb/Desktop/
recovery_scopestring · enumRequired

The scope of the recovery. Options are full, point_in_time, backup_snapshot

Example: backup_snapshotPossible values:
snapshot_idstringOptional

Required only when recovery_scope is backup_snapshot

Example: 68e350b5e02a589e7e313711
Responses
200

Recovery request created successfully.

No content
post
/clients/v1/recovery/request
POST /clients/v1/recovery/request HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 208

{
  "recovery_path": "/Users/aldrickb/Desktop/",
  "recovery_scope": "backup_snapshot",
  "point_in_time": {
    "start_date": "2024-06-15T00:00:00Z",
    "end_date": "2024-07-15T23:59:59Z"
  },
  "snapshot_id": "68e350b5e02a589e7e313711"
}
No content

List recovery requests

get
/clients/v1/recovery/request/list

Lists all recovery requests. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Recovery requests listed successfully.

No content
get
/clients/v1/recovery/request/list
GET /clients/v1/recovery/request/list HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Read recovery request

get
/clients/v1/recovery/request/{recovery_request_id}/read

Reads a recovery request by its ID. Requires authentication.

Path parameters
recovery_request_idstringRequiredExample: 6880a6d940f95c4b1b6e08c3
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Recovery request read successfully.

No content
get
/clients/v1/recovery/request/{recovery_request_id}/read
GET /clients/v1/recovery/request/{recovery_request_id}/read HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Get recovery request scope

get
/clients/v1/recovery/request/{recovery_request_id}/scope

Gets the scope of a recovery request by its ID. Requires authentication.

Path parameters
recovery_request_idstringRequiredExample: 6880a6d940f95c4b1b6e08c3
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Recovery request scope retrieved successfully.

No content
get
/clients/v1/recovery/request/{recovery_request_id}/scope
GET /clients/v1/recovery/request/{recovery_request_id}/scope HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Update recovery request

put
/clients/v1/recovery/request/{recovery_request_id}/update

Updates a recovery request by its ID. Requires authentication.

Path parameters
recovery_request_idstringRequiredExample: 6880a6d940f95c4b1b6e08c3
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
recovery_pathstringRequired

The path to recover.

Example: /home/user/recovery
recovery_scopestringRequired

The scope of the recovery.

Example: full
Responses
200

Recovery request updated successfully.

No content
put
/clients/v1/recovery/request/{recovery_request_id}/update
PUT /clients/v1/recovery/request/{recovery_request_id}/update HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "recovery_path": "/home/user/recovery",
  "recovery_scope": "full",
  "point_in_time": {
    "start_date": "2021-01-01",
    "end_date": "2021-01-01"
  }
}
No content

Update recovery request status

put
/clients/v1/recovery/request/{recovery_request_id}/update-status

Updates the status of a recovery request by its ID. Requires authentication.

Path parameters
recovery_request_idstringRequiredExample: 6880a6d940f95c4b1b6e08c3
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
statusstringRequired

The status of the recovery request.

Example: pending
Responses
200

Recovery request status updated successfully.

No content
put
/clients/v1/recovery/request/{recovery_request_id}/update-status
PUT /clients/v1/recovery/request/{recovery_request_id}/update-status HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "status": "pending"
}
No content

Delete recovery request

delete
/clients/v1/recovery/request/{recovery_request_id}/delete

Deletes a recovery request by its ID. Requires authentication.

Path parameters
recovery_request_idstringRequiredExample: 6880a6d940f95c4b1b6e08c3
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Recovery request deleted successfully.

No content
delete
/clients/v1/recovery/request/{recovery_request_id}/delete
DELETE /clients/v1/recovery/request/{recovery_request_id}/delete HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Get realtime backup config request

get
/clients/v1/realtime-backup/config/request

Gets a realtime backup config request. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Realtime backup config request retrieved successfully.

No content
get
/clients/v1/realtime-backup/config/request
GET /clients/v1/realtime-backup/config/request HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Create realtime backup config request

post
/clients/v1/realtime-backup/config/request/create

Creates a realtime backup config request. Requires authentication.

Query parameters
includeDirbooleanOptional

Whether to include directories in the response.

Example: true
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Realtime backup config request created successfully.

No content
post
/clients/v1/realtime-backup/config/request/create
POST /clients/v1/realtime-backup/config/request/create HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Cancel realtime backup config request

post
/clients/v1/realtime-backup/config/request/cancel

Cancels a realtime backup config request. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Realtime backup config request cancelled successfully.

No content
post
/clients/v1/realtime-backup/config/request/cancel
POST /clients/v1/realtime-backup/config/request/cancel HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Read realtime backup config

get
/clients/v1/realtime-backup/config/read

Reads a realtime backup config. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Realtime backup config retrieved successfully.

No content
get
/clients/v1/realtime-backup/config/read
GET /clients/v1/realtime-backup/config/read HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Create realtime backup config

post
/clients/v1/realtime-backup/config/create

Creates a realtime backup config. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
host_directory_pathstringRequired

The path of the host directory.

Example: /home/user/host_directory
directory_idstringRequired

The ID of the directory.

Example: 6880a6d940f95c4b1b6e08c3
is_watcher_enabledbooleanRequired

Whether the watcher is enabled.

Example: true
Responses
200

Realtime backup config created successfully.

No content
post
/clients/v1/realtime-backup/config/create
POST /clients/v1/realtime-backup/config/create HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "host_directory_path": "/home/user/host_directory",
  "directory_id": "6880a6d940f95c4b1b6e08c3",
  "is_watcher_enabled": true,
  "watcher_subdirectories": [
    {
      "path": "/home/user/host_directory/subdirectory",
      "directory_id": "6880a6d940f95c4b1b6e08c3"
    }
  ]
}
No content

Create snapshot

post
/clients/v1/snapshot/create

Creates a snapshot. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
descriptionstringRequired

The description of the snapshot.

Example: Snapshot 1
Responses
200

Snapshot created successfully.

No content
post
/clients/v1/snapshot/create
POST /clients/v1/snapshot/create HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "description": "Snapshot 1"
}
No content

List snapshots

get
/clients/v1/snapshot/list

Lists all snapshots. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

List of snapshots retrieved successfully.

No content
get
/clients/v1/snapshot/list
GET /clients/v1/snapshot/list HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Read snapshot

get
/clients/v1/snapshot/read/{snapshotID}

Reads a snapshot. Requires authentication.

Path parameters
snapshotIDstringRequiredExample: 6880a6d940f95c4b1b6e08c3
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Snapshot retrieved successfully.

No content
get
/clients/v1/snapshot/read/{snapshotID}
GET /clients/v1/snapshot/read/{snapshotID} HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Read snapshot directory

get
/clients/v1/snapshot/read-directory/{snapshotID}/{directoryID}

Reads a snapshot directory. Requires authentication.

Path parameters
snapshotIDstringRequiredExample: 6880a6d940f95c4b1b6e08c3
directoryIDstringRequiredExample: 6880a6d940f95c4b1b6e08c3
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Snapshot directory retrieved successfully.

No content
get
/clients/v1/snapshot/read-directory/{snapshotID}/{directoryID}
GET /clients/v1/snapshot/read-directory/{snapshotID}/{directoryID} HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

List snapshot directory scope

get
/clients/v1/snapshot/{snapshotID}/directory-scope

Lists all snapshot directory scope. Requires authentication.

Path parameters
snapshotIDstringRequiredExample: 6880a6d940f95c4b1b6e08c3
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Snapshot directory scope retrieved successfully.

No content
get
/clients/v1/snapshot/{snapshotID}/directory-scope
GET /clients/v1/snapshot/{snapshotID}/directory-scope HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

List snapshot file scope

get
/clients/v1/snapshot/{snapshotID}/file-scope

Lists all snapshot file scope. Requires authentication.

Path parameters
snapshotIDstringRequiredExample: 6880a6d940f95c4b1b6e08c3
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
200

Snapshot file scope retrieved successfully.

No content
get
/clients/v1/snapshot/{snapshotID}/file-scope
GET /clients/v1/snapshot/{snapshotID}/file-scope HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content
PreviousProfileNextSystem Admin

Last updated