1. Integration conventions
Production base URL is https://app.dicloak.com/gin.
- Use HTTPS and GET. Pass filters and pagination values as URL query parameters.
- Authenticate with the
X-HTTP-KEYheader. Responses are JSON withsnake_casefield names. - Check the response
codefor the result. A value of0means success. HTTP200can also carry an API error. - The cURL examples use Bash syntax. Replace the key and cursor placeholders with actual values.
2. Endpoint directory
| Section | Method | Path | Purpose |
|---|---|---|---|
| 3 | GET | /v1/api/request/log/operation | Query member operation logs |
| 4 | GET | /v1/api/request/log/login | Query login logs |
| 5 | GET | /v1/api/request/log/browser_history | Query browsing history |
| 6 | GET | /v1/api/request/log/environment_share | Query profile sharing records |
| 7 | GET | /v1/api/request/log/environment_transfer | Query profile transfer records |
3. Query member operation logs
Query paginated operation logs for members of the current team. All supplied filters apply together.
Members with the Operation Records permission can retrieve records. With a valid key and without that permission, the response contains code: 0, data.list: [], data.total: 0, and next: null.
Request URL
GET https://app.dicloak.com/gin/v1/api/request/log/operation
Request headers
| Header | Type | Required | Description |
|---|---|---|---|
X-HTTP-KEY | string | Yes | HTTP API key for the current team. Find it in DICloak under Open API → HTTP API. |
Request parameters
This endpoint accepts URL query parameters. It has no path parameters or request body.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number. Defaults to 1. Minimum 1. Applies to page-number pagination. |
page_size | integer | No | Records per page. Defaults to 100. Range 1–100. Applies to page-number pagination. |
limit | integer | No | Records per cursor batch. Defaults to 100. Range 1–100. Send limit to start at the first batch. |
cursor | string | No | Top-level next value from the preceding batch. Omit it for the first batch. |
member_id | string | No | Exact ID of the team member who performed the action. |
business_type | string | No | Exact business category, such as ENV or MEMBER. See Filter values. |
operation_type | string | No | Exact operation type, such as CREATE_ENV or EDIT_MEMBER. See Filter values. |
value | string | No | Text to search for in the operation details. |
start_create_time | string | No | Earliest operation time, inclusive. Use yyyy-MM-dd HH:mm:ss. |
end_create_time | string | No | Latest operation time, inclusive. Use a full timestamp in yyyy-MM-dd HH:mm:ss format. |
device_name | string | No | Text contained in the device name. |
ip | string | No | Text contained in the recorded IP address. |
country | string | No | Filter by country name in the logged IP information. |
Pagination and time rules
- Page-number pagination uses
page,page_size, or both. It returns the most recent operations first. With all pagination parameters omitted, the API returns page 1 with up to 100 records. - Cursor pagination uses
limit, a nonemptycursor, or both. To retrieve the next batch, passnextunchanged ascursorand keep the same filters. Anullvalue fornextends the cursor query. - Use one mode per request. Mixing
pageorpage_sizewithlimitorcursorreturns400009. - Time filters use UTC+08:00. To include a whole day, use
23:59:59on that date as the end time.
Request examples
Query by page number
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/operation' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'business_type=ENV' \
--data-urlencode 'operation_type=CREATE_ENV' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=20'
Retrieve the first cursor batch
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/operation' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'business_type=ENV' \
--data-urlencode 'operation_type=CREATE_ENV' \
--data-urlencode 'limit=1'
Retrieve the next batch
Replace <NEXT_CURSOR> with the next value returned in the preceding response.
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/operation' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'business_type=ENV' \
--data-urlencode 'operation_type=CREATE_ENV' \
--data-urlencode 'limit=1' \
--data-urlencode 'cursor=<NEXT_CURSOR>'
Response parameters
| Field | Type | Description |
|---|---|---|
code | integer | 0 means success. Other values indicate a failed request. |
msg | string | Result or error message. |
data | object/null | Paginated result on success. May be null on failure. |
data.list | array | Operation logs returned by this request. An empty result is []. |
data.total | integer | Total records that match the filters, independent of the current page or cursor position. |
data.summary | null | Always null. |
next | string/null | Cursor for the next batch. null in page-number mode or when there are no more batches. |
data.list[].create_time | string | Operation time in yyyy-MM-dd HH:mm:ss format, UTC+08:00. |
data.list[].operation_type | string | Operation code. Uses the same values as the operation_type query parameter. |
data.list[].operation_objects | array of strings | Display text for the items affected by the operation, in the order shown in DICloak. Returns [] if there are none. |
data.list[].member_name | string/null | Member display name recorded for the operation. |
data.list[].ip | string/null | Recorded IP address. |
data.list[].ip_info | object/null | Country information for the IP address. null when unavailable. |
data.list[].ip_info.country_code | string/null | Country code. |
data.list[].ip_info.country | string/null | Country name. |
data.list[].device_name | string/null | Device name. |
Successful response example
This example uses limit=1 with another batch available. <NEXT_CURSOR> represents the cursor returned by the API.
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"create_time": "2026-10-12 09:45:00",
"operation_type": "CREATE_ENV",
"operation_objects": [
"QA Workspace (42)"
],
"member_name": "Alex",
"ip": "192.0.2.10",
"ip_info": {
"country_code": "US",
"country": "United States"
},
"device_name": "Work Laptop"
}
],
"total": 2,
"summary": null
},
"next": "<NEXT_CURSOR>"
}
Common errors
| HTTP status | Business code | Meaning and action |
|---|---|---|
200 | 400003 | Access denied. Check that the key is valid. If the key has an IP restriction, confirm that your IP is allowed. |
400 or 200 | 400009 | Invalid parameter. Check the filters, pagination mode, and allowed ranges. If the cursor is invalid, omit cursor to start again at the first batch. |
429 | 400010 | Too many requests. Wait at least one second before retrying. |
200 | 500000 | The request could not be completed. Try again later. |
Error response example
Sending both page and limit returns HTTP 200 with the following body.
{
"code": 400009,
"msg": "page/page_size and cursor/limit cannot be used together",
"data": null,
"next": null
}
Filter values
Send the values exactly as written.
Business types
ENV, PROXY, ENV_GROUP, MEMBER, MEMBER_GROUP, ENV_TAG, EXTENSION, ENV_SYNC, RPA_TASK, MEMBER_API, AI_SPIDER, OPEN_API
Operation types
Use operation_type to filter by a specific action. The same values appear in the response. For example, use operation_type=UPDATE_ENV to find records for batch updates to browser profiles.
Profiles
operation_type | Meaning |
|---|---|
CREATE_ENV | Create a browser profile. |
OPEN_ENV | Open a browser profile. |
CLOSE_ENV | Close a browser profile session. |
TRANSFER_ENV | Transfer a browser profile to another team. |
CLEAR_CACHE | Clear the cache for a browser profile. |
DELETE_ENV | Move a browser profile to the Recycle Bin. |
THOROUGH_DELETE_ENV | Permanently delete a browser profile from the Recycle Bin. |
RECOVERY_ENV | Restore a browser profile from the Recycle Bin. |
CLONE_ENV | Create a new browser profile by cloning an existing one. |
SHARE_ENV | Share a browser profile with another team. |
EDIT_ENV | Edit the settings of an existing browser profile. |
EXPORT_ENV | Export browser profile data. |
UPDATE_ENV | Change browser profile settings using the batch update feature. |
COMMAND_CLOSE_ENV | Close a browser profile on all devices. |
ENV_CUSTOM_NUMBER | Change the custom number of a browser profile. |
CANCEL_SHARE_ENV | Cancel an existing browser profile share. |
Profile groups
operation_type | Meaning |
|---|---|
SET_ENV_GROUP | Set the group assignments for browser profiles. |
CREATE_ENV_GROUP | Create a browser profile group. |
EDIT_ENV_GROUP | Edit the settings of an existing browser profile group. |
DELETE_ENV_GROUP | Delete a browser profile group. |
Proxies
operation_type | Meaning |
|---|---|
CREATE_PROXY | Add a proxy configuration. |
EDIT_PROXY | Edit an existing proxy configuration. |
DELETE_PROXY | Delete a proxy configuration. |
EXPORT_PROXY | Export proxy data. |
BATCH_UPDATE_PROXY | Change proxy configurations using the batch update feature. |
Members
operation_type | Meaning |
|---|---|
CREATE_MEMBER | Create a member in the team. |
EDIT_MEMBER | Edit an existing team member’s information or settings. |
DELETE_MEMBER | Remove a member from the team. |
EXPORT_MEMBER | Export team member data. |
ACTIVEATE_MEMBER | Activate or re-enable a team member account. |
Member groups
operation_type | Meaning |
|---|---|
CREATE_MEMBER_GROUP | Create a team member group. |
EDIT_MEMBER_GROUP | Edit the settings of an existing team member group. |
DELETE_MEMBER_GROUP | Delete a team member group. |
Profile tags
operation_type | Meaning |
|---|---|
CREATE_ENV_TAG | Create a tag for labeling browser profiles. |
EDIT_ENV_TAG | Edit an existing browser profile tag. |
DELETE_ENV_TAG | Delete a browser profile tag. |
Extensions
operation_type | Meaning |
|---|---|
CREATE_EXTENSION | Add an extension to DICloak. |
ENABLE_EXTENSION | Enable an extension that has been added. |
STOP_EXTENSION | Disable an extension that has been added. |
EDIT_EXTENSION | Edit an existing extension’s settings. |
UPGRADE_EXTENSION | Update an extension to a different version. |
DELETE_EXTENSION | Remove an extension from DICloak. |
Profile sync
operation_type | Meaning |
|---|---|
OPEN_ENV_SYNC | Start synchronizing actions across browser windows. |
CLOSE_ENV_SYNC | Stop synchronizing actions across browser windows. |
RPA tasks
operation_type | Meaning |
|---|---|
CREATE_RPA_TASK | Create an RPA automation task. |
EDIT_RPA_TASK | Edit the settings of an existing RPA task. |
RUN_RPA_TASK | Start an RPA task run. |
Member API
operation_type | Meaning |
|---|---|
CREATE_MEMBER_API | Create an API link for member management. |
EDIT_MEMBER_API | Edit the settings of an existing member management API link. |
DELETE_MEMBER_API | Delete a member management API link. |
AI Spider
operation_type | Meaning |
|---|---|
RUN_TASK_AI_SPIDER | Run an AI Spider task. |
DOWNLOAD_AI_SPIDER | Download data collected by an AI Spider task. |
Open API
operation_type | Meaning |
|---|---|
CREATE_KEY_OPEN_API | Generate an API key. |
RESET_KEY_OPEN_API | Reset an existing API key. |
EDIT_PORT_OPEN_API | Change the port in the Open API settings. |
4. Query login logs
Query paginated team entry and exit records for the current team.
Members with the Login Logs permission can retrieve records. With a valid key and without the required permission, the response contains code: 0, data.list: [], data.total: 0, and next: null.
Request URL
GET https://app.dicloak.com/gin/v1/api/request/log/login
Request headers
| Header | Type | Required | Description |
|---|---|---|---|
X-HTTP-KEY | string | Yes | HTTP API key for the current team. Find it in DICloak under Open API → HTTP API. |
Request parameters
This endpoint accepts URL query parameters. It has no path parameters or request body.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number. Defaults to 1. Minimum 1. Applies to page-number pagination. |
page_size | integer | No | Records per page. Defaults to 100. Range 1–100. Applies to page-number pagination. |
limit | integer | No | Records per cursor batch. Defaults to 100. Range 1–100. Send limit to start at the first batch. |
cursor | string | No | Top-level next value from the preceding batch. Omit it for the first batch. |
member_id | string | No | Exact team member ID. |
type | string | No | ENTER_ORG means enter the team. EXIT_ORG means exit the team. |
start_create_time | string | No | Earliest login event time, inclusive. Use yyyy-MM-dd HH:mm:ss. |
end_create_time | string | No | Latest login event time, inclusive. A date-only value includes the full day. |
device_name | string | No | Text contained in the device name. |
ip | string | No | Text contained in the recorded IP address. |
country | string | No | Filter by country name in the logged IP information. |
Pagination and time rules
- Page-number pagination uses
page,page_size, or both. With all pagination parameters omitted, the API returns page 1 with up to 100 records. - Cursor pagination uses
limit, a nonemptycursor, or both. Passnextunchanged ascursorand keep the same filters. Anullvalue fornextends the cursor query. - Use one mode per request. Mixing page-number and cursor parameters returns
400009. - Time filters use UTC+08:00. A date-only end value includes the full day.
Request examples
Query by page number
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/login' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'type=ENTER_ORG' \
--data-urlencode 'start_create_time=2026-10-12 00:00:00' \
--data-urlencode 'end_create_time=2026-10-12' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=20'
Retrieve the first cursor batch
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/login' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'type=ENTER_ORG' \
--data-urlencode 'start_create_time=2026-10-12 00:00:00' \
--data-urlencode 'end_create_time=2026-10-12' \
--data-urlencode 'limit=1'
Retrieve the next batch
Replace <NEXT_CURSOR> with the next value returned in the preceding response.
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/login' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'type=ENTER_ORG' \
--data-urlencode 'start_create_time=2026-10-12 00:00:00' \
--data-urlencode 'end_create_time=2026-10-12' \
--data-urlencode 'limit=1' \
--data-urlencode 'cursor=<NEXT_CURSOR>'
Response parameters
| Field | Type | Description |
|---|---|---|
code | integer | 0 means success. Other values indicate a failed request. |
msg | string | Result or error message. |
data | object/null | Paginated result on success. May be null on failure. |
data.list | array | Operation logs returned by this request. An empty result is []. |
data.total | integer | Total records that match the filters, independent of the current page or cursor position. |
data.summary | null | Always null. |
next | string/null | Cursor for the next batch. null in page-number mode or when there are no more batches. |
data.list[].create_time | string | Login event time in yyyy-MM-dd HH:mm:ss format, UTC+08:00. |
data.list[].type | string | ENTER_ORG or EXIT_ORG. |
data.list[].member_name | string/null | Member display name. |
data.list[].ip | string/null | Recorded IP address. |
data.list[].ip_info | object/null | Country information for the IP address. null when unavailable. |
data.list[].ip_info.country_code | string/null | Country code. |
data.list[].ip_info.country | string/null | Country name. |
data.list[].device_name | string/null | Device name. |
data.list[].os | string/null | Recorded device operating system. |
data.list[].app_version | string/null | DICloak version recorded for the event. |
Successful response example
This example uses limit=1 with another batch available. <NEXT_CURSOR> represents the cursor returned by the API.
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"create_time": "2026-10-12 09:45:00",
"type": "ENTER_ORG",
"member_name": "Alex",
"ip": "192.0.2.10",
"ip_info": {
"country_code": "US",
"country": "United States"
},
"device_name": "Work Laptop",
"os": "Windows",
"app_version": "5.0.0"
}
],
"total": 2,
"summary": null
},
"next": "<NEXT_CURSOR>"
}
Common errors
| HTTP status | Business code | Meaning and action |
|---|---|---|
200 | 400003 | Access denied. Check that the key is valid. If the key has an IP restriction, confirm that your IP is allowed. |
400 or 200 | 400009 | Invalid parameter. Check the filters, pagination mode, and allowed ranges. If the cursor is invalid, omit cursor to start again at the first batch. |
429 | 400010 | Too many requests. Wait at least one second before retrying. |
200 | 500000 | The request could not be completed. Try again later. |
Error response example
Sending both page and limit returns HTTP 200 with the following body.
{
"code": 400009,
"msg": "page/page_size and cursor/limit cannot be used together",
"data": null,
"next": null
}
5. Query browsing history
Query paginated website visits made by members of the current team in browser profiles.
Members with the Browsing History permission can retrieve records. With a valid key and without the required permission, the response contains code: 0, data.list: [], data.total: 0, and next: null.
Request URL
GET https://app.dicloak.com/gin/v1/api/request/log/browser_history
Request headers
| Header | Type | Required | Description |
|---|---|---|---|
X-HTTP-KEY | string | Yes | HTTP API key for the current team. Find it in DICloak under Open API → HTTP API. |
Request parameters
This endpoint accepts URL query parameters. It has no path parameters or request body.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number. Defaults to 1. Minimum 1. Applies to page-number pagination. |
page_size | integer | No | Records per page. Defaults to 100. Range 1–100. Applies to page-number pagination. |
limit | integer | No | Records per cursor batch. Defaults to 100. Range 1–100. Send limit to start at the first batch. |
cursor | string | No | Top-level next value from the preceding batch. Omit it for the first batch. |
member_id | string | No | Exact team member ID. |
env_id | string | No | Exact profile ID. Use the ID returned by the profiles API. |
keyword | string | No | Text contained in either the page title or full URL. |
start_create_time | string | No | Earliest visit time, inclusive. Use yyyy-MM-dd HH:mm:ss. |
end_create_time | string | No | Latest visit time, inclusive. A date-only value includes the full day. |
device_name | string | No | Text contained in the device name. |
ip | string | No | Text contained in the recorded IP address. |
country | string | No | Filter by country name in the logged IP information. |
Pagination and time rules
- Page-number pagination uses
page,page_size, or both. With all pagination parameters omitted, the API returns page 1 with up to 100 records. - Cursor pagination uses
limit, a nonemptycursor, or both. Passnextunchanged ascursorand keep the same filters. Anullvalue fornextends the cursor query. - Use one mode per request. Mixing page-number and cursor parameters returns
400009. - Time filters use UTC+08:00. A date-only end value includes the full day.
Page-number pagination returns the most recent visits first.
Request examples
Query by page number
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/browser_history' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'keyword=example.com' \
--data-urlencode 'start_create_time=2026-10-12 00:00:00' \
--data-urlencode 'end_create_time=2026-10-12' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=20'
Retrieve the first cursor batch
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/browser_history' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'keyword=example.com' \
--data-urlencode 'start_create_time=2026-10-12 00:00:00' \
--data-urlencode 'end_create_time=2026-10-12' \
--data-urlencode 'limit=1'
Retrieve the next batch
Replace <NEXT_CURSOR> with the next value returned in the preceding response.
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/browser_history' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'keyword=example.com' \
--data-urlencode 'start_create_time=2026-10-12 00:00:00' \
--data-urlencode 'end_create_time=2026-10-12' \
--data-urlencode 'limit=1' \
--data-urlencode 'cursor=<NEXT_CURSOR>'
Response parameters
| Field | Type | Description |
|---|---|---|
code | integer | 0 means success. Other values indicate a failed request. |
msg | string | Result or error message. |
data | object/null | Paginated result on success. May be null on failure. |
data.list | array | Operation logs returned by this request. An empty result is []. |
data.total | integer | Total records that match the filters, independent of the current page or cursor position. |
data.summary | null | Always null. |
next | string/null | Cursor for the next batch. null in page-number mode or when there are no more batches. |
data.list[].time | string | Website visit time in yyyy-MM-dd HH:mm:ss format, UTC+08:00. |
data.list[].title | string/null | Full page title. |
data.list[].url | string/null | Full URL recorded for the visit. |
data.list[].env_name | string/null | Browser profile name. |
data.list[].serial_num | integer/null | Profile number displayed in DICloak. |
data.list[].member_name | string/null | Member display name. |
data.list[].ip | string/null | Recorded IP address. |
data.list[].ip_info | object/null | Country information for the IP address. null when unavailable. |
data.list[].ip_info.country_code | string/null | Country code. |
data.list[].ip_info.country | string/null | Country name. |
data.list[].device_name | string/null | Device name. |
Successful response example
This example uses limit=1 with another batch available. <NEXT_CURSOR> represents the cursor returned by the API.
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"time": "2026-10-12 09:45:00",
"title": "Example Domain",
"url": "https://example.com/",
"env_name": "QA Workspace",
"serial_num": 42,
"member_name": "Alex",
"ip": "192.0.2.10",
"ip_info": {
"country_code": "US",
"country": "United States"
},
"device_name": "Work Laptop"
}
],
"total": 2,
"summary": null
},
"next": "<NEXT_CURSOR>"
}
Common errors
| HTTP status | Business code | Meaning and action |
|---|---|---|
200 | 400003 | Access denied. Check that the key is valid. If the key has an IP restriction, confirm that your IP is allowed. |
400 or 200 | 400009 | Invalid parameter. Check the filters, pagination mode, and allowed ranges. If the cursor is invalid, omit cursor to start again at the first batch. |
429 | 400010 | Too many requests. Wait at least one second before retrying. |
200 | 500000 | The request could not be completed. Try again later. |
Error response example
Sending both page and limit returns HTTP 200 with the following body.
{
"code": 400009,
"msg": "page/page_size and cursor/limit cannot be used together",
"data": null,
"next": null
}
6. Query profile sharing records
Query paginated browser profile sharing records for the current team.
Members with the View Shared Profiles or Profile Sharing Logs permission can retrieve records. With a valid key and without the required permission, the response contains code: 0, data.list: [], data.total: 0, and next: null.
Request URL
GET https://app.dicloak.com/gin/v1/api/request/log/environment_share
Request headers
| Header | Type | Required | Description |
|---|---|---|---|
X-HTTP-KEY | string | Yes | HTTP API key for the current team. Find it in DICloak under Open API → HTTP API. |
Request parameters
This endpoint accepts URL query parameters. It has no path parameters or request body.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number. Defaults to 1. Minimum 1. Applies to page-number pagination. |
page_size | integer | No | Records per page. Defaults to 100. Range 1–100. Applies to page-number pagination. |
limit | integer | No | Records per cursor batch. Defaults to 100. Range 1–100. Send limit to start at the first batch. |
cursor | string | No | Top-level next value from the preceding batch. Omit it for the first batch. |
env_id | string | No | Exact profile ID. Use the ID returned by the profiles API. |
share_status | boolean | No | true for active shares or false for canceled shares. Omit it to include both. |
team_id | string | No | Match a target team number or text in the share destination, such as part of the recipient email. |
create_by_id | string | No | Exact ID of the member who created the share. |
remark | string | No | Text contained in the sharing note. |
start_create_time | string | No | Earliest share creation time, inclusive. Use yyyy-MM-dd HH:mm:ss. |
end_create_time | string | No | Latest share creation time, inclusive. Use a full timestamp in yyyy-MM-dd HH:mm:ss format. |
Pagination and time rules
- Page-number pagination uses
page,page_size, or both. With all pagination parameters omitted, the API returns page 1 with up to 100 records. - Cursor pagination uses
limit, a nonemptycursor, or both. Passnextunchanged ascursorand keep the same filters. Anullvalue fornextends the cursor query. - Use one mode per request. Mixing page-number and cursor parameters returns
400009. - Time filters use UTC+08:00. To include a whole day, use
23:59:59on that date as the end time.
Page-number pagination returns the most recent shares first. Requesting a page beyond the last one returns an empty list and preserves the matching total in data.total.
Request examples
Query by page number
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/environment_share' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'share_status=true' \
--data-urlencode 'team_id=qa@example.com' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=20'
Retrieve the first cursor batch
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/environment_share' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'share_status=true' \
--data-urlencode 'team_id=qa@example.com' \
--data-urlencode 'limit=1'
Retrieve the next batch
Replace <NEXT_CURSOR> with the next value returned in the preceding response.
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/environment_share' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'share_status=true' \
--data-urlencode 'team_id=qa@example.com' \
--data-urlencode 'limit=1' \
--data-urlencode 'cursor=<NEXT_CURSOR>'
Response parameters
| Field | Type | Description |
|---|---|---|
code | integer | 0 means success. Other values indicate a failed request. |
msg | string | Result or error message. |
data | object/null | Paginated result on success. May be null on failure. |
data.list | array | Operation logs returned by this request. An empty result is []. |
data.total | integer | Total records that match the filters, independent of the current page or cursor position. |
data.summary | null | Always null. |
next | string/null | Cursor for the next batch. null in page-number mode or when there are no more batches. |
data.list[].environment_name | string/null | Shared profile name. |
data.list[].serial_num | integer/null | Profile number displayed in DICloak. |
data.list[].remark | string/null | Sharing note. |
data.list[].share_team_id | string/null | Target team number. |
data.list[].share_email | string/null | Recipient email, when available. |
data.list[].share_env_types | array of strings | Sharing permissions. OPEN allows opening the profile, and EDIT allows editing it. |
data.list[].create_by_name | string/null | Display name of the member who created the share. |
data.list[].create_time | string | Share creation time in yyyy-MM-dd HH:mm:ss format, UTC+08:00. |
data.list[].share_status | boolean | true for an active share or false for a canceled share. |
Successful response example
This example uses limit=1 with another batch available. <NEXT_CURSOR> represents the cursor returned by the API.
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"environment_name": "QA Workspace",
"serial_num": 42,
"remark": "Access for QA",
"share_team_id": "100200",
"share_email": "qa@example.com",
"share_env_types": [
"OPEN"
],
"create_by_name": "Alex",
"create_time": "2026-10-12 09:45:00",
"share_status": true
}
],
"total": 2,
"summary": null
},
"next": "<NEXT_CURSOR>"
}
Common errors
| HTTP status | Business code | Meaning and action |
|---|---|---|
200 | 400003 | Access denied. Check that the key is valid. If the key has an IP restriction, confirm that your IP is allowed. |
400 or 200 | 400009 | Invalid parameter. Check the filters, pagination mode, and allowed ranges. If the cursor is invalid, omit cursor to start again at the first batch. |
429 | 400010 | Too many requests. Wait at least one second before retrying. |
200 | 500000 | The request could not be completed. Try again later. |
Error response example
Sending both page and limit returns HTTP 200 with the following body.
{
"code": 400009,
"msg": "page/page_size and cursor/limit cannot be used together",
"data": null,
"next": null
}
7. Query profile transfer records
Query paginated browser profile transfer records for the current team.
Members with the Profile Transfer Logs permission can retrieve records. With a valid key and without the required permission, the response contains code: 0, data.list: [], data.total: 0, and next: null.
Request URL
GET https://app.dicloak.com/gin/v1/api/request/log/environment_transfer
Request headers
| Header | Type | Required | Description |
|---|---|---|---|
X-HTTP-KEY | string | Yes | HTTP API key for the current team. Find it in DICloak under Open API → HTTP API. |
Request parameters
This endpoint accepts URL query parameters. It has no path parameters or request body.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number. Defaults to 1. Minimum 1. Applies to page-number pagination. |
page_size | integer | No | Records per page. Defaults to 100. Range 1–100. Applies to page-number pagination. |
limit | integer | No | Records per cursor batch. Defaults to 100. Range 1–100. Send limit to start at the first batch. |
cursor | string | No | Top-level next value from the preceding batch. Omit it for the first batch. |
serial_num | integer | No | Exact profile number displayed in DICloak. |
team_id | string | No | Exact transfer destination. An email address matches the recipient email. Other values match the target team number. |
create_by_id | string | No | Exact ID of the member who initiated the transfer. |
remark | string | No | Text contained in the transfer note. |
start_create_time | string | No | Earliest transfer time, inclusive. Use yyyy-MM-dd HH:mm:ss. |
end_create_time | string | No | Latest transfer time, inclusive. Use a full timestamp in yyyy-MM-dd HH:mm:ss format. |
Pagination and time rules
- Page-number pagination uses
page,page_size, or both. With all pagination parameters omitted, the API returns page 1 with up to 100 records. - Cursor pagination uses
limit, a nonemptycursor, or both. Passnextunchanged ascursorand keep the same filters. Anullvalue fornextends the cursor query. - Use one mode per request. Mixing page-number and cursor parameters returns
400009. - Time filters use UTC+08:00. To include a whole day, use
23:59:59on that date as the end time.
Page-number pagination returns the most recent transfers first.
Request examples
Query by page number
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/environment_transfer' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'serial_num=42' \
--data-urlencode 'team_id=qa@example.com' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=20'
Retrieve the first cursor batch
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/environment_transfer' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'serial_num=42' \
--data-urlencode 'team_id=qa@example.com' \
--data-urlencode 'limit=1'
Retrieve the next batch
Replace <NEXT_CURSOR> with the next value returned in the preceding response.
curl --get 'https://app.dicloak.com/gin/v1/api/request/log/environment_transfer' \
--header 'X-HTTP-KEY: <YOUR_TEAM_HTTP_API_KEY>' \
--data-urlencode 'serial_num=42' \
--data-urlencode 'team_id=qa@example.com' \
--data-urlencode 'limit=1' \
--data-urlencode 'cursor=<NEXT_CURSOR>'
Response parameters
| Field | Type | Description |
|---|---|---|
code | integer | 0 means success. Other values indicate a failed request. |
msg | string | Result or error message. |
data | object/null | Paginated result on success. May be null on failure. |
data.list | array | Operation logs returned by this request. An empty result is []. |
data.total | integer | Total records that match the filters, independent of the current page or cursor position. |
data.summary | null | Always null. |
next | string/null | Cursor for the next batch. null in page-number mode or when there are no more batches. |
data.list[].environment_name | string/null | Transferred profile name. |
data.list[].serial_num | integer/null | Profile number displayed in DICloak. |
data.list[].remark | string/null | Transfer note. |
data.list[].transfer_team_id | string/null | Target team number. |
data.list[].transfer_email | string/null | Recipient email, when available. |
data.list[].transfer_info | array of strings | Additional information included in the transfer. NAME includes the profile name, REMARK includes the remark, and PROXY includes proxy information. |
data.list[].create_by_name | string/null | Display name of the member who initiated the transfer. |
data.list[].create_time | string | Transfer time in yyyy-MM-dd HH:mm:ss format, UTC+08:00. |
Successful response example
This example uses limit=1 with another batch available. <NEXT_CURSOR> represents the cursor returned by the API.
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"environment_name": "QA Workspace",
"serial_num": 42,
"remark": "Transfer to the QA team",
"transfer_team_id": "100200",
"transfer_email": "qa@example.com",
"transfer_info": [
"NAME",
"REMARK"
],
"create_by_name": "Alex",
"create_time": "2026-10-12 09:45:00"
}
],
"total": 2,
"summary": null
},
"next": "<NEXT_CURSOR>"
}
Common errors
| HTTP status | Business code | Meaning and action |
|---|---|---|
200 | 400003 | Access denied. Check that the key is valid. If the key has an IP restriction, confirm that your IP is allowed. |
400 or 200 | 400009 | Invalid parameter. Check the filters, pagination mode, and allowed ranges. If the cursor is invalid, omit cursor to start again at the first batch. |
429 | 400010 | Too many requests. Wait at least one second before retrying. |
200 | 500000 | The request could not be completed. Try again later. |
Error response example
Sending both page and limit returns HTTP 200 with the following body.
{
"code": 400009,
"msg": "page/page_size and cursor/limit cannot be used together",
"data": null,
"next": null
}