Directories | Koneksi Docs

Create directory

post

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

Responses

201

Directory created successfully. Returns the created directory details.

401

Unauthorized. Valid Client-ID and Client-Secret required.

500

Server error. An error occurred while processing the request.

post

POST /api/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

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.

401

Unauthorized. Valid Client-ID and Client-Secret required.

500

Server error. An error occurred while processing the request.

get

GET /api/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

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.

401

Unauthorized. Valid Client-ID and Client-Secret required.

500

Server error. An error occurred while processing the request.

put

PUT /api/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

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

201

Directory deleted successfully. Returns a success message.

401

Unauthorized. Valid Client-ID and Client-Secret required.

500

Server error. An error occurred while processing the request.

delete

DELETE /api/clients/v1/directories/{directory_id} HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content