Can we set the Automate Connector via API?

How to Connect Chef Automate to Chef 360 Platform via the Automate Connector using API

Overview

The Automate Connector allows you to configure Chef Automate integration on the Chef 360 Platform using its REST API, enabling the platform to forward node telemetry and compliance data directly to a Chef Automate instance for centralized reporting and analysis. Configuration is handled entirely through the Chef 360 API and CLI, with no manual UI setup required once authentication is enabled.

Prerequisites - Before You Begin

Make sure you have the following ready before starting:

Reference - https://docs.chef.io/360/1.7/chef_360_ui/connector/automate_connector/#before-you-begin

Configure the Automate Connector via API

Step 1: Enable API Token Authentication

Before you can create or use API tokens, this authentication method must be explicitly enabled in the Admin Console.

1. Log in to the Chef 360 Admin Console.
2. Navigate to Settings > Authentication.
3. Enable API Token as an authentication method.

Important: API token authentication must be enabled before you can create or use API tokens.

This is a one-time setup step per tenant - you won't need to repeat it for future tokens.

Step 2: Register a Device

Register your local machine with the Chef 360 server so it can be linked to your account.

Run

chef-platform-auth-cli register-device \
  --profile-name <profile-name> \
  -i \
  --url https://<server>:<port>; \
  --device-name '<device-name>'

The command returns a Device ID, Device Name, and an OAuth Code, similar to:

Device Id :  d0:c1:b5:21:a2:88-xxxxxx-chef-platform-system-cli
Device Name :  bs_mac
OAuth Code : OZIvMpJpPX

Open your browser, complete the device-linking flow, and enter the OAuth Code when prompted to finish linking the device to your Chef 360 account.

Step 3: Create an API Token

Run the following command to create a tenant-admin scoped API token:

chef-platform-auth-cli user-account self create-token \
  --body '{"expiration": "<ISO8601-datetime>", "name": "<token-name>"}' \
  --profile <profile-name>

The response returns your API credentials:

{
  "item": {
    "accessKey": "<ACCESS_KEY>",
    "expiration": "2026-08-12T15:04:05Z",
    "id": "<token-id>",
    "name": "test-token-name",
    "role": {
      "id": "<role-id>",
      "name": "tenant-admin"
    },
    "secretKey": "<SECRET_KEY>"
  }
}

Save both credentials - you'll need them in Step 5:

Important: The secretKey is displayed only once at creation time and cannot be retrieved later. Store it securely (e.g., in a secrets manager) before closing your terminal.

Step 4: Retrieve the Tenant ID

1. Run the following command to fetch your organization details:

chef-platform-auth-cli user-account self get-organization --profile <profile-name>

2. Locate and copy the tenantId from the response:

{
  "item": {
    "description": "",
    "name": "chef-org",
    "orgId": "<org-id>",
    "status": "enabled",
    "tenantId": "<tenant-id>"
  }
}
 

curl -k -X PUT \
  "https://<server>:<port>/platform/system/v1/tenant/<tenant-id>/automate-connector"" \
  -H "api-key: <ACCESS_KEY>" \
  -H "api-secret: <SECRET_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "dataCollectorUrl": "https://<automate-host>/data-collector/v0/"",
    "isInsecure": true,
    "token": "<automate-data-collector-token>"
  }'