Preview deployment targets

POST

/api/v1/deployments/preview-targets

const url = 'http://localhost:3000/api/v1/deployments/preview-targets';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'},
  body: '{"deviceIds":["example"],"deviceGroupIds":["example"],"deviceSelector":{},"limit":500}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/v1/deployments/preview-targets \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "deviceIds": [ "example" ], "deviceGroupIds": [ "example" ], "deviceSelector": {}, "limit": 500 }'

Returns the unique device set, with provenance, that a create with the same target inputs would materialize. Reads live group membership.

Authorizations

api-key
bearer

Parameters

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Request Body^required

application/json

object

deviceIds

Devices selected directly

Array<string>

deviceGroupIds

Device groups to target

Array<string>

deviceSelector

Label selector (matchLabels / matchExpressions)

object

key

additional properties

any

limit

Maximum number of devices listed

number

default: 500

Responses

200

Resolved targets

400

Invalid body or unknown device group

403

Forbidden — caller lacks required permission