(computers)
- createComputerById - Creates a computer
- deleteComputerById - Deletes a computer by ID
- deleteComputerByMacAddress - Deletes a computer by MAC address
- deleteComputerByName - Deletes a computer by name
- deleteComputerBySerialNumber - Deletes a computer by serial number
- deleteComputerByUDID - Deletes a computer by UDID
- findComputers - Finds all computers
- findComputersBasic - Finds basic information for all computers
- findComputersById - Finds computers by ID
- findComputersByIdSubset - Finds a subset of information for a computer
- findComputersByMacAddress - Finds computers by MAC address
- findComputersByMacAddressSubset - Finds a subset of data for computers by MAC address
- findComputersByName - Finds the first computer with the given name
- findComputersByNameSubset - Finds a subset of data for the first computer with the given name
- findComputersBySerialNumber - Finds computers by serial number
- findComputersBySerialNumberSubset - Finds a subset of data for computers by serial number
- findComputersByUDID - Finds computers by UDID
- findComputersByUDIDSubset - Finds a subset of data for computers by UDID
- flushComputerExtenstionAttributeData - Deletes data collected by an extension attribute
- matchComputers - Searches for computers that match the provided parameter
- matchComputersNames - Searches for computers that match the provided name parameter
- updateComputerById - Updates an existing computer by ID
- updateComputerByMacAddress - Updates an existing computer by MAC address
- updateComputerByName - Updates an existing computer by name
- updateComputerBySerialNumber - Updates an existing computer by serial number
- updateComputerByUDID - Updates an existing computer by UDID
Certificates and mdm_capable are ignored.
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.createComputerById({
id: 117029,
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.CreateComputerByIdRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.CreateComputerByIdResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Deletes a computer by ID
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.deleteComputerById({
id: 361320,
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.DeleteComputerByIdRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.DeleteComputerByIdResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Deletes a computer by MAC address
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.deleteComputerByMacAddress({
macaddress: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.DeleteComputerByMacAddressRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.DeleteComputerByMacAddressResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Deletes a computer by name
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.deleteComputerByName({
name: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.DeleteComputerByNameRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.DeleteComputerByNameResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Deletes a computer by serial number
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.deleteComputerBySerialNumber({
serialnumber: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.DeleteComputerBySerialNumberRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.DeleteComputerBySerialNumberResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Deletes a computer by UDID
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.deleteComputerByUDID({
udid: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.DeleteComputerByUDIDRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.DeleteComputerByUDIDResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Finds all computers
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.findComputers();
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FindComputersResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Finds basic information for all computers
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.findComputersBasic();
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FindComputersBasicResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Finds computers by ID
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.findComputersById({
id: 962919,
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.FindComputersByIdRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FindComputersByIdResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Subset values can also be appended using an ampersand to return multiple subsets (e.g. /subsets/General&Location)
import { Jamf } from "jamf-classic-sdk-nodejs";
import { FindComputersByIdSubsetPathParamSubset } from "jamf-classic-sdk-nodejs/dist/sdk/models/operations";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.findComputersByIdSubset({
id: 130265,
subset: FindComputersByIdSubsetPathParamSubset.Peripherals,
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.FindComputersByIdSubsetRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FindComputersByIdSubsetResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Finds computers by MAC address
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.findComputersByMacAddress({
macaddress: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.FindComputersByMacAddressRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FindComputersByMacAddressResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Subset values can also be appended using an ampersand to return multiple subsets (e.g. /subsets/General&Hardware)
import { Jamf } from "jamf-classic-sdk-nodejs";
import { FindComputersByMacAddressSubsetPathParamSubset } from "jamf-classic-sdk-nodejs/dist/sdk/models/operations";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.findComputersByMacAddressSubset({
macaddress: "<value>",
subset: FindComputersByMacAddressSubsetPathParamSubset.ConfigurationProfiles,
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.FindComputersByMacAddressSubsetRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FindComputersByMacAddressSubsetResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Finds the first computer with the given name
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.findComputersByName({
name: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.FindComputersByNameRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FindComputersByNameResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Subset values can also be appended using an ampersand to return multiple subsets (e.g. /subsets/General&Hardware)
import { Jamf } from "jamf-classic-sdk-nodejs";
import { FindComputersByNameSubsetPathParamSubset } from "jamf-classic-sdk-nodejs/dist/sdk/models/operations";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.findComputersByNameSubset({
name: "<value>",
subset: FindComputersByNameSubsetPathParamSubset.Location,
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.FindComputersByNameSubsetRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FindComputersByNameSubsetResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Finds computers by serial number
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.findComputersBySerialNumber({
serialnumber: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.FindComputersBySerialNumberRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FindComputersBySerialNumberResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Subset values can also be appended using an ampersand to return multiple subsets (e.g. /subsets/General&Hardware)
import { Jamf } from "jamf-classic-sdk-nodejs";
import { FindComputersBySerialNumberSubsetPathParamSubset } from "jamf-classic-sdk-nodejs/dist/sdk/models/operations";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.findComputersBySerialNumberSubset({
serialnumber: "<value>",
subset: FindComputersBySerialNumberSubsetPathParamSubset.Software,
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.FindComputersBySerialNumberSubsetRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FindComputersBySerialNumberSubsetResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Finds computers by UDID
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.findComputersByUDID({
udid: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.FindComputersByUDIDRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FindComputersByUDIDResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Subset values can also be appended using an ampersand to return multiple subsets (e.g. /subsets/General&Hardware)
import { Jamf } from "jamf-classic-sdk-nodejs";
import { FindComputersByUDIDSubsetPathParamSubset } from "jamf-classic-sdk-nodejs/dist/sdk/models/operations";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.findComputersByUDIDSubset({
subset: FindComputersByUDIDSubsetPathParamSubset.ExtensionAttributes,
udid: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.FindComputersByUDIDSubsetRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FindComputersByUDIDSubsetResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Deletes data collected by an extension attribute
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.flushComputerExtenstionAttributeData({
id: "<id>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.FlushComputerExtenstionAttributeDataRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.FlushComputerExtenstionAttributeDataResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Match performs the same function as a simple search in the GUI.
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.matchComputers({
match: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.MatchComputersRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.MatchComputersResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Searches for computers that match the provided name parameter
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.matchComputersNames({
matchname: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.MatchComputersNamesRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.MatchComputersNamesResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Certificates and mdm_capable are ignored.
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.updateComputerById({
id: 576492,
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.UpdateComputerByIdRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.UpdateComputerByIdResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Certificates and mdm_capable are ignored.
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.updateComputerByMacAddress({
macaddress: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.UpdateComputerByMacAddressRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.UpdateComputerByMacAddressResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Certificates and mdm_capable are ignored.
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.updateComputerByName({
name: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.UpdateComputerByNameRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.UpdateComputerByNameResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Certificates and mdm_capable are ignored.
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.updateComputerBySerialNumber({
serialnumber: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.UpdateComputerBySerialNumberRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.UpdateComputerBySerialNumberResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Certificates and mdm_capable are ignored.
import { Jamf } from "jamf-classic-sdk-nodejs";
async function run() {
const sdk = new Jamf({
security: {
password: "<YOUR_PASSWORD_HERE>",
username: "<YOUR_USERNAME_HERE>",
},
});
const res = await sdk.computers.updateComputerByUDID({
udid: "<value>",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
operations.UpdateComputerByUDIDRequest | ✔️ | The request object to use for the request. |
config |
AxiosRequestConfig | ➖ | Available config options for making requests. |
Promise<operations.UpdateComputerByUDIDResponse>
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |