Home / Knox Configure /

Get started

Last updated August 5th, 2025

Before accessing the Knox Configure API, you must first set up authentication. This guide provides step-by-step instructions on how to use the Knox Configure API.

Knox Configure is available in two API versions:

The Device APIs (Get devices, Get device logs, Send command, and Delete device) in Knox Configure support both the authentication types—legacy authentication and Knox OAuth 2.0 Authentication.

We suggest to use OAuth 2.0 authentication for the Device APIs in Knox Configure.

Step 1- Sign up for Knox Configure in your Samsung Knox account

  1. Register for a Samsung Knox account.
  2. Log in to your account and apply for the Knox Configure service from the overview page. For additional information, see the Knox Configure Admin Guide.

On this tab

Step 2- Request access to the Knox cloud services API

Apply for Knox cloud services API access by sending an email to knoxapi@samsungknox.com with your user and tenant information. You can also create a Support ticket.

Step 3- Generate your Client Identifier and key pair to create your access token

  1. Download your unique key pair and Client Identifier from the Knox Cloud APIs portal. For security purposes, you can restrict your Client Identifier to certain IP addresses. The Client Identifier can be re-generated through the console, but must be bound to the downloaded certificate, as described in the Knox Cloud APIs integration guide.

  2. Call the access token REST API to generate your x-knox-apitoken.

For security reasons, the access token has an expiry of 30 minutes. Regenerate as specified in the Knox Cloud APIs integration guide.

Step 4- Call a Knox Configure API endpoint to test your access token

Ensure that your access token is correctly configured by making a test call to any of the Knox Configure API endpoints, such as ‘Get devices’. See Knox Configure API for more details.

curl --location 'https://us-kcs-api.samsungknox.com/kcs/v1/kc/devices' \
     --header 'x-knox-apitoken: <TOKEN_VALUE>'

On this tab

Step 2- Request access to the Cloud Apps feature

To request access to the Cloud Apps menu on the navigation pane of Knox Developer Portal, send an email to knoxapi@samsungknox.com with subject ‘Cloud Apps feature’. Include the following details in your email:

  • Company name
  • Country
  • Email address associated with your Samsung Knox account.
  • List of Knox cloud services APIs you want to use.
  • Description of your use cases.

If you experience any issues, you can create a Support ticket.

Step 3- Generate your access token

After you get access to the Cloud Apps feature:

  1. Go to the Knox Developer Portal.

  2. Register your app to get its client ID and client secret.

  3. Generate an access token using the client ID and client secret. This access token is sent in the header of the Knox Configure API request.

Step 4- Call a Knox Configure API endpoint to test your access token by calling

Ensure that your access token is correctly configured by making a test call to any of the Knox Configure API endpoints, such as ‘Get devices’. See Knox Configure API for more details.

curl --location 'https://api.samsungknox.com/kc/v2/devices/getDevices' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <TOKEN_VALUE>' \
     --data '{
         "pageNum": 0,
         "pageSize": 1,
         "deviceIds": [],
         "profileIds": [],
         "sortBy": "updateTime",
         "sortOrder": "descending",
         "deviceState": []
     }
     '

On this page

Is this page helpful?