List of API functions

The following table shows a list of supported API functions. The API functions are described in an alphabetical order.

API URL	Method	See	Role¹
/api/v1/activation-key	GET	Acquire an activation key	ADMIN
/api/v1/activation-key	PUT	Enable and disable activation whitelist function	ADMIN
/api/v1/activation-whitelist	GET	Acquire a list of whitelist entries	ADMIN
/api/v1/activation-whitelist	POST	Register a whitelist entry	ADMIN
/api/v1/activation-whitelist/activationWhiteListId	DELETE	Delete a whitelist entry	ADMIN
/api/v1/agents	GET	Acquire a list of Agent instances
/api/v1/agents/agentId	GET	Acquire Agent instance details
	PUT	Change status of an Agent instance ²
	PUT	Change operation settings for an Agent instance ²
	PUT	Change unit ²
	PUT	Change profile ²
	PUT	Change a module version ²
	DELETE	Delete an Agent instance
/api/v1/agents/agentId/queues/receiving	GET	Acquire a list of receive tasks
/api/v1/agents/agentId/queues/receiving/receivingTaskId	DELETE	Delete a receive task
/api/v1/device-access-logs	GET	Acquire a list of Access Logs
/api/v1/distributionModules	POST	Distribute a file
/api/v1/genkey	POST	Reacquire an API key
/api/v1/license	GET	Acquire product information	ADMIN
/api/v1/license	PUT	Update product key	ADMIN
/api/v1/license-option	GET	Acquire license option information
/api/v1/login	POST	Acquire an API key
/api/v1/modules	GET	Acquire a list of update modules
/api/v1/modules	POST	Register an update module
/api/v1/modules/moduleId	DELETE	Delete an update module
/api/v1/profiles	GET	Acquire a list of Profiles
/api/v1/profiles/profileId	GET	Acquire profile details
	PUT	Modify profile details
	DELETE	Delete profile
/api/v1/profiles/profileId/receiving-profiles	GET	Acquire a list of reception settings
/api/v1/profiles/profileId/receiving-profiles	POST	Create reception settings
/api/v1/profiles/profileId/sending-profiles	GET	Acquire a list of transfer settings
/api/v1/profiles/profileId/sending-profiles	POST	Create transfer settings
/api/v1/receiving-logs	GET	Acquire a list of Receive Logs
/api/v1/receiving-logs/receivingLogId	GET	Acquire Receive Log details
/api/v1/receiving-profiles/receivingProfileId	GET	Acquire reception settings details
	PUT	Modify reception settings details
	DELETE	Delete reception settings
/api/v1/sending-profiles/sendingProfileId	GET	Acquire transfer settings details
	PUT	Modify transfer settings details
	DELETE	Delete transfer settings
/api/v1/system-settings	GET	Acquire system settings (logs)	ADMIN
/api/v1/system-settings	PUT	Modify system settings (logs)	ADMIN
/api/v1/system-settings/notifications	GET	Acquire system settings (notifications)	ADMIN
/api/v1/system-settings/notifications	PUT	Modify system settings (notifications)	ADMIN
/api/v1/system-settings/notifications/test-email	POST	Send a test mail	ADMIN
/api/v1/trace-logs	GET	Acquire a list of Trace Logs
/api/v1/trace-logs/traceLogUniqueId	GET	Acquire Trace Log details
/api/v1/transfer-logs	GET	Acquire a list of Transfer Logs
/api/v1/transfer-logs/transferLogId	GET	Acquire Transfer Log details
/api/v1/transfer-states	GET	Acquire a list of transfer states
/api/v1/units	GET	Acquire a list of units
/api/v1/units	POST	Create unit
/api/v1/units/unitId	GET	Acquire unit details
	PUT	Modify unit details
	DELETE	Delete unit
/api/v1/units/unitId/profiles	POST	Create profile
/api/v1/user	GET	Acquire a list of users	ADMIN
/api/v1/user	POST	Create user	ADMIN
/api/v1/user/userId	GET	Acquire user details
	PUT	Modify user details ³	ADMIN
	PUT	Change a user password ³	⁴ADMIN
	DELETE	Delete user	ADMIN
/api/v1/user/userId/unit	GET	Acquire a list of managed units	ADMIN
/api/v1/user/userId/unit	POST	Attach unit to be managed	ADMIN
/api/v1/user/userId/unit/unitId	DELETE	Detach managed unit	ADMIN
/api/v1/user-role	GET	Acquire a list of roles	ADMIN
/api/v1/version	GET	Acquire version information

If the "Role" is blank, administrators and general users can execute the API functions.

If the "Role" is "ADMIN", only administrators can execute the API functions.

The following set of API functions is actually the same. (/api/v1/agents/agentId)

Change a status of an Agent instance
Change Agent operation settings
Change Unit
Change Profile
Change a module version

In this manual, to write each API separately for individual purposes, the request parameters are changed according to the purposes.

The following set of API functions is actually the same. (/api/v1/user/userId)

Modify User details
Change a user password

In this manual, to write each API separately for individual purposes, the request parameters are changed according to the purposes.

If the role is "ADMIN" (administrators), you can change the password of others.

If the role is "USER" (general users), you can change your own password only.