Jamf Protect API — Mutations
Create, update, and delete data in Jamf Protect.
Mutations create, update, or delete data in Jamf Protect.
12 mutations available. Return and argument types link to the Types reference.
Type notation:[X]is a list ofX;!means non-null (required). For example,[Alert!]!is a required list of non-nullAlertobjects.
createPreventList
Create a new Custom Prevent List
createPreventList(input: PreventListInput!): PreventList| Argument | Type | Description |
|---|---|---|
input | PreventListInput! | Input object holding the query criteria (filters, paging, sorting) or the values to write. |
Returns: PreventList
createUnifiedLoggingFilter
Create a new Unified Logging filter
createUnifiedLoggingFilter(input: UnifiedLoggingFilterInput!): UnifiedLoggingFilter| Argument | Type | Description |
|---|---|---|
input | UnifiedLoggingFilterInput! | Input object holding the query criteria (filters, paging, sorting) or the values to write. |
Returns: UnifiedLoggingFilter
deleteComputer
Delete the record of a specific Computer, and associated Alerts
deleteComputer(uuid: ID!): Computer| Argument | Type | Description |
|---|---|---|
uuid | ID! | The unique identifier (UUID) of the record to act on. |
Returns: Computer
deletePreventList
Delete a specific Custom prevent List
deletePreventList(id: ID!): PreventList| Argument | Type | Description |
|---|---|---|
id | ID! | The unique identifier of the record to act on. |
Returns: PreventList
deleteUnifiedLoggingFilter
Delete a specific Unified Logging filter
deleteUnifiedLoggingFilter(uuid: ID!): UnifiedLoggingFilter| Argument | Type | Description |
|---|---|---|
uuid | ID! | The unique identifier (UUID) of the record to act on. |
Returns: UnifiedLoggingFilter
deleteUser
Delete a specific User
deleteUser(id: ID!): User| Argument | Type | Description |
|---|---|---|
id | ID! | The unique identifier of the record to act on. |
Returns: User
setComputerPlan
Assign a Plan a specific Computer, to be applied at the next agent check-in
setComputerPlan(input: ComputerPlan!, uuid: ID!): Computer| Argument | Type | Description |
|---|---|---|
input | ComputerPlan! | Input object holding the query criteria (filters, paging, sorting) or the values to write. |
uuid | ID! | The unique identifier (UUID) of the record to act on. |
Returns: Computer
updateAlerts
Update the alert status for a list of alerts
updateAlerts(input: AlertUpdateInput!): AlertConnection| Argument | Type | Description |
|---|---|---|
input | AlertUpdateInput! | Input object holding the query criteria (filters, paging, sorting) or the values to write. |
Returns: AlertConnection
updateAnalyticSet
Update Analytic Sets and all associated plans
updateAnalyticSet(uuid: ID!, input: AnalyticSetInput!): AnalyticSet| Argument | Type | Description |
|---|---|---|
uuid | ID! | The unique identifier (UUID) of the record to act on. |
input | AnalyticSetInput! | Input object holding the query criteria (filters, paging, sorting) or the values to write. |
Returns: AnalyticSet
updateComputer
Allow updating of certain computer fields - labels and tags
updateComputer(input: ComputerEditableInput!, uuid: ID!): Computer| Argument | Type | Description |
|---|---|---|
input | ComputerEditableInput! | Input object holding the query criteria (filters, paging, sorting) or the values to write. |
uuid | ID! | The unique identifier (UUID) of the record to act on. |
Returns: Computer
updatePreventList
Update an existing Custom Prevent List
updatePreventList(input: PreventListInput!, id: ID!): PreventList| Argument | Type | Description |
|---|---|---|
input | PreventListInput! | Input object holding the query criteria (filters, paging, sorting) or the values to write. |
id | ID! | The unique identifier of the record to act on. |
Returns: PreventList
updateUnifiedLoggingFilter
Update an existing Unified Log filter
updateUnifiedLoggingFilter(uuid: ID!, input: UnifiedLoggingFilterInput!): UnifiedLoggingFilter| Argument | Type | Description |
|---|---|---|
uuid | ID! | The unique identifier (UUID) of the record to act on. |
input | UnifiedLoggingFilterInput! | Input object holding the query criteria (filters, paging, sorting) or the values to write. |
Returns: UnifiedLoggingFilter
Jamf Protect API: Overview · Queries · Mutations · Types · Example Calls · Schema (SDL)
Updated 17 days ago