Skip to content
Home » DICloak Member Logs HTTP API Integration Guide

DICloak Member Logs HTTP API Integration Guide

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-KEY header. Responses are JSON with snake_case field names.
  • Check the response code for the result. A value of 0 means success. HTTP 200 can also carry an API error.
  • The cURL examples use Bash syntax. Replace the key and cursor placeholders with actual values.

2. Endpoint directory

SectionMethodPathPurpose
3GET/v1/api/request/log/operationQuery member operation logs
4GET/v1/api/request/log/loginQuery login logs
5GET/v1/api/request/log/browser_historyQuery browsing history
6GET/v1/api/request/log/environment_shareQuery profile sharing records
7GET/v1/api/request/log/environment_transferQuery 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

HeaderTypeRequiredDescription
X-HTTP-KEYstringYesHTTP 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.

ParameterTypeRequiredDescription
pageintegerNoPage number. Defaults to 1. Minimum 1. Applies to page-number pagination.
page_sizeintegerNoRecords per page. Defaults to 100. Range 1–100. Applies to page-number pagination.
limitintegerNoRecords per cursor batch. Defaults to 100. Range 1–100. Send limit to start at the first batch.
cursorstringNoTop-level next value from the preceding batch. Omit it for the first batch.
member_idstringNoExact ID of the team member who performed the action.
business_typestringNoExact business category, such as ENV or MEMBER. See Filter values.
operation_typestringNoExact operation type, such as CREATE_ENV or EDIT_MEMBER. See Filter values.
valuestringNoText to search for in the operation details.
start_create_timestringNoEarliest operation time, inclusive. Use yyyy-MM-dd HH:mm:ss.
end_create_timestringNoLatest operation time, inclusive. Use a full timestamp in yyyy-MM-dd HH:mm:ss format.
device_namestringNoText contained in the device name.
ipstringNoText contained in the recorded IP address.
countrystringNoFilter 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 nonempty cursor, or both. To retrieve the next batch, pass next unchanged as cursor and keep the same filters. A null value for next ends the cursor query.
  • Use one mode per request. Mixing page or page_size with limit or cursor returns 400009.
  • Time filters use UTC+08:00. To include a whole day, use 23:59:59 on 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

FieldTypeDescription
codeinteger0 means success. Other values indicate a failed request.
msgstringResult or error message.
dataobject/nullPaginated result on success. May be null on failure.
data.listarrayOperation logs returned by this request. An empty result is [].
data.totalintegerTotal records that match the filters, independent of the current page or cursor position.
data.summarynullAlways null.
nextstring/nullCursor for the next batch. null in page-number mode or when there are no more batches.
data.list[].create_timestringOperation time in yyyy-MM-dd HH:mm:ss format, UTC+08:00.
data.list[].operation_typestringOperation code. Uses the same values as the operation_type query parameter.
data.list[].operation_objectsarray of stringsDisplay text for the items affected by the operation, in the order shown in DICloak. Returns [] if there are none.
data.list[].member_namestring/nullMember display name recorded for the operation.
data.list[].ipstring/nullRecorded IP address.
data.list[].ip_infoobject/nullCountry information for the IP address. null when unavailable.
data.list[].ip_info.country_codestring/nullCountry code.
data.list[].ip_info.countrystring/nullCountry name.
data.list[].device_namestring/nullDevice 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 statusBusiness codeMeaning and action
200400003Access denied. Check that the key is valid. If the key has an IP restriction, confirm that your IP is allowed.
400 or 200400009Invalid parameter. Check the filters, pagination mode, and allowed ranges. If the cursor is invalid, omit cursor to start again at the first batch.
429400010Too many requests. Wait at least one second before retrying.
200500000The 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_typeMeaning
CREATE_ENVCreate a browser profile.
OPEN_ENVOpen a browser profile.
CLOSE_ENVClose a browser profile session.
TRANSFER_ENVTransfer a browser profile to another team.
CLEAR_CACHEClear the cache for a browser profile.
DELETE_ENVMove a browser profile to the Recycle Bin.
THOROUGH_DELETE_ENVPermanently delete a browser profile from the Recycle Bin.
RECOVERY_ENVRestore a browser profile from the Recycle Bin.
CLONE_ENVCreate a new browser profile by cloning an existing one.
SHARE_ENVShare a browser profile with another team.
EDIT_ENVEdit the settings of an existing browser profile.
EXPORT_ENVExport browser profile data.
UPDATE_ENVChange browser profile settings using the batch update feature.
COMMAND_CLOSE_ENVClose a browser profile on all devices.
ENV_CUSTOM_NUMBERChange the custom number of a browser profile.
CANCEL_SHARE_ENVCancel an existing browser profile share.
Profile groups
operation_typeMeaning
SET_ENV_GROUPSet the group assignments for browser profiles.
CREATE_ENV_GROUPCreate a browser profile group.
EDIT_ENV_GROUPEdit the settings of an existing browser profile group.
DELETE_ENV_GROUPDelete a browser profile group.
Proxies
operation_typeMeaning
CREATE_PROXYAdd a proxy configuration.
EDIT_PROXYEdit an existing proxy configuration.
DELETE_PROXYDelete a proxy configuration.
EXPORT_PROXYExport proxy data.
BATCH_UPDATE_PROXYChange proxy configurations using the batch update feature.
Members
operation_typeMeaning
CREATE_MEMBERCreate a member in the team.
EDIT_MEMBEREdit an existing team member’s information or settings.
DELETE_MEMBERRemove a member from the team.
EXPORT_MEMBERExport team member data.
ACTIVEATE_MEMBERActivate or re-enable a team member account.
Member groups
operation_typeMeaning
CREATE_MEMBER_GROUPCreate a team member group.
EDIT_MEMBER_GROUPEdit the settings of an existing team member group.
DELETE_MEMBER_GROUPDelete a team member group.
Profile tags
operation_typeMeaning
CREATE_ENV_TAGCreate a tag for labeling browser profiles.
EDIT_ENV_TAGEdit an existing browser profile tag.
DELETE_ENV_TAGDelete a browser profile tag.
Extensions
operation_typeMeaning
CREATE_EXTENSIONAdd an extension to DICloak.
ENABLE_EXTENSIONEnable an extension that has been added.
STOP_EXTENSIONDisable an extension that has been added.
EDIT_EXTENSIONEdit an existing extension’s settings.
UPGRADE_EXTENSIONUpdate an extension to a different version.
DELETE_EXTENSIONRemove an extension from DICloak.
Profile sync
operation_typeMeaning
OPEN_ENV_SYNCStart synchronizing actions across browser windows.
CLOSE_ENV_SYNCStop synchronizing actions across browser windows.
RPA tasks
operation_typeMeaning
CREATE_RPA_TASKCreate an RPA automation task.
EDIT_RPA_TASKEdit the settings of an existing RPA task.
RUN_RPA_TASKStart an RPA task run.
Member API
operation_typeMeaning
CREATE_MEMBER_APICreate an API link for member management.
EDIT_MEMBER_APIEdit the settings of an existing member management API link.
DELETE_MEMBER_APIDelete a member management API link.
AI Spider
operation_typeMeaning
RUN_TASK_AI_SPIDERRun an AI Spider task.
DOWNLOAD_AI_SPIDERDownload data collected by an AI Spider task.
Open API
operation_typeMeaning
CREATE_KEY_OPEN_APIGenerate an API key.
RESET_KEY_OPEN_APIReset an existing API key.
EDIT_PORT_OPEN_APIChange 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

HeaderTypeRequiredDescription
X-HTTP-KEYstringYesHTTP 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.

ParameterTypeRequiredDescription
pageintegerNoPage number. Defaults to 1. Minimum 1. Applies to page-number pagination.
page_sizeintegerNoRecords per page. Defaults to 100. Range 1–100. Applies to page-number pagination.
limitintegerNoRecords per cursor batch. Defaults to 100. Range 1–100. Send limit to start at the first batch.
cursorstringNoTop-level next value from the preceding batch. Omit it for the first batch.
member_idstringNoExact team member ID.
typestringNoENTER_ORG means enter the team. EXIT_ORG means exit the team.
start_create_timestringNoEarliest login event time, inclusive. Use yyyy-MM-dd HH:mm:ss.
end_create_timestringNoLatest login event time, inclusive. A date-only value includes the full day.
device_namestringNoText contained in the device name.
ipstringNoText contained in the recorded IP address.
countrystringNoFilter 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 nonempty cursor, or both. Pass next unchanged as cursor and keep the same filters. A null value for next ends 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

FieldTypeDescription
codeinteger0 means success. Other values indicate a failed request.
msgstringResult or error message.
dataobject/nullPaginated result on success. May be null on failure.
data.listarrayOperation logs returned by this request. An empty result is [].
data.totalintegerTotal records that match the filters, independent of the current page or cursor position.
data.summarynullAlways null.
nextstring/nullCursor for the next batch. null in page-number mode or when there are no more batches.
data.list[].create_timestringLogin event time in yyyy-MM-dd HH:mm:ss format, UTC+08:00.
data.list[].typestringENTER_ORG or EXIT_ORG.
data.list[].member_namestring/nullMember display name.
data.list[].ipstring/nullRecorded IP address.
data.list[].ip_infoobject/nullCountry information for the IP address. null when unavailable.
data.list[].ip_info.country_codestring/nullCountry code.
data.list[].ip_info.countrystring/nullCountry name.
data.list[].device_namestring/nullDevice name.
data.list[].osstring/nullRecorded device operating system.
data.list[].app_versionstring/nullDICloak 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 statusBusiness codeMeaning and action
200400003Access denied. Check that the key is valid. If the key has an IP restriction, confirm that your IP is allowed.
400 or 200400009Invalid parameter. Check the filters, pagination mode, and allowed ranges. If the cursor is invalid, omit cursor to start again at the first batch.
429400010Too many requests. Wait at least one second before retrying.
200500000The 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

HeaderTypeRequiredDescription
X-HTTP-KEYstringYesHTTP 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.

ParameterTypeRequiredDescription
pageintegerNoPage number. Defaults to 1. Minimum 1. Applies to page-number pagination.
page_sizeintegerNoRecords per page. Defaults to 100. Range 1–100. Applies to page-number pagination.
limitintegerNoRecords per cursor batch. Defaults to 100. Range 1–100. Send limit to start at the first batch.
cursorstringNoTop-level next value from the preceding batch. Omit it for the first batch.
member_idstringNoExact team member ID.
env_idstringNoExact profile ID. Use the ID returned by the profiles API.
keywordstringNoText contained in either the page title or full URL.
start_create_timestringNoEarliest visit time, inclusive. Use yyyy-MM-dd HH:mm:ss.
end_create_timestringNoLatest visit time, inclusive. A date-only value includes the full day.
device_namestringNoText contained in the device name.
ipstringNoText contained in the recorded IP address.
countrystringNoFilter 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 nonempty cursor, or both. Pass next unchanged as cursor and keep the same filters. A null value for next ends 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

FieldTypeDescription
codeinteger0 means success. Other values indicate a failed request.
msgstringResult or error message.
dataobject/nullPaginated result on success. May be null on failure.
data.listarrayOperation logs returned by this request. An empty result is [].
data.totalintegerTotal records that match the filters, independent of the current page or cursor position.
data.summarynullAlways null.
nextstring/nullCursor for the next batch. null in page-number mode or when there are no more batches.
data.list[].timestringWebsite visit time in yyyy-MM-dd HH:mm:ss format, UTC+08:00.
data.list[].titlestring/nullFull page title.
data.list[].urlstring/nullFull URL recorded for the visit.
data.list[].env_namestring/nullBrowser profile name.
data.list[].serial_numinteger/nullProfile number displayed in DICloak.
data.list[].member_namestring/nullMember display name.
data.list[].ipstring/nullRecorded IP address.
data.list[].ip_infoobject/nullCountry information for the IP address. null when unavailable.
data.list[].ip_info.country_codestring/nullCountry code.
data.list[].ip_info.countrystring/nullCountry name.
data.list[].device_namestring/nullDevice 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 statusBusiness codeMeaning and action
200400003Access denied. Check that the key is valid. If the key has an IP restriction, confirm that your IP is allowed.
400 or 200400009Invalid parameter. Check the filters, pagination mode, and allowed ranges. If the cursor is invalid, omit cursor to start again at the first batch.
429400010Too many requests. Wait at least one second before retrying.
200500000The 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

HeaderTypeRequiredDescription
X-HTTP-KEYstringYesHTTP 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.

ParameterTypeRequiredDescription
pageintegerNoPage number. Defaults to 1. Minimum 1. Applies to page-number pagination.
page_sizeintegerNoRecords per page. Defaults to 100. Range 1–100. Applies to page-number pagination.
limitintegerNoRecords per cursor batch. Defaults to 100. Range 1–100. Send limit to start at the first batch.
cursorstringNoTop-level next value from the preceding batch. Omit it for the first batch.
env_idstringNoExact profile ID. Use the ID returned by the profiles API.
share_statusbooleanNotrue for active shares or false for canceled shares. Omit it to include both.
team_idstringNoMatch a target team number or text in the share destination, such as part of the recipient email.
create_by_idstringNoExact ID of the member who created the share.
remarkstringNoText contained in the sharing note.
start_create_timestringNoEarliest share creation time, inclusive. Use yyyy-MM-dd HH:mm:ss.
end_create_timestringNoLatest 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 nonempty cursor, or both. Pass next unchanged as cursor and keep the same filters. A null value for next ends 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:59 on 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

FieldTypeDescription
codeinteger0 means success. Other values indicate a failed request.
msgstringResult or error message.
dataobject/nullPaginated result on success. May be null on failure.
data.listarrayOperation logs returned by this request. An empty result is [].
data.totalintegerTotal records that match the filters, independent of the current page or cursor position.
data.summarynullAlways null.
nextstring/nullCursor for the next batch. null in page-number mode or when there are no more batches.
data.list[].environment_namestring/nullShared profile name.
data.list[].serial_numinteger/nullProfile number displayed in DICloak.
data.list[].remarkstring/nullSharing note.
data.list[].share_team_idstring/nullTarget team number.
data.list[].share_emailstring/nullRecipient email, when available.
data.list[].share_env_typesarray of stringsSharing permissions. OPEN allows opening the profile, and EDIT allows editing it.
data.list[].create_by_namestring/nullDisplay name of the member who created the share.
data.list[].create_timestringShare creation time in yyyy-MM-dd HH:mm:ss format, UTC+08:00.
data.list[].share_statusbooleantrue 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 statusBusiness codeMeaning and action
200400003Access denied. Check that the key is valid. If the key has an IP restriction, confirm that your IP is allowed.
400 or 200400009Invalid parameter. Check the filters, pagination mode, and allowed ranges. If the cursor is invalid, omit cursor to start again at the first batch.
429400010Too many requests. Wait at least one second before retrying.
200500000The 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

HeaderTypeRequiredDescription
X-HTTP-KEYstringYesHTTP 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.

ParameterTypeRequiredDescription
pageintegerNoPage number. Defaults to 1. Minimum 1. Applies to page-number pagination.
page_sizeintegerNoRecords per page. Defaults to 100. Range 1–100. Applies to page-number pagination.
limitintegerNoRecords per cursor batch. Defaults to 100. Range 1–100. Send limit to start at the first batch.
cursorstringNoTop-level next value from the preceding batch. Omit it for the first batch.
serial_numintegerNoExact profile number displayed in DICloak.
team_idstringNoExact transfer destination. An email address matches the recipient email. Other values match the target team number.
create_by_idstringNoExact ID of the member who initiated the transfer.
remarkstringNoText contained in the transfer note.
start_create_timestringNoEarliest transfer time, inclusive. Use yyyy-MM-dd HH:mm:ss.
end_create_timestringNoLatest 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 nonempty cursor, or both. Pass next unchanged as cursor and keep the same filters. A null value for next ends 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:59 on 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

FieldTypeDescription
codeinteger0 means success. Other values indicate a failed request.
msgstringResult or error message.
dataobject/nullPaginated result on success. May be null on failure.
data.listarrayOperation logs returned by this request. An empty result is [].
data.totalintegerTotal records that match the filters, independent of the current page or cursor position.
data.summarynullAlways null.
nextstring/nullCursor for the next batch. null in page-number mode or when there are no more batches.
data.list[].environment_namestring/nullTransferred profile name.
data.list[].serial_numinteger/nullProfile number displayed in DICloak.
data.list[].remarkstring/nullTransfer note.
data.list[].transfer_team_idstring/nullTarget team number.
data.list[].transfer_emailstring/nullRecipient email, when available.
data.list[].transfer_infoarray of stringsAdditional information included in the transfer. NAME includes the profile name, REMARK includes the remark, and PROXY includes proxy information.
data.list[].create_by_namestring/nullDisplay name of the member who initiated the transfer.
data.list[].create_timestringTransfer 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 statusBusiness codeMeaning and action
200400003Access denied. Check that the key is valid. If the key has an IP restriction, confirm that your IP is allowed.
400 or 200400009Invalid parameter. Check the filters, pagination mode, and allowed ranges. If the cursor is invalid, omit cursor to start again at the first batch.
429400010Too many requests. Wait at least one second before retrying.
200500000The 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
}