{ "openapi": "3.0.0", "info": { "title": "Iru Endpoint Management API", "description": "# Welcome to the Iru Endpoint Management API Documentation\n\n**Note:** Kandji is in the process of changing to Iru. Many URLs and notes within this documentation will continue to reference Kandji for some time.\n\nYou can find your API URL in Settings > Access. The API URL will follow the below formats.\n\n- US - `https://SubDomain.api.kandji.io`\n \n- EU - `https://SubDomain.api.eu.kandji.io`\n \n\nFor information on how to obtain an API token, please refer to the Iru docs.\n\n[https://docs.iru.com/](https://docs.iru.com/)\n\n#### Rate Limit\n\nThe Iru Endpoint Management API currently has an API rate limit of 10,000 requests per hour per customer.\n\n#### Request Methods\n\nHTTP request methods supported by the API.\n\n| Method | Definition |\n| --- | --- |\n| GET | The `GET` method requests a representation of the specified resource. |\n| POST | The `POST` method submits an entity to the specified resource. |\n| PATCH | The `PATCH` method applies partial modifications to a resource. |\n| DELETE | The `DELETE` method deletes the specified resource. |\n\n#### Response codes\n\nNot all response codes apply to every endpoint.\n\n| Code | Response |\n| --- | --- |\n| 200 | OK |\n| 201 | Created |\n| 204 | No content |\n| | Typical response when sending the DELETE method. |\n| 400 | Bad Request |\n| | \"Command already running\" - The command may already be running in a _Pending_ state waiting on the device. |\n| | \"Command is not allowed for current device\" - The command may not be compatible with the target device. |\n| | \"JSON parse error - Expecting ',' delimiter: line 3 column 2 (char 65)\" |\n| 401 | Unauthorized |\n| | This error can occur if the token is incorrect, was revoked, or the token has expired. |\n| 403 | Forbidden |\n| | The request was understood but cannot be authorized. |\n| 404 | Not found |\n| | Unable to locate the resource in the Iru tenant. |\n| 415 | Unsupported Media Type |\n| | The request contains a media type which the server or resource does not support. |\n| 500 | Internal server error |\n| 503 | Service unavailable |\n| | This error can occur if a file upload is still being processed via the custom apps API. |\n\n#### Data structure\n\nThe API returns all structured responses in JSON schema format.\n\n#### Examples\n\nCode examples using the API can be found in the Iru Endpoint Management support [GitHub](https://github.com/kandji-inc/support/tree/main/api-tools).", "version": "1.0.0" }, "servers": [ { "url": "https://{subdomain}.api.kandji.io", "description": "US Server", "variables": { "subdomain": { "default": "your-subdomain", "description": "Your Iru Endpoint Management subdomain" } } }, { "url": "https://{subdomain}.api.eu.kandji.io", "description": "EU Server", "variables": { "subdomain": { "default": "your-subdomain", "description": "Your Iru Endpoint Management subdomain" } } } ], "paths": { "/api/v1/audit/events": { "get": { "summary": "List audit events", "description": "This request returns audit log events from the Kandji Activity module.", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "A max upper `limit` is set at 500 records returned per request. Pagination should be used using the cursor in the `next` key to request more results. Additionally, parameter queries can be added to a request to filter the results.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by `occurred_at`, `id` either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": false, "description": "Filter by start date in datetime or year-month-day (2024-11-26) formats", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "description": "Filter by end date in datetime or year-month-day (2024-12-06) formats", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "You can pass the next cursor as a parameter or use the URL in the next key to get the next page of results or to start from where you left off last.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "results": [ { "id": "01JNGZW47KZKPXE1JWCFE4PHDW", "action": "update", "occurred_at": "2025-03-04T16:29:55.253454Z", "actor_id": "cf40d6e7-20cb-4da9-84a1-9ad0b7003ca5", "actor_type": "user", "target_id": "449ec92a-186a-44f2-9421-d5ac6e465eb5", "target_type": "blueprint", "target_component": "library_items", "new_state": { "library_items_added": [ { "id": "c7a5871a-1683-432f-87d4-30bbd404eb85", "name": "GitHub" }, { "id": "6c3c34cf-36c4-4812-bd3f-712d66458c80", "name": "Apple Configurator" } ], "library_items_removed": [], "library_items_scoped": [ { "id": "6c3c34cf-36c4-4812-bd3f-712d66458c80", "name": "Apple Configurator" }, { "id": "c7a5871a-1683-432f-87d4-30bbd404eb85", "name": "GitHub" }, { "id": "1af36ec2-111d-4ec4-bc3b-170facf1408b", "name": "Apple Developer" } ], "name": "demo" }, "metadata": {} }, { "id": "01JNGZWQ7WAN45PVTJ3686TXHT", "action": "create", "occurred_at": "2025-03-04T16:30:14.143192Z", "actor_id": "cf40d6e7-20cb-4da9-84a1-9ad0b7003ca5", "actor_type": "user", "target_id": "2b1fd766-3ba4-49ba-9f88-8219d468b34c", "target_type": "blueprint", "target_component": "", "new_state": { "description": "", "type": "map", "name": "audit_event_test" }, "metadata": { "source_id": null, "source": null } }, { "id": "01JNGZWQ7W0C1TD9MZAP6XSEGH", "action": "update", "occurred_at": "2025-03-04T16:30:14.214831Z", "actor_id": "cf40d6e7-20cb-4da9-84a1-9ad0b7003ca5", "actor_type": "user", "target_id": "2b1fd766-3ba4-49ba-9f88-8219d468b34c", "target_type": "blueprint", "target_component": "parameters", "new_state": { "parameters": [], "name": "audit_event_test" }, "metadata": {} }, { "id": "01JNGZX031XXXWS574PMJE5E52", "action": "update", "occurred_at": "2025-03-04T16:30:23.535596Z", "actor_id": "cf40d6e7-20cb-4da9-84a1-9ad0b7003ca5", "actor_type": "user", "target_id": "2b1fd766-3ba4-49ba-9f88-8219d468b34c", "target_type": "blueprint", "target_component": "library_items", "new_state": { "library_items_added": [ { "id": "d8a6b20f-9b7a-4af7-9ecb-1c7104116ca8", "name": "homebrew" } ], "library_items_removed": [], "library_items_scoped": [ { "id": "d8a6b20f-9b7a-4af7-9ecb-1c7104116ca8", "name": "homebrew" } ], "name": "audit_event_test" }, "metadata": {} }, { "id": "01JNM1393ZTW3JAPWPRTVNH1JM", "action": "update", "occurred_at": "2025-03-05T20:49:01.319307Z", "actor_id": "cf40d6e7-20cb-4da9-84a1-9ad0b7003ca5", "actor_type": "user", "target_id": "07194cf3-10c1-4b39-aa2b-763133b0347d", "target_type": "library_item", "target_component": "", "new_state": { "active": false, "label": null, "type": "vpp-app", "name": "Pocket Casts: Podcast Player" }, "metadata": {} }, { "id": "01JNM149BA16F2W42VVFP44VD0", "action": "update", "occurred_at": "2025-03-05T20:49:33.901017Z", "actor_id": "cf40d6e7-20cb-4da9-84a1-9ad0b7003ca5", "actor_type": "user", "target_id": "7a488f5a-082b-4039-8e11-9b92985300c4", "target_type": "blueprint", "target_component": "library_items", "new_state": { "library_items_added": [ { "id": "07194cf3-10c1-4b39-aa2b-763133b0347d", "name": "Pocket Casts: Podcast Player" } ], "library_items_removed": [], "library_items_scoped": [ { "id": "c0af8f59-8d96-49e3-a66b-80639bc43eac", "name": "accuhive_wifi" }, { "id": "4418f6fa-0761-460f-b98d-c037f44ffad0", "name": "Iru Self Service" }, { "id": "92a8be7b-dc71-41f5-be27-138769080850", "name": "default skip" }, { "id": "07194cf3-10c1-4b39-aa2b-763133b0347d", "name": "Pocket Casts: Podcast Player" } ], "name": "_ipados_testing_2" }, "metadata": {} }, { "id": "01JNM1498JPRMZN6737HP4M2PT", "action": "update", "occurred_at": "2025-03-05T20:49:34.008256Z", "actor_id": "cf40d6e7-20cb-4da9-84a1-9ad0b7003ca5", "actor_type": "user", "target_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "target_type": "blueprint", "target_component": "library_items", "new_state": { "library_items_added": [ { "id": "07194cf3-10c1-4b39-aa2b-763133b0347d", "name": "Pocket Casts: Podcast Player" } ], "library_items_removed": [], "library_items_scoped": [ { "id": "3e2a8bd2-45a3-43e4-a1e6-7296a83abf65", "name": "agent_debug_logging" }, { "id": "cc2e2e17-e046-4405-ba46-1c39790a69a0", "name": "1Password 7" }, { "id": "3eb5836a-c856-47a6-8614-0da2624e8577", "name": "audit test" }, { "id": "07956063-476a-4c53-9fec-1686a5b9ec5b", "name": "wb" }, { "id": "03ece026-6d91-4616-a9de-c77c23a32555", "name": "wallpaper" }, { "id": "3ad11b1e-42fb-4405-b826-c9cdf6061e7e", "name": "pppc_finder" }, { "id": "814351ef-d9ee-4ebe-bf3e-5fb6cc3086bc", "name": "Microsoft Company Portal" }, { "id": "07194cf3-10c1-4b39-aa2b-763133b0347d", "name": "Pocket Casts: Podcast Player" }, { "id": "764706a2-f934-4808-85a4-7763d89327f4", "name": "brooklyn_screensaver" }, { "id": "24eb6c93-27d7-40a0-9092-d29e9d53a0ef", "name": "Okta Verify" } ], "name": "_testing_something" }, "metadata": {} }, { "id": "01JNM149BEX9ZK8YX7FVGARH4C", "action": "update", "occurred_at": "2025-03-05T20:49:34.064939Z", "actor_id": "cf40d6e7-20cb-4da9-84a1-9ad0b7003ca5", "actor_type": "user", "target_id": "ac4aba12-d2e5-430a-b7aa-42d25f9e6ead", "target_type": "blueprint", "target_component": "library_items", "new_state": { "library_items_added": [ { "id": "07194cf3-10c1-4b39-aa2b-763133b0347d", "name": "Pocket Casts: Podcast Player" } ], "library_items_removed": [], "library_items_scoped": [ { "id": "92a8be7b-dc71-41f5-be27-138769080850", "name": "default skip" }, { "id": "f0c99039-355e-4793-8b6f-7b55d9e8b77c", "name": "microsoft_sso_extension_mobile" }, { "id": "07194cf3-10c1-4b39-aa2b-763133b0347d", "name": "Pocket Casts: Podcast Player" }, { "id": "c0af8f59-8d96-49e3-a66b-80639bc43eac", "name": "accuhive_wifi" }, { "id": "4418f6fa-0761-460f-b98d-c037f44ffad0", "name": "Iru Self Service" }, { "id": "624cb961-0e69-4242-9cd1-3dffd3ca6830", "name": "Microsoft Authenticator" } ], "name": "_ipados_testing" }, "metadata": {} }, { "id": "01JNM149BE4W1KJ3J8WNPMKTH3", "action": "update", "occurred_at": "2025-03-05T20:49:34.148395Z", "actor_id": "cf40d6e7-20cb-4da9-84a1-9ad0b7003ca5", "actor_type": "user", "target_id": "07194cf3-10c1-4b39-aa2b-763133b0347d", "target_type": "library_item", "target_component": "", "new_state": { "active": true, "label": null, "type": "vpp-app", "name": "Pocket Casts: Podcast Player" }, "metadata": {} }, { "id": "01JNM15XZVZ64S00H7BAZKHE4A", "action": "update", "occurred_at": "2025-03-05T20:50:28.090682Z", "actor_id": "cf40d6e7-20cb-4da9-84a1-9ad0b7003ca5", "actor_type": "user", "target_id": "a0726ca3-717d-41b9-a3af-c7d0bad8b784", "target_type": "api_token", "target_component": "", "new_state": { "description": null, "permissions": [ { "path": "/api/v1/devices/{device_id}", "http_method": "PATCH" }, { "path": "/api/v1/users", "http_method": "GET" }, { "path": "/api/v1/users/{id}", "http_method": "GET" }, { "path": "/api/v1/users/{id}", "http_method": "DELETE" }, { "path": "/api/v1/audit/events", "http_method": "GET" } ], "label": "audit log events" }, "metadata": {} } ], "previous": null, "next": "https://accuhive.api.kandji.io/api/v1/audit/events?limit=2&sort_by=-occurred_at&cursor=PmR0OjIwMjUtMDMtMTcgMjI6Mjk6MjUuMzAxMDkyKzAwOjAw" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/integrations/apple/ade/public_key/": { "get": { "summary": "Download ADE public key", "description": "This request returns the public key used to create an MDM server connection in Apple Business or Apple School Manager.", "parameters": [], "responses": { "200": { "description": "Successful response - returns the public certificate", "content": { "application/x-x509-ca-cert": { "schema": { "type": "string", "format": "binary", "example": "-----BEGIN CERTIFICATE-----\nMIIC7TCCAdWgAwIBAgICANIwDQYJKoZIhvcNAQELBQAwLjEQMA4GA1UEAwwHU0NF\nUC1DQTELMAkGA1UEBhMCRVUxDTALBgNVBAoMBERUTkIwHhcNMjEwMjI2MTk1MTM1\nWhcNMzEwMjI0MTk1MTM1WjAxMRMwEQYDVQQDDApLQU5ESkktREVQMQswCQYDVQQG\nEwJFVTENMAsGA1UECgwERFROQjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\nggEBANsWli9JUD5Q32Gny5G8nfVACBwoYOd0WymsI96xrnguhMKS/zzrlkn4HUCt\n...\n...\n...\nCSqGSIb3DQEBCwUAA4IBAQBAq91ds1eQxzxUE/vyRUd1D4Sq4kEHLtyumfbAdhxq\noFVeQNCcHh4EAdH+D5kCV1KSbhap0WGm10c6rLidMSfcdCmr0IkIcFKCdtW3sAIB\nbqsM5pF1LULqnYZM25aDFRcy1d+t9en1jsL2ig2lDuIVCLd9Shj88R5NWELwHrar\nq0Ix5jA1qhQKrFzROXITAJUZOuf7WbOG7foM9Z12rQrfv1yTgLllr4S4qDCQUpGy\n3Q12WhkYltkdsG6GeoSbwNPxMUwNiDNE1Z3z51dMfzFud/vtB2wv29AIjRMBT4mW\nHA2a80rO+vlrUn8GR31yTlpazvalccuSuTpIO9VLxweB\n-----END CERTIFICATE-----" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/integrations/apple/ade/": { "post": { "summary": "Create ADE integration", "description": "This request will create a new ADE integration.", "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "blueprint_id": { "type": "string", "description": "The default blueprint ID" }, "phone": { "type": "string", "description": "Phone number" }, "email": { "type": "string", "description": "Email address" }, "file": { "type": "string", "format": "binary", "description": "MDM server token file from Apple Business or Apple School Manager" } } } } } }, "responses": { "200": { "description": "Create integration", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "4fbe63a1-6dc3-42e2-80dc-b1b183287463", "blueprint": { "id": "bf21d9cf-17cf-48b3-890d-7bc27c241bb7", "name": "Default Blueprint", "icon": "ss-files", "color": "aqua-800" }, "access_token_expiry": "2023-06-15T00:06:08Z", "server_name": "stage 2", "server_uuid": "55251a76-0a79-4a58-b96c-68b25f5cae53", "admin_id": "example@accuhive.io", "org_name": "Accuhive", "org_email": "example@accuhive.io", "org_phone": "+1 (415) 640-4923", "org_address": "113 W G St,San Diego CA 92101-6096,USA", "org_type": "org", "stoken_file_name": "stage 2_Token_2022-06-15T00-06-08Z_smime.p7m", "last_device_sync": null, "defaults": { "email": "example@accuhive.io", "phone": "123457890" }, "days_left": 364, "status": "SUCCESS", "status_reason": null, "status_received_at": null, "device_counts": { "total": 0 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/integrations/apple/ade/{ade_token_id}/renew": { "post": { "summary": "Renew ADE integration", "description": "This request will renew an existing ADE integration.", "parameters": [ { "name": "ade_token_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Renew integration", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "6cd195c1-9421-40ce-af5e-35c16cb69cc9", "blueprint": { "id": "bf21d9cf-17cf-48b3-890d-7bc27c241bb7", "name": "Default Blueprint", "icon": "ss-files", "color": "aqua-800" }, "access_token_expiry": "2023-06-14T23:53:04Z", "server_name": "stage", "server_uuid": "78e5f9f7-3bfc-46ec-9c67-cbb1f25ceffd", "admin_id": "example@accuhive.io", "org_name": "Accuhive", "org_email": "example@accuhive.io", "org_phone": "+1 (415) 640-4923", "org_address": "113 W G St,San Diego CA 92101-6096,USA", "org_type": "org", "stoken_file_name": "stage-kandji.io_Token_2022-06-14T23-53-04Z_smime.p7m", "last_device_sync": "2022-06-14T23:51:00.567593Z", "defaults": { "email": "example@accuhive.io", "phone": "123457890" }, "days_left": 364, "status": "SUCCESS", "status_reason": null, "status_received_at": "2022-05-11T18:06:00.461776Z", "device_counts": { "total": 0 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/integrations/apple/ade/{ade_token_id}": { "patch": { "summary": "Update ADE integration", "description": "This request will update the default blueprint, phone number, and email address in an existing ADE integration.", "parameters": [ { "name": "ade_token_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update integration", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "6cd195c1-9421-40ce-af5e-35c16cb69cc9", "blueprint": { "id": "bf21d9cf-17cf-48b3-890d-7bc27c241bb7", "name": "Default Blueprint", "icon": "ss-files", "color": "aqua-800" }, "access_token_expiry": "2023-06-14T23:53:04Z", "server_name": "stage", "server_uuid": "78e5f9f7-3bfc-46ec-9c67-cbb1f25ceffd", "admin_id": "example@accuhive.io", "org_name": "Accuhive", "org_email": "example@accuhive.io", "org_phone": "+1 (415) 640-4923", "org_address": "113 W G St,San Diego CA 92101-6096,USA", "org_type": "org", "stoken_file_name": "stage-kandji.io_Token_2022-06-14T23-53-04Z_smime.p7m", "last_device_sync": "2022-06-14T23:51:00.567593Z", "defaults": { "email": "example@accuhive.io", "phone": "123457890" }, "days_left": 364, "status": "SUCCESS", "status_reason": null, "status_received_at": "2022-05-11T18:06:00.461776Z", "device_counts": { "total": 0 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "blueprint_id": "bf21d9cf-17cf-48b3-890d-7bc27c241bb7", "phone": "1234567890", "email": "example@accuhive.io" } } } } } }, "get": { "summary": "Get ADE integration", "description": "", "parameters": [ { "name": "ade_token_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get integration", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "6aa1b707-57ba-43ed-bed7-3553d77ac3d1", "blueprint": { "id": "bf21d9cf-17cf-48b3-890d-7bc27c241bb7", "name": "Default Blueprint", "icon": "ss-files", "color": "aqua-800" }, "access_token_expiry": "2023-06-15T00:11:57Z", "server_name": "stage", "server_uuid": "78e5f9f7-3bfc-46ec-9c67-cbb1f25ceffd", "admin_id": "example@accuhive.io", "org_name": "Accuhive", "org_email": "example@accuhive.io", "org_phone": "+1 (415) 640-4923", "org_address": "113 W G St,San Diego CA 92101-6096,USA", "org_type": "org", "stoken_file_name": "stage_Token_2022-06-15T00-11-57Z_smime.p7m", "last_device_sync": "2022-06-15T00:31:00.581170Z", "defaults": { "email": "example@accuhive.io", "phone": "123457890" }, "days_left": 364, "status": "SUCCESS", "status_reason": null, "status_received_at": null, "device_counts": { "total": 0 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "delete": { "summary": "Delete ADE integration", "description": "", "parameters": [ { "name": "ade_token_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/integrations/apple/ade": { "get": { "summary": "List ADE integrations", "description": "This request returns a list of configured ADE integrations.", "parameters": [], "responses": { "200": { "description": "List integrations", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 2, "next": null, "previous": null, "results": [ { "id": "1411be7d-5e91-439f-8d93-2f5667c60d42", "blueprint": { "id": "97e4e175-1631-43f6-a02b-33fd1c748ab8", "name": "accuhive_default", "icon": "ss-files", "color": "aqua-800" }, "access_token_expiry": "2023-03-11T04:41:43Z", "server_name": "accuhive.kandji.io", "server_uuid": "e0067508-4df3-4c0a-87c1-bd4ca5934b0b", "admin_id": "admin@accuhive.io", "org_name": "accuhive", "org_email": "admin@accuhive.io", "org_phone": "+1 (415) 640-4923", "org_address": "113 W G St,San Diego CA 92101-6096,USA", "org_type": "org", "stoken_file_name": "accuhive.kandji.io_Token_2022-03-11T04-41-43Z_smime.p7m", "last_device_sync": "2022-07-18T15:56:34.567587Z", "defaults": { "email": "admin@accuhive.io", "phone": "1234567890" }, "days_left": 235, "status": "SUCCESS", "status_reason": null, "status_received_at": "2022-05-11T18:07:48.349490Z", "device_counts": { "Mac": 12, "iPad": 1, "iPhone": 1, "AppleTV": 1, "total": 15 } }, { "id": "bb7ad458-9d51-4652-a988-4b13cf8d61f4", "blueprint": { "id": "97e4e175-1631-43f6-a02b-33fd1c748ab8", "name": "accuhive_default", "icon": "ss-files", "color": "aqua-800" }, "access_token_expiry": "2023-03-11T19:22:18Z", "server_name": "accuhive.kandji.io-2", "server_uuid": "0d7fda7f-19a7-4ddf-992b-89dbcd2d9dab", "admin_id": "admin@accuhive.io", "org_name": "accuhive", "org_email": "admin@accuhive.io", "org_phone": "+1 (415) 640-4923", "org_address": "113 W G St,San Diego CA 92101-6096,USA", "org_type": "org", "stoken_file_name": "accuhive.kandji.io-2_Token_2022-03-11T19-22-18Z_smime.p7m", "last_device_sync": "2022-04-27T18:51:30.560318Z", "defaults": { "email": "admin@accuhive.io", "phone": "1234567890" }, "days_left": 236, "status": "BROKEN", "status_reason": "FORBIDDEN", "status_received_at": "2022-07-18T16:01:27.232090Z", "device_counts": { "total": 0 } } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/integrations/apple/ade/{ade_token_id}/devices": { "get": { "summary": "List devices associated to ADE token", "description": "This request returns a list of devices associated with a specified ade_token_id as well as their enrollment status.", "parameters": [ { "name": "ade_token_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List associated devices - null mdm_device", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 498, "next": "https://accuhive.kandji.io/api/v1/integrations/apple/ade/119a9ad6-d6ee-460f-af11-36595c25ad68/devices/?page=2", "previous": null, "results": [ { "blueprint": { "id": "70ab3d4e-1298-41a5-a2a7-b04abf804578", "name": "EMPTY_DONT_ADD_STUFF", "icon": "ss-attach", "color": "orange-300" }, "mdm_device": null, "user": null, "dep_account": { "id": "0e5dceab-9389-4b4d-87a2-691de4ca2e73", "server_name": "API Testing" }, "asset_tag": "", "color": "SILVER", "description": "MBA 13.3 SLV/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-14T23:58:41Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-14T23:23:21Z", "profile_push_time": "2022-06-14T23:58:41Z", "profile_status": "pushed", "serial_number": "FVFXXXB3QXXX", "id": "80b43bbc-b283-4c70-aef3-4d34e340293e", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-14T23:23:21.701712Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "PZ5ZZIR186S8", "id": "9a7628c8-59ac-41cf-8596-bf07f589a0c7", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:10:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:10:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "UQJOE6U9I36Q", "id": "03dba3c6-624c-4d01-9755-3b4ba9565f3f", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:10:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:11:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:11:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "XBKIJXO3X14O", "id": "3973b56d-db7d-4771-8289-0602d84f8f11", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:11:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:12:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:12:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "TZ2QFWBGKWJM", "id": "5f5fc661-ec2a-4ab6-8663-4449eda6dfd4", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:12:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "B60I6IOYAIKO", "id": "f17461fd-d428-4194-99ff-c91e476b2c07", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "VDVCKYCVYNEV", "id": "2920149b-8ea9-4b6f-8cc2-e3f5ac8ff28c", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "WSUOWXKBLFQN", "id": "063044b4-0c4b-4540-8308-8df7bf5767ce", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "2JNQEICBHZVJ", "id": "dde9eeaf-2731-4027-a162-a3f23935a277", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "OUIJOLT0TFFR", "id": "67945772-3ca9-44ea-a4df-fa6f37ff441f", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "HWNUHNFQXXJB", "id": "3a31562a-2a3e-4873-bef4-9a06e4352ad7", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "HGGQOUOLTLG3", "id": "650950b9-8be8-4f9e-970c-2bf2a0f88187", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "MX3TACOBFZHL", "id": "00c09e16-8c50-41d4-bcc2-1811fc72b006", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "ROWUPQUAPLZH", "id": "b53c7e06-ee93-499d-aadf-397662c134ef", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "YTOCKCHYDBT6", "id": "78eb2368-0639-4a6f-9467-cace292db33d", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "JU3VSQS2DMFU", "id": "c311e247-ca79-4b35-8cb3-e7409c304880", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "L4LJYCGSYFP1", "id": "d70aa1d9-aa52-40de-b45c-20e48611e2d4", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "L11R13OS6V12", "id": "94c319cf-a056-488d-8681-6f456d87cc41", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "MPH7P16FHKNK", "id": "a6c1676c-46e2-40f7-87bf-5aa1ea02d625", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "BZX1AZEUEZJW", "id": "8c1cdc33-7695-49c6-bde5-033a595c64c9", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "CII977WQ06J8", "id": "4c90fcdb-7f9a-4779-b86a-1a7aa14d9c08", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "LX8ZTLG0SPZU", "id": "1fb8647d-66cd-4881-8283-c33136e220e3", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "3NQZEMKMKZ3T", "id": "a31d31f5-c911-4272-a7ee-985be29ac353", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "9WTTWLCYXSY0", "id": "9d4b4830-a07b-4f9c-b8f6-4956fde6d671", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" }, { "blueprint": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500" }, "mdm_device": null, "user": null, "dep_account": { "id": "119a9ad6-d6ee-460f-af11-36595c25ad68", "server_name": "API Testing" }, "asset_tag": null, "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "example@accuhive.io", "device_assigned_date": "2022-06-30T19:09:51Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2022-06-30T19:09:56Z", "profile_push_time": null, "profile_status": "assigned", "serial_number": "M6A8ZWAX93MG", "id": "9c4c5b72-b466-4e46-850c-d3eff6065fe7", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2022-06-30T19:09:58.070000Z" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/integrations/apple/ade/devices": { "get": { "summary": "List ADE devices", "description": "Get a list of Automated Device Enrollment devices.", "parameters": [ { "name": "blueprint_id", "in": "query", "required": false, "description": "Return results \"containing\" the specified blueprint id", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "description": "\"exact\" match on user ID value (example: 5344c996-8823-4b37-8d6e-8515fc7c3a0a)", "schema": { "type": "string" } }, { "name": "dep_account", "in": "query", "required": false, "description": "The ADE token UUID", "schema": { "type": "string" } }, { "name": "device_family", "in": "query", "required": false, "description": "iPad, iPhone, iPod, Mac, AppleTV, or Vision", "schema": { "type": "string" } }, { "name": "model", "in": "query", "required": false, "description": "Return model results \"containing\" the specified model string. - \"iPad (8th Generation)\", \"MacBook Air\"", "schema": { "type": "string" } }, { "name": "os", "in": "query", "required": false, "description": "iOS, iPadOS, OSX, tvOS, or visionOS", "schema": { "type": "string" } }, { "name": "profile_status", "in": "query", "required": false, "description": "The automated device enrollment profile assignment status - assigned, empty, pushed, removed", "schema": { "type": "string" } }, { "name": "serial_number", "in": "query", "required": false, "description": "Search for a specific device by Serial Number. If partial serial number is provided in the query, all device containing the partial string will be returned.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Use the `page` parameter to page through results or to request a specific page. By default, if a page is not specified, page 1 is returned. Note: 300 device records are returned per page of results. Alternatively, the `next` and `previous` key attributes in the response can be used to request the next page of results or return to the previous page.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 1, "next": null, "previous": null, "results": [ { "blueprint_id": "c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2", "mdm_device": { "id": "782f4054-b971-4bec-850b-7bf13ce806fe", "enrolled_at": "2023-09-20T14:44:45.258155Z", "name": "testuser’s MacBook Air", "enrollment_status": 4, "deferred_install": false, "is_missing": false, "is_removed": false }, "user_id": "5344c996-8823-4b37-8d6e-8515fc7c3a0a", "dep_account": { "id": "821b216b-8a8d-4089-b4d9-c66dc83f92f2", "server_name": "accuhive" }, "asset_tag": "sending_to_now", "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "accuhive@accuhive.io", "device_assigned_date": "2023-08-22T16:56:48Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2023-09-21T22:02:45Z", "profile_push_time": "2023-09-20T14:43:45Z", "profile_status": "assigned", "serial_number": "C02FL5YXQ6LC", "id": "aca3e9f7-48d9-44a5-9007-25bc0b1d451f", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2023-09-21T22:02:45.609328Z", "blueprint": "c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2", "user": "5344c996-8823-4b37-8d6e-8515fc7c3a0a" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/integrations/apple/ade/devices/{device_id}": { "get": { "summary": "Get ADE device", "description": "Get information about a specific Automated Device Enrollment device.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "blueprint_id": "c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2", "mdm_device": { "id": "782f4054-b971-4bec-850b-7bf13ce806fe", "enrolled_at": "2023-09-20T14:44:45.258155Z", "name": "testuser’s MacBook Air", "enrollment_status": 4, "deferred_install": false, "is_missing": false, "is_removed": false }, "user_id": "5344c996-8823-4b37-8d6e-8515fc7c3a0a", "dep_account": { "id": "821b216b-8a8d-4089-b4d9-c66dc83f92f2", "server_name": "accuhive" }, "asset_tag": "sending_to_now", "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "accuhive@accuhive.io", "device_assigned_date": "2023-08-22T16:56:48Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2023-09-21T22:02:45Z", "profile_push_time": "2023-09-20T14:43:45Z", "profile_status": "assigned", "serial_number": "C02FL5YXQ6LC", "id": "aca3e9f7-48d9-44a5-9007-25bc0b1d451f", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2023-09-21T22:02:45.609328Z", "blueprint": "c4d2da33-99f0-4ed4-b7a5-731f78b0c1e2", "user": "5344c996-8823-4b37-8d6e-8515fc7c3a0a" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "patch": { "summary": "Update ADE device", "description": "Update a specific Automated Device Enrollment device's blueprint assignment, user assignment, and asset tag.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update user assignment", "content": { "application/json": { "schema": { "type": "object", "example": { "blueprint_id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "mdm_device": { "id": "782f4054-b971-4bec-850b-7bf13ce806fe", "enrolled_at": "2023-09-20T14:44:45.258155Z", "name": "testuser’s MacBook Air", "enrollment_status": 4, "deferred_install": false, "is_missing": false, "is_removed": false }, "user_id": "5344c996-8823-4b37-8d6e-8515fc7c3a0a", "dep_account": { "id": "821b216b-8a8d-4089-b4d9-c66dc83f92f2", "server_name": "accuhive" }, "asset_tag": "sending_to_now", "color": "GOLD", "description": "MBA 13.3 GLD/8C CPU/7C GPU/8GB/256GB-USA", "device_assigned_by": "accuhive@accuhive.io", "device_assigned_date": "2023-08-22T16:56:48Z", "device_family": "Mac", "model": "MacBook Air", "os": "OSX", "profile_assign_time": "2023-09-21T22:02:45Z", "profile_push_time": "2023-09-20T14:43:45Z", "profile_status": "assigned", "serial_number": "C02FL5YXQ6LC", "id": "aca3e9f7-48d9-44a5-9007-25bc0b1d451f", "last_assignment_status": "SUCCESS", "failed_assignment_attempts": 0, "assignment_status_received_at": "2023-09-21T22:02:45.609328Z", "blueprint": "b38787e4-401c-4c4b-86dc-f1cca2072531", "user": "5344c996-8823-4b37-8d6e-8515fc7c3a0a" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "blueprint_id": "3013eb7c-d0c1-4689-852a-50776a92036b", "asset_tag": "123456", "user_id": "5344c996-8823-4b37-8d6e-8515fc7c3a0a" } } } } } } }, "/api/v1/blueprints": { "get": { "summary": "List Blueprints", "description": "This request returns a list of blueprint records in the Iru Endpoint Management tenant.", "parameters": [ { "name": "id", "in": "query", "description": "Look up a specific Blueprint by its ID", "required": false, "schema": { "type": "string" } }, { "name": "id__in", "in": "query", "description": "Specify a list of Blueprint IDs to limit the results to. Multiple values may be separated by commas. There is a double underscore (__) between id and in", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Return Blueprint names \"containing\" the specified search string.", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "schema": { "type": "integer", "minimum": 0 } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 2, "next": null, "previous": null, "results": [ { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500", "description": "", "params": {}, "computers_count": 0, "enrollment_code": { "code": "123456", "is_active": true }, "type": "classic" }, { "id": "cbe7daa9-2bcb-4cb1-aff9-024cd3a0330c", "name": "this is a test assignment map", "icon": "ss-files", "color": "aqua-800", "description": "", "params": {}, "computers_count": 0, "enrollment_code": { "code": "012345", "is_active": true }, "type": "map" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "post": { "summary": "Create Blueprint", "description": "This request creates a new empty Blueprint or a new Blueprint from a template.", "parameters": [], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Blueprint. Must be unique." }, "enrollment_code.is_active": { "type": "boolean", "description": "Enable or disable the Blueprint for manual device enrollment." }, "enrollment_code.code": { "type": "string", "description": "The enrollment code for the Blueprint. If not provided, will be randomly generated." }, "type": { "type": "string", "description": "The type of blueprint. Use 'map' for Assignment Map blueprints." }, "description": { "type": "string", "description": "Optional description for the Blueprint." }, "icon": { "type": "string", "description": "Optional icon for the Blueprint." }, "color": { "type": "string", "description": "Optional color for the Blueprint." } }, "required": [ "name", "enrollment_code.is_active" ] }, "example": { "name": "Test Template123", "enrollment_code.is_active": "true", "enrollment_code.code": "897526", "type": "map", "description": "An example blueprint description" } } } }, "responses": { "201": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "f3a0445f-87ba-4c37-ba9f-67186004f375", "name": "Test Template123", "icon": "ss-files", "color": "aqua-800", "description": "", "params": {}, "enrollment_code": { "code": "123456", "is_active": true }, "type": "map" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/blueprints/{blueprint_id}/ota-enrollment-profile": { "get": { "summary": "Get Manual Enrollment Profile", "description": "This request returns the manual enrollment profile (.mobileconfig file) for a specified Blueprint.", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the blueprint." }, { "name": "sso", "in": "query", "required": false, "description": "Use the `sso` query parameter, set to `true`, to return a URL instead of the manual enrollment profile. This parameter should only be used for blueprints in which \"Require Authentication\" is configured for Manual Enrollment. The returned URL must be used to authenticate via SSO to receive an enrollment profile.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get Manual Enrollment Profile", "content": { "application/json": { "schema": { "type": "object", "example": { "url": "https://accuhive.kandji.io/enrollment/authentication?metadata=eyJjbGllbnRfZG9tYWluIjogImQ1MzhjNjJjLmNsaWVudHMudXMtMS5rYW5kamkuaW8iLCAiYmx1ZXByaW50X2lkIjogIjNiYTU3MWFlLTIyZDEtNDlkNC1hNTUwLTdjODU0NTc3ZWY1MCIsICJ0ZW1wX2NvbXB1dGVyIjogImUxNWM3YzYzLTg4NDUtNDk0Mi05NmE4LWE2M2NiN2UyNjA0MSIsICJlbnJvbGxtZW50X2NvZGUiOiAiNjEwMzMyIiwgImNhbGxiYWNrX3VybCI6ICJodHRwczovL2Q1MzhjNjJjLndlYi1hcGkua2FuZGppLmlvL2FwcC92MS9tZG0vZW5yb2xsLW90YS1jYWxsYmFjay9lMTVjN2M2My04ODQ1LTQ5NDItOTZhOC1hNjNjYjdlMjYwNDEiLCAiYXV0aDBfY29uZmlndXJhdGlvbnMiOiBbeyJhdXRoMF9jbGllbnRfaWQiOiAiVW1DOXN3MGNBdHg3NWhpOWJzUHNCSmN0YTdrTlB6TnEiLCAiYXV0aDBfY29ubmVjdGlvbl9pZCI6ICJjb25fV3kxRE1qeU1vaHdHYUtnSyIsICJhdXRoMF9jb25uZWN0aW9uX25hbWUiOiBudWxsLCAiZW5hYmxlZCI6IHRydWV9XSwgImVuYWJsZV9pbnN0cnVtZW50YXRpb24iOiBmYWxzZX0=" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "example": { "detail": "Bad Request - Invalid blueprint ID or parameters" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "example": { "detail": "Unauthorized - Invalid or missing API token" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "example": { "detail": "Not Found - Blueprint not found" } } } } } } } }, "/api/v1/blueprints/templates/": { "get": { "summary": "Get Blueprint Templates", "description": "", "parameters": [], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 2, "next": null, "previous": null, "results": [ { "id": 2, "name": "CIS", "weight": 20, "templates": [ { "id": 16, "name": "CIS Level 2 Scored", "description": "CIS Level 1 and Level 2 Scored parameters, based on the macOS benchmark created and maintained by Center for Internet Security. More details can be found at benchmarks.cisecurity.org.\n\nCIS ”Scored\" parameters are parameters that will decrease a final CIS benchmark score if they fail audit.\n\nCIS “Level 1” parameters are intended to be practical and prudent, provide a clear security benefit, and not inhibit the utility of the technology beyond acceptable means.\n\nCIS \"Level 2\" parameters are intended for environments or use cases where security is paramount, and may negatively inhibit the utility or performance of the technology.\n\nThis template is meant to be a starting point for macOS CIS Level 1 & 2 Scored compliance. Please review, and make changes as needed. Always thoroughly test before deploying to a production environment.", "category": 2, "icon": "ss-files", "color": "aqua-800", "params": { "0264078c-4555-4b7a-bd90-888eae867830": { "mute": false, "daily": false }, "0720f00c-393a-4a66-b676-efa82307ebd4": { "mute": false, "daily": false }, "0f692ac3-670e-4ee2-b207-3604bd54e32c": { "mute": false, "daily": false }, "135b1c65-a665-431b-b919-39e984d6d29d": { "mute": true, "daily": false }, "1cdcd680-f880-4734-9cac-dec627351478": { "mute": false, "daily": false }, "1e4be748-e072-4c1f-b1ff-a98f076b8e8e": { "mute": false, "daily": false }, "1fb8d435-3205-429c-9394-868add3e4822": { "mute": false, "daily": false }, "1fd6eac1-2db4-4520-bfc1-b5f972e392fc": { "mute": false, "daily": false }, "2107e444-9421-4ec8-a7d0-67ac23ed555c": { "mute": false, "daily": false, "details": [ "/Library/Application Support/Adobe/", "/Library/Application Support/regid.1986-12.com.adobe/", "/Library/Application Support/VMware/" ] }, "2ab1b190-c3b2-4f79-8fea-c5a147a0e564": { "mute": false, "daily": false }, "34e7d714-5772-416d-9aff-c467504b45eb": { "mute": false, "daily": false }, "370625c0-77fe-4972-bac3-6be812fa4dd7": { "mute": false, "daily": false }, "3b176bde-d7bc-4086-9cfa-1cf8a6d32757": { "mute": false, "daily": false }, "3d81acd3-8d3d-4941-a88e-6b8b9147cc6a": { "mute": false, "daily": false, "details": { "corner": "wvous-br-corner", "method": 0 } }, "3e41b186-f713-4b71-9f77-bddff07942f8": { "mute": false, "daily": false }, "428d99a1-5ab0-4198-b248-7603d1c2e258": { "mute": false, "daily": false }, "42a3fdf6-3774-4f56-9fde-c286760a48bf": { "mute": false, "daily": false }, "4911ed60-3c2d-40ba-a5ca-33306f1d1245": { "mute": false, "daily": false, "details": 15 }, "5112c772-bf78-4bf9-81a1-35e45ae2b915": { "mute": false, "daily": false }, "51a763db-716c-4bfa-b721-2f303d203b3b": { "mute": false, "daily": false, "details": "1" }, "52ad1967-3d00-4cb3-93c4-92b49b95a446": { "mute": false, "daily": false }, "56171a5e-27e5-4d6e-86cf-8956ca3b7bca": { "mute": false, "daily": false }, "58513f4e-be5b-4726-8ed5-a9b337bbd973": { "mute": false, "daily": false }, "5d78eebc-8552-4f9a-8236-44b9e7a4bff2": { "mute": false, "daily": false, "details": "0" }, "6d268d72-3859-458c-a413-9a7210b89719": { "mute": false, "daily": false }, "6e82a850-901a-47ec-9b4e-03393af029c9": { "mute": false, "daily": false, "details": 365 }, "776f1c86-54ea-4876-a226-a0a07040fec0": { "mute": false, "daily": false, "details": { "type": "text", "value": "This system is reserved for authorized use only, and the use of this system may be monitored." } }, "7888dff6-ad41-41f2-8f07-0f7c43a1c993": { "mute": false, "daily": false }, "7a49b60a-7793-4fb7-854d-aa12829a8e57": { "mute": false, "daily": false }, "7c368d56-88c9-45b4-b9a0-d389febbe027": { "mute": false, "daily": false }, "86e70b82-c7d6-4266-8a89-104e9dde6a30": { "mute": false, "daily": false }, "8ed38311-50d7-4165-890e-ac3bdf55047e": { "mute": false, "daily": false }, "91e86fb9-1c25-45b0-b1ed-064f8a478409": { "mute": false, "daily": false, "details": [ { "flag": "lo", "prefix": "none" }, { "flag": "ad", "prefix": "none" }, { "flag": "fd", "prefix": "none" }, { "flag": "fm", "prefix": "none" }, { "flag": "all", "prefix": "-" } ] }, "93384921-61aa-46f6-a7d9-d45908babccc": { "mute": false, "daily": false, "details": false }, "986a50bc-7cea-4874-b61c-4b2b9b1c318b": { "mute": false, "daily": false }, "a189df03-cdfd-4c55-b429-95e7df5a7521": { "mute": false, "daily": false }, "b648790a-0fac-43b8-bd96-5682f60f467e": { "mute": false, "daily": false }, "b8fa043f-80bd-43d5-aea6-a94626d92c3a": { "mute": false, "daily": false }, "c248f070-6bce-42b1-9688-27d9bf4c1513": { "mute": false, "daily": false }, "cbb3b9c5-2db4-476a-9faa-0c61b7354ec1": { "mute": false, "daily": false, "details": { "days": 60, "size": 1, "unit": "GB", "modifier": "or" } }, "cc59e3c1-eb02-4021-afa2-50977a30cf0a": { "mute": false, "daily": false }, "cf19344c-572a-4359-a7f1-b02db1df1a43": { "mute": false, "daily": false }, "d011e3a4-eebe-4af2-adf8-aa41c11efacf": { "mute": false, "daily": false, "details": "time.apple.com" }, "d19e2f27-6ddb-41b1-b76a-1662b6330cd1": { "mute": false, "daily": false }, "da3834d5-c315-4ce0-980e-b650f675b630": { "mute": false, "daily": false }, "e5d41a12-a0be-42c8-ada8-0bc0cec1b465": { "mute": false, "daily": false }, "e5decad7-7cbf-49b4-99b0-d7e94a21fa47": { "mute": false, "daily": false }, "e9c1d35c-55f1-4ab9-9081-2865091b1fb2": { "mute": true, "daily": false, "details": { "alert_no_backups": false, "days_between_backups": 14 } }, "ea3bb880-de67-4988-8266-ae2f4f81a05c": { "mute": false, "daily": false }, "f1f19efe-75a1-4ade-8456-8da539433728": { "mute": false, "daily": false }, "f228e471-2a6c-4046-b676-02b133a6239d": { "mute": false, "daily": false }, "f6b09eeb-a213-4fb5-8b09-1bb4d81583ab": { "mute": false, "daily": false }, "fb63a562-062d-4679-9e16-3dd2453e726d": { "mute": false, "daily": false } }, "rating": 80 }, { "id": 15, "name": "CIS Level 1 Scored", "description": "CIS Level 1 Scored parameters, based on the macOS benchmark created and maintained by Center for Internet Security. More details can be found at https://benchmarks.cisecurity.org.\n\nCIS ”Scored\" parameters are parameters that will decrease a final CIS benchmark score if they fail audit.\n\nCIS “Level 1” parameters are intended to be practical and prudent, provide a clear security benefit, and not inhibit the utility of the technology beyond acceptable means.\n\nThis template is meant to be a starting point for macOS CIS Level 1 Scored compliance. Please review, and make changes as needed. Always thoroughly test before deploying to a production environment.", "category": 2, "icon": "ss-files", "color": "aqua-800", "params": { "0264078c-4555-4b7a-bd90-888eae867830": { "mute": false, "daily": false }, "0f692ac3-670e-4ee2-b207-3604bd54e32c": { "mute": false, "daily": false }, "135b1c65-a665-431b-b919-39e984d6d29d": { "mute": true, "daily": false }, "1e4be748-e072-4c1f-b1ff-a98f076b8e8e": { "mute": false, "daily": false }, "1fb8d435-3205-429c-9394-868add3e4822": { "mute": false, "daily": false }, "1fd6eac1-2db4-4520-bfc1-b5f972e392fc": { "mute": false, "daily": false }, "2ab1b190-c3b2-4f79-8fea-c5a147a0e564": { "mute": false, "daily": false }, "34e7d714-5772-416d-9aff-c467504b45eb": { "mute": false, "daily": false }, "370625c0-77fe-4972-bac3-6be812fa4dd7": { "mute": false, "daily": false }, "3b176bde-d7bc-4086-9cfa-1cf8a6d32757": { "mute": false, "daily": false }, "3d81acd3-8d3d-4941-a88e-6b8b9147cc6a": { "mute": false, "daily": false, "details": { "corner": "wvous-br-corner", "method": 0 } }, "428d99a1-5ab0-4198-b248-7603d1c2e258": { "mute": false, "daily": false }, "5112c772-bf78-4bf9-81a1-35e45ae2b915": { "mute": false, "daily": false }, "52ad1967-3d00-4cb3-93c4-92b49b95a446": { "mute": false, "daily": false }, "56171a5e-27e5-4d6e-86cf-8956ca3b7bca": { "mute": false, "daily": false }, "58513f4e-be5b-4726-8ed5-a9b337bbd973": { "mute": false, "daily": false }, "5d78eebc-8552-4f9a-8236-44b9e7a4bff2": { "mute": false, "daily": false, "details": "0" }, "6d268d72-3859-458c-a413-9a7210b89719": { "mute": false, "daily": false }, "6e82a850-901a-47ec-9b4e-03393af029c9": { "mute": false, "daily": false, "details": 365 }, "7888dff6-ad41-41f2-8f07-0f7c43a1c993": { "mute": false, "daily": false }, "7a49b60a-7793-4fb7-854d-aa12829a8e57": { "mute": false, "daily": false }, "7c368d56-88c9-45b4-b9a0-d389febbe027": { "mute": false, "daily": false }, "86e70b82-c7d6-4266-8a89-104e9dde6a30": { "mute": false, "daily": false }, "8ed38311-50d7-4165-890e-ac3bdf55047e": { "mute": false, "daily": false }, "93384921-61aa-46f6-a7d9-d45908babccc": { "mute": false, "daily": false, "details": false }, "986a50bc-7cea-4874-b61c-4b2b9b1c318b": { "mute": false, "daily": false }, "a189df03-cdfd-4c55-b429-95e7df5a7521": { "mute": false, "daily": false }, "b648790a-0fac-43b8-bd96-5682f60f467e": { "mute": false, "daily": false }, "c248f070-6bce-42b1-9688-27d9bf4c1513": { "mute": false, "daily": false }, "cbb3b9c5-2db4-476a-9faa-0c61b7354ec1": { "mute": false, "daily": false, "details": { "days": 60, "size": 1, "unit": "GB", "modifier": "or" } }, "cc59e3c1-eb02-4021-afa2-50977a30cf0a": { "mute": false, "daily": false }, "cf19344c-572a-4359-a7f1-b02db1df1a43": { "mute": false, "daily": false }, "d011e3a4-eebe-4af2-adf8-aa41c11efacf": { "mute": false, "daily": false, "details": "time.apple.com" }, "d19e2f27-6ddb-41b1-b76a-1662b6330cd1": { "mute": false, "daily": false }, "da3834d5-c315-4ce0-980e-b650f675b630": { "mute": false, "daily": false }, "e5d41a12-a0be-42c8-ada8-0bc0cec1b465": { "mute": false, "daily": false }, "e5decad7-7cbf-49b4-99b0-d7e94a21fa47": { "mute": false, "daily": false }, "e9c1d35c-55f1-4ab9-9081-2865091b1fb2": { "mute": true, "daily": false, "details": { "alert_no_backups": false, "days_between_backups": 14 } }, "ea3bb880-de67-4988-8266-ae2f4f81a05c": { "mute": false, "daily": false }, "f1f19efe-75a1-4ade-8456-8da539433728": { "mute": false, "daily": false }, "f6b09eeb-a213-4fb5-8b09-1bb4d81583ab": { "mute": false, "daily": false }, "fb63a562-062d-4679-9e16-3dd2453e726d": { "mute": false, "daily": false } }, "rating": 60 } ] }, { "id": 1, "name": "Kandji", "weight": 10, "templates": [ { "id": 11, "name": "Kandji Level III", "description": "Parameters found in Kandji Level II as well as advanced media and network configurations. Several built-in macOS features have been disabled. \n\nImportant: Always review and test thoroughly before deploying. Users day to day impact will be affected. It is recommended that you review these changes with end-users before deployment.", "category": 1, "icon": "ss-files", "color": "aqua-800", "params": { "0264078c-4555-4b7a-bd90-888eae867830": { "mute": false, "daily": false }, "0720f00c-393a-4a66-b676-efa82307ebd4": { "mute": false, "daily": false }, "0f692ac3-670e-4ee2-b207-3604bd54e32c": { "mute": false, "daily": false }, "12167a3a-a134-4d33-aea6-429086b872f5": { "mute": false, "daily": false, "details": "0" }, "135b1c65-a665-431b-b919-39e984d6d29d": { "mute": true, "daily": false }, "1cdcd680-f880-4734-9cac-dec627351478": { "mute": false, "daily": false }, "1e4be748-e072-4c1f-b1ff-a98f076b8e8e": { "mute": false, "daily": false }, "1fb8d435-3205-429c-9394-868add3e4822": { "mute": false, "daily": false }, "1fd6eac1-2db4-4520-bfc1-b5f972e392fc": { "mute": false, "daily": false }, "2ab1b190-c3b2-4f79-8fea-c5a147a0e564": { "mute": false, "daily": false }, "34e7d714-5772-416d-9aff-c467504b45eb": { "mute": false, "daily": false }, "370625c0-77fe-4972-bac3-6be812fa4dd7": { "mute": false, "daily": false }, "3b176bde-d7bc-4086-9cfa-1cf8a6d32757": { "mute": false, "daily": false }, "3d81acd3-8d3d-4941-a88e-6b8b9147cc6a": { "mute": false, "daily": false, "details": { "corner": "wvous-br-corner", "method": 0 } }, "428d99a1-5ab0-4198-b248-7603d1c2e258": { "mute": false, "daily": false }, "42a3fdf6-3774-4f56-9fde-c286760a48bf": { "mute": false, "daily": false }, "5112c772-bf78-4bf9-81a1-35e45ae2b915": { "mute": false, "daily": false }, "52ad1967-3d00-4cb3-93c4-92b49b95a446": { "mute": false, "daily": false }, "56171a5e-27e5-4d6e-86cf-8956ca3b7bca": { "mute": false, "daily": false }, "58513f4e-be5b-4726-8ed5-a9b337bbd973": { "mute": false, "daily": false }, "5d78eebc-8552-4f9a-8236-44b9e7a4bff2": { "mute": false, "daily": false, "details": "0" }, "6d268d72-3859-458c-a413-9a7210b89719": { "mute": false, "daily": false }, "6e82a850-901a-47ec-9b4e-03393af029c9": { "mute": false, "daily": false, "details": 365 }, "776f1c86-54ea-4876-a226-a0a07040fec0": { "mute": false, "daily": false, "details": { "type": "text", "value": "This system is reserved for authorized use only, and the use of this system may be monitored." } }, "7888dff6-ad41-41f2-8f07-0f7c43a1c993": { "mute": false, "daily": false }, "7c368d56-88c9-45b4-b9a0-d389febbe027": { "mute": false, "daily": false }, "86e70b82-c7d6-4266-8a89-104e9dde6a30": { "mute": false, "daily": false }, "8c6b6864-3faa-47f1-b599-e13bb04682ed": { "mute": false, "daily": false, "details": "0" }, "8ed38311-50d7-4165-890e-ac3bdf55047e": { "mute": false, "daily": false }, "91e86fb9-1c25-45b0-b1ed-064f8a478409": { "mute": false, "daily": false, "details": [ { "flag": "lo", "prefix": "none" }, { "flag": "ad", "prefix": "none" }, { "flag": "fd", "prefix": "none" }, { "flag": "fm", "prefix": "none" }, { "flag": "all", "prefix": "-" } ] }, "93384921-61aa-46f6-a7d9-d45908babccc": { "mute": false, "daily": false, "details": false }, "986a50bc-7cea-4874-b61c-4b2b9b1c318b": { "mute": false, "daily": false }, "af5c6286-f084-4369-a14b-7af9b5797aa8": { "mute": false, "daily": false }, "b648790a-0fac-43b8-bd96-5682f60f467e": { "mute": false, "daily": false }, "c248f070-6bce-42b1-9688-27d9bf4c1513": { "mute": false, "daily": false }, "c2f95015-c14e-49bd-8d89-27c3f5963dc1": { "mute": false, "daily": false }, "cbb3b9c5-2db4-476a-9faa-0c61b7354ec1": { "mute": false, "daily": false, "details": { "days": 60, "size": 1024, "unit": "MB", "modifier": "or" } }, "cc59e3c1-eb02-4021-afa2-50977a30cf0a": { "mute": false, "daily": false }, "cf19344c-572a-4359-a7f1-b02db1df1a43": { "mute": false, "daily": false }, "d011e3a4-eebe-4af2-adf8-aa41c11efacf": { "mute": false, "daily": false, "details": "time.apple.com" }, "d19e2f27-6ddb-41b1-b76a-1662b6330cd1": { "mute": false, "daily": false }, "da3834d5-c315-4ce0-980e-b650f675b630": { "mute": false, "daily": false }, "e5d41a12-a0be-42c8-ada8-0bc0cec1b465": { "mute": false, "daily": false }, "e5fbd8ad-e45b-4fa1-b900-21969fefd2ac": { "mute": false, "daily": false }, "ea3bb880-de67-4988-8266-ae2f4f81a05c": { "mute": false, "daily": false }, "f1f19efe-75a1-4ade-8456-8da539433728": { "mute": false, "daily": false }, "f6b09eeb-a213-4fb5-8b09-1bb4d81583ab": { "mute": false, "daily": false }, "fb63a562-062d-4679-9e16-3dd2453e726d": { "mute": false, "daily": false } }, "rating": 70 }, { "id": 13, "name": "Kandji Level IV", "description": "Security is paramount by including all that is enabled in Kandji Level III, with added parameters disabling iCloud related services, and several additional macOS functions. \n\n\nImportant: Always review and test thoroughly before deploying. Users day to day impact will be affected. It is recommended that you review these changes with end-users before deployment.", "category": 1, "icon": "ss-files", "color": "aqua-800", "params": { "0264078c-4555-4b7a-bd90-888eae867830": { "mute": false, "daily": false }, "0720f00c-393a-4a66-b676-efa82307ebd4": { "mute": false, "daily": false }, "07cac17b-33b0-4af3-8302-3e5ded562b45": { "mute": false, "daily": false, "details": "1" }, "08323d29-7296-4fc1-8a74-295b3ac2b081": { "mute": false, "daily": false, "details": "1" }, "0f692ac3-670e-4ee2-b207-3604bd54e32c": { "mute": false, "daily": false }, "12167a3a-a134-4d33-aea6-429086b872f5": { "mute": false, "daily": false, "details": "0" }, "135b1c65-a665-431b-b919-39e984d6d29d": { "mute": true, "daily": false }, "1636e014-eee6-4858-b508-24594a4b521d": { "mute": true, "daily": false }, "19b5c13d-ccc7-49f5-9534-8e5c790a2925": { "mute": false, "daily": false }, "1cdcd680-f880-4734-9cac-dec627351478": { "mute": false, "daily": false }, "1ce8e700-9636-4420-b9f9-6db1071ebdcb": { "mute": false, "daily": false, "profile": "com.apple.applicationaccess.4a273661-7142-4d4e-8566-115b2b29dd27" }, "1e058873-3137-4387-8760-ccab6fa4771e": { "mute": false, "daily": false, "details": "0" }, "1e4be748-e072-4c1f-b1ff-a98f076b8e8e": { "mute": false, "daily": false }, "1fb8d435-3205-429c-9394-868add3e4822": { "mute": false, "daily": false }, "1fd6eac1-2db4-4520-bfc1-b5f972e392fc": { "mute": false, "daily": false }, "2107e444-9421-4ec8-a7d0-67ac23ed555c": { "mute": false, "daily": false, "details": [ "/Library/Application Support/Adobe/", "/Library/Application Support/regid.1986-12.com.adobe/", "/Library/Application Support/VMware/" ] }, "2ab1b190-c3b2-4f79-8fea-c5a147a0e564": { "mute": false, "daily": false }, "326e8ed6-0f21-4da6-87fc-00aada554c6d": { "mute": false, "daily": false, "details": 90 }, "3364fb4b-eb12-410a-a471-bc22e8b14725": { "mute": false, "daily": false }, "33c9548d-863a-4b9d-82a4-f9d7037054d6": { "mute": false, "daily": false, "details": 90 }, "34e7d714-5772-416d-9aff-c467504b45eb": { "mute": false, "daily": false }, "370625c0-77fe-4972-bac3-6be812fa4dd7": { "mute": false, "daily": false }, "3b176bde-d7bc-4086-9cfa-1cf8a6d32757": { "mute": false, "daily": false }, "3d81acd3-8d3d-4941-a88e-6b8b9147cc6a": { "mute": false, "daily": false, "details": { "corner": "wvous-br-corner", "method": 0 } }, "428d99a1-5ab0-4198-b248-7603d1c2e258": { "mute": false, "daily": false }, "42a3fdf6-3774-4f56-9fde-c286760a48bf": { "mute": false, "daily": false }, "43d198e0-50c6-43bb-ac7b-4fc5a165a056": { "mute": false, "daily": false }, "5112c772-bf78-4bf9-81a1-35e45ae2b915": { "mute": false, "daily": false }, "515313ac-99a2-4961-a132-40beef6291b2": { "mute": false, "daily": false, "details": 90 }, "51a763db-716c-4bfa-b721-2f303d203b3b": { "mute": false, "daily": false, "details": "0" }, "52ad1967-3d00-4cb3-93c4-92b49b95a446": { "mute": false, "daily": false }, "56171a5e-27e5-4d6e-86cf-8956ca3b7bca": { "mute": false, "daily": false }, "58513f4e-be5b-4726-8ed5-a9b337bbd973": { "mute": false, "daily": false }, "5d25c667-0635-4525-b400-fa93841b42e9": { "mute": false, "daily": false }, "5d78eebc-8552-4f9a-8236-44b9e7a4bff2": { "mute": false, "daily": false, "details": "0" }, "6d268d72-3859-458c-a413-9a7210b89719": { "mute": false, "daily": false }, "6e82a850-901a-47ec-9b4e-03393af029c9": { "mute": false, "daily": false, "details": 365 }, "776f1c86-54ea-4876-a226-a0a07040fec0": { "mute": false, "daily": false, "details": { "type": "text", "value": "This system is reserved for authorized use only, and the use of this system may be monitored." } }, "7888dff6-ad41-41f2-8f07-0f7c43a1c993": { "mute": false, "daily": false }, "7a49b60a-7793-4fb7-854d-aa12829a8e57": { "mute": false, "daily": false }, "7c368d56-88c9-45b4-b9a0-d389febbe027": { "mute": false, "daily": false }, "86e70b82-c7d6-4266-8a89-104e9dde6a30": { "mute": false, "daily": false }, "8c6b6864-3faa-47f1-b599-e13bb04682ed": { "mute": false, "daily": false, "details": "1" }, "8ed38311-50d7-4165-890e-ac3bdf55047e": { "mute": false, "daily": false }, "91e86fb9-1c25-45b0-b1ed-064f8a478409": { "mute": false, "daily": false, "details": [ { "flag": "lo", "prefix": "none" }, { "flag": "ad", "prefix": "none" }, { "flag": "fd", "prefix": "none" }, { "flag": "fm", "prefix": "none" }, { "flag": "all", "prefix": "-" } ] }, "93384921-61aa-46f6-a7d9-d45908babccc": { "mute": false, "daily": false, "details": false }, "986a50bc-7cea-4874-b61c-4b2b9b1c318b": { "mute": false, "daily": false }, "a1674edc-f788-424d-addc-dea91f3053f3": { "mute": false, "daily": false, "details": 30 }, "a189df03-cdfd-4c55-b429-95e7df5a7521": { "mute": false, "daily": false }, "af5c6286-f084-4369-a14b-7af9b5797aa8": { "mute": false, "daily": false }, "b3aed88b-199d-465c-9277-df152cdb0d5b": { "mute": false, "daily": false }, "b648790a-0fac-43b8-bd96-5682f60f467e": { "mute": false, "daily": false }, "b8fa043f-80bd-43d5-aea6-a94626d92c3a": { "mute": false, "daily": false }, "c248f070-6bce-42b1-9688-27d9bf4c1513": { "mute": false, "daily": false }, "c2f95015-c14e-49bd-8d89-27c3f5963dc1": { "mute": false, "daily": false }, "cbb3b9c5-2db4-476a-9faa-0c61b7354ec1": { "mute": false, "daily": false, "details": { "days": 60, "size": 1024, "unit": "MB", "modifier": "or" } }, "cc59e3c1-eb02-4021-afa2-50977a30cf0a": { "mute": false, "daily": false }, "cf19344c-572a-4359-a7f1-b02db1df1a43": { "mute": false, "daily": false }, "d011e3a4-eebe-4af2-adf8-aa41c11efacf": { "mute": false, "daily": false, "details": "time.apple.com" }, "d19e2f27-6ddb-41b1-b76a-1662b6330cd1": { "mute": false, "daily": false }, "da3834d5-c315-4ce0-980e-b650f675b630": { "mute": false, "daily": false }, "e5d41a12-a0be-42c8-ada8-0bc0cec1b465": { "mute": false, "daily": false }, "e5decad7-7cbf-49b4-99b0-d7e94a21fa47": { "mute": false, "daily": false }, "e5fbd8ad-e45b-4fa1-b900-21969fefd2ac": { "mute": false, "daily": false }, "ea3bb880-de67-4988-8266-ae2f4f81a05c": { "mute": false, "daily": false }, "f1f19efe-75a1-4ade-8456-8da539433728": { "mute": false, "daily": false }, "f228e471-2a6c-4046-b676-02b133a6239d": { "mute": false, "daily": false }, "f6b09eeb-a213-4fb5-8b09-1bb4d81583ab": { "mute": false, "daily": false }, "fb3b7d49-3ed4-4aa7-9c95-b60857783626": { "mute": false, "daily": false }, "fb63a562-062d-4679-9e16-3dd2453e726d": { "mute": false, "daily": false } }, "rating": 90 }, { "id": 10, "name": "Kandji Level II", "description": "All of the parameters enabled in Kandji Level I with additional items that include bolstered authentication, password complexity, logging, and data security.\n\nImportant: Always review and test thoroughly before deploying. Users day to day impact will be affected. It is recommended that you review these changes with end-users before deployment.", "category": 1, "icon": "ss-files", "color": "aqua-800", "params": { "0264078c-4555-4b7a-bd90-888eae867830": { "mute": false, "daily": false }, "0f692ac3-670e-4ee2-b207-3604bd54e32c": { "mute": false, "daily": false }, "135b1c65-a665-431b-b919-39e984d6d29d": { "mute": true, "daily": false }, "1e4be748-e072-4c1f-b1ff-a98f076b8e8e": { "mute": false, "daily": false }, "1fb8d435-3205-429c-9394-868add3e4822": { "mute": false, "daily": false }, "1fd6eac1-2db4-4520-bfc1-b5f972e392fc": { "mute": false, "daily": false }, "2ab1b190-c3b2-4f79-8fea-c5a147a0e564": { "mute": false, "daily": false }, "34e7d714-5772-416d-9aff-c467504b45eb": { "mute": false, "daily": false }, "370625c0-77fe-4972-bac3-6be812fa4dd7": { "mute": false, "daily": false }, "3b176bde-d7bc-4086-9cfa-1cf8a6d32757": { "mute": false, "daily": false }, "428d99a1-5ab0-4198-b248-7603d1c2e258": { "mute": false, "daily": false }, "5112c772-bf78-4bf9-81a1-35e45ae2b915": { "mute": false, "daily": false }, "52ad1967-3d00-4cb3-93c4-92b49b95a446": { "mute": false, "daily": false }, "56171a5e-27e5-4d6e-86cf-8956ca3b7bca": { "mute": false, "daily": false }, "58513f4e-be5b-4726-8ed5-a9b337bbd973": { "mute": false, "daily": false }, "5d78eebc-8552-4f9a-8236-44b9e7a4bff2": { "mute": false, "daily": false, "details": "0" }, "6d268d72-3859-458c-a413-9a7210b89719": { "mute": false, "daily": false }, "6e82a850-901a-47ec-9b4e-03393af029c9": { "mute": false, "daily": false, "details": 365 }, "7888dff6-ad41-41f2-8f07-0f7c43a1c993": { "mute": false, "daily": false }, "7c368d56-88c9-45b4-b9a0-d389febbe027": { "mute": false, "daily": false }, "86e70b82-c7d6-4266-8a89-104e9dde6a30": { "mute": false, "daily": false }, "8c6b6864-3faa-47f1-b599-e13bb04682ed": { "mute": false, "daily": false, "details": "0" }, "8ed38311-50d7-4165-890e-ac3bdf55047e": { "mute": false, "daily": false }, "91e86fb9-1c25-45b0-b1ed-064f8a478409": { "mute": false, "daily": false, "details": [ { "flag": "lo", "prefix": "none" }, { "flag": "ad", "prefix": "none" }, { "flag": "fd", "prefix": "none" }, { "flag": "fm", "prefix": "none" }, { "flag": "all", "prefix": "-" } ] }, "93384921-61aa-46f6-a7d9-d45908babccc": { "mute": false, "daily": false, "details": false }, "986a50bc-7cea-4874-b61c-4b2b9b1c318b": { "mute": false, "daily": false }, "b648790a-0fac-43b8-bd96-5682f60f467e": { "mute": false, "daily": false }, "cbb3b9c5-2db4-476a-9faa-0c61b7354ec1": { "mute": false, "daily": false, "details": { "days": 60, "size": 1024, "unit": "MB", "modifier": "or" } }, "cc59e3c1-eb02-4021-afa2-50977a30cf0a": { "mute": false, "daily": false }, "cf19344c-572a-4359-a7f1-b02db1df1a43": { "mute": false, "daily": false }, "d011e3a4-eebe-4af2-adf8-aa41c11efacf": { "mute": false, "daily": false, "details": "time.apple.com" }, "d19e2f27-6ddb-41b1-b76a-1662b6330cd1": { "mute": false, "daily": false }, "da3834d5-c315-4ce0-980e-b650f675b630": { "mute": false, "daily": false }, "e5d41a12-a0be-42c8-ada8-0bc0cec1b465": { "mute": false, "daily": false }, "ea3bb880-de67-4988-8266-ae2f4f81a05c": { "mute": false, "daily": false }, "f1f19efe-75a1-4ade-8456-8da539433728": { "mute": false, "daily": false }, "f6b09eeb-a213-4fb5-8b09-1bb4d81583ab": { "mute": false, "daily": false }, "fb63a562-062d-4679-9e16-3dd2453e726d": { "mute": false, "daily": false } }, "rating": 50 }, { "id": 9, "name": "Kandji Level I", "description": "A minimum level of security that is recommended for all businesses. Minimal user impact can be expected. \n\nImportant: Always review and test thoroughly before deploying. Users day to day impact will be affected. It is recommended that you review these changes with end-users before deployment.", "category": 1, "icon": "ss-files", "color": "aqua-800", "params": { "0264078c-4555-4b7a-bd90-888eae867830": { "mute": false, "daily": false }, "0f692ac3-670e-4ee2-b207-3604bd54e32c": { "mute": false, "daily": false }, "1e4be748-e072-4c1f-b1ff-a98f076b8e8e": { "mute": false, "daily": false }, "1fb8d435-3205-429c-9394-868add3e4822": { "mute": false, "daily": false }, "1fd6eac1-2db4-4520-bfc1-b5f972e392fc": { "mute": false, "daily": false }, "2ab1b190-c3b2-4f79-8fea-c5a147a0e564": { "mute": false, "daily": false }, "34e7d714-5772-416d-9aff-c467504b45eb": { "mute": false, "daily": false }, "428d99a1-5ab0-4198-b248-7603d1c2e258": { "mute": false, "daily": false }, "52ad1967-3d00-4cb3-93c4-92b49b95a446": { "mute": false, "daily": false }, "58513f4e-be5b-4726-8ed5-a9b337bbd973": { "mute": false, "daily": false }, "5d78eebc-8552-4f9a-8236-44b9e7a4bff2": { "mute": false, "daily": false, "details": "0" }, "6d268d72-3859-458c-a413-9a7210b89719": { "mute": false, "daily": false }, "6e82a850-901a-47ec-9b4e-03393af029c9": { "mute": false, "daily": false, "details": 365 }, "7888dff6-ad41-41f2-8f07-0f7c43a1c993": { "mute": false, "daily": false }, "86e70b82-c7d6-4266-8a89-104e9dde6a30": { "mute": false, "daily": false }, "8ed38311-50d7-4165-890e-ac3bdf55047e": { "mute": false, "daily": false }, "b648790a-0fac-43b8-bd96-5682f60f467e": { "mute": false, "daily": false }, "cbb3b9c5-2db4-476a-9faa-0c61b7354ec1": { "mute": false, "daily": false, "details": { "days": 60, "size": 1024, "unit": "MB", "modifier": "or" } }, "cf19344c-572a-4359-a7f1-b02db1df1a43": { "mute": false, "daily": false }, "d011e3a4-eebe-4af2-adf8-aa41c11efacf": { "mute": false, "daily": false, "details": "time.apple.com" }, "d19e2f27-6ddb-41b1-b76a-1662b6330cd1": { "mute": false, "daily": false }, "e5d41a12-a0be-42c8-ada8-0bc0cec1b465": { "mute": false, "daily": false }, "ea3bb880-de67-4988-8266-ae2f4f81a05c": { "mute": false, "daily": false }, "f1f19efe-75a1-4ade-8456-8da539433728": { "mute": false, "daily": false }, "f6b09eeb-a213-4fb5-8b09-1bb4d81583ab": { "mute": false, "daily": false }, "fb63a562-062d-4679-9e16-3dd2453e726d": { "mute": false, "daily": false } }, "rating": 30 } ] } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/enablelostmode": { "post": { "summary": "Enable Lost Mode", "description": "This endpoint sends an MDM command to remotely turn on lost mode on iOS and iPadOS.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "description": "Optional JSON payload to set lock message, phone number, and footnote on the target device", "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string", "description": "Lock screen message to display on the device" }, "PhoneNumber": { "type": "string", "description": "Phone number to display on the lock screen" }, "Footnote": { "type": "string", "description": "Footnote text to display on the lock screen" } } }, "example": { "Message": "Hey i just did this from the enable lost mode API", "PhoneNumber": "1234567890", "Footnote": "This is an example footnote." } } } }, "responses": { "200": { "description": "Enable Lost Mode", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/disablelostmode": { "post": { "summary": "Disable Lost Mode", "description": "This command will send a request to turn off lost mode on iOS and iPadOS.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Disable Lost Mode", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/playlostmodesound": { "post": { "summary": "Play Lost Mode Sound", "description": "This command will tell the target iOS or iPadOS device to play the lost mode sound.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Play Lost Mode Sound", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/updatelocation": { "post": { "summary": "Update Location", "description": "This endpoint sends an MDM command to update the location data on iOS and iPadOS.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update Location", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/clearpasscode": { "post": { "summary": "Clear Passcode", "description": "This endpoint sends an MDM command to clear a device passcode. Available for iPhone and iPad.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}": { "get": { "summary": "Get Device", "description": "This request returns the high-level information for a specified Device ID.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "patch": { "summary": "Update Device", "description": "This request allows you to update device information, such as the assigned blueprint, user, Asset Tag, ", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "string", "description": "The user ID (UUID or deprecated integer value). Can be set to null to clear the assigned user." }, "asset_tag": { "type": "string", "description": "The asset tag for the device. Can be set to null to clear the asset tag." }, "blueprint_id": { "type": "string", "description": "The blueprint ID to assign to the device." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Array of tag names to assign to the device. Can be set to [] to clear all tags." } } } } } }, "responses": { "200": { "description": "Clear all tags", "content": { "application/json": { "schema": { "type": "object", "example": { "device_id": "bd4eb679-d679-4071-a395-5855807b6829", "device_name": "avenger-test", "model": "MacBook Air (M1, 2020)", "serial_number": "C02FL5YXQ6LC", "platform": "Mac", "os_version": "13.2.1", "last_check_in": "2023-03-24T00:45:18.674561Z", "user": "", "asset_tag": "", "blueprint_id": "97e4e175-1631-43f6-a02b-33fd1c748ab8", "mdm_enabled": true, "agent_installed": true, "is_missing": false, "is_removed": false, "agent_version": "4.1.3 (3795)", "first_enrollment": "2022-07-21 15:00:06.470889+00:00", "last_enrollment": "2023-03-13 17:29:41.167646+00:00", "blueprint_name": "_testing_apple_silicon", "lost_mode_status": "", "tags": [] } }, "example": { "device_id": "bd4eb679-d679-4071-a395-5855807b6829", "device_name": "avenger-test", "model": "MacBook Air (M1, 2020)", "serial_number": "C02FL5YXQ6LC", "platform": "Mac", "os_version": "13.2.1", "last_check_in": "2023-03-24T00:45:18.674561Z", "user": "", "asset_tag": "", "blueprint_id": "97e4e175-1631-43f6-a02b-33fd1c748ab8", "mdm_enabled": true, "agent_installed": true, "is_missing": false, "is_removed": false, "agent_version": "4.1.3 (3795)", "first_enrollment": "2022-07-21 15:00:06.470889+00:00", "last_enrollment": "2023-03-13 17:29:41.167646+00:00", "blueprint_name": "_testing_apple_silicon", "lost_mode_status": "", "tags": [] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "delete": { "summary": "Delete device", "description": "This endpoint deletes a specific device.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Device deleted successfully" } } } }, "/api/v1/devices/{device_id}/action/erase": { "post": { "summary": "Erase Device", "description": "This endpoint sends an MDM command to erase the device.\niOS 4.0+, iPadOS 4.0+, macOS 10.7+, tvOS 10.2+", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "PIN": { "type": "string", "description": "The six-character PIN for Find My. This value is available in macOS 10.8 and later. Note: This value will be ignored for iOS, iPadOS, and tvOS devices." }, "PreserveDataPlan": { "type": "boolean", "description": "If true, preserve the data plan on an iPhone or iPad with eSIM functionality, if one exists. This value is available in iOS 11 and later. Default: true" }, "DisallowProximitySetup": { "type": "boolean", "description": "If true, disable Proximity Setup on the next reboot and skip the pane in Setup Assistant. This value is available in iOS 11 and later. Prior to iOS 14, don't use this option with any other option. Default: false" }, "ReturnToService": { "type": "object", "description": "(iOS 17 and later and iPadOS 17 and later and with Shared iPad) When sending the erase device command to mobile devices, use this key to enable Return to Service. Include an optional Wi-Fi payload ProfileId to allow the device to connect to a Wi-Fi network automatically after being erased. If a Wi-Fi ProfileId is not provided and the mobile device is not tethered to a Mac to share the network connection, the end-user will be required to select a Wi-Fi network to complete the setup. If sent to any macOS computer or to mobile devices on iOS 16 or iPadOS 16 and below, the RTS keys will be ignored, and only the erase device command will be issued to the device.", "properties": { "Enabled": { "type": "boolean", "description": "(Required) If true, the device tries to re-enroll itself automatically after erasure. The user needs to deactivate all activation locks for this feature to work correctly." }, "ProfileId": { "type": "string", "description": "Profile ID value associated with a Wi-Fi profile payload. This is required when the device doesn't have ethernet access." } } } } }, "example": { "PIN": "123456", "PreserveDataPlan": true, "DisallowProximitySetup": false, "ReturnToService": { "Enabled": false, "ProfileId": "" } } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/commands": { "get": { "summary": "Get Device Commands", "description": "This endpoint sends a request to get information about the commands sent to a given device ID.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper `limit` is set at 300 device records returned per request. If more device records are expected, pagination should be used using the `limit` and `offset` parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "The initial index from which to return the results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get Device Commands", "content": { "application/json": { "schema": { "type": "object", "example": { "device_id": "0bc8f610-5b88-49a6-b9ef-a68bf04e1e59", "commands": { "count": 41, "next": null, "previous": null, "results": [ { "uuid": "d2b2eafe-2dc2-4b13-bd2b-f93735f0e59f", "error_chain": [], "command_type": "ActivationLockBypassCode", "request_type": "ActivationLockBypassCode", "metadata": {}, "request_requires_network_tether": false, "status": 3, "attempts": 1, "date_requested": "2022-08-18T15:07:22.133248Z", "date_completed": "2022-08-18T15:07:23.240937Z", "last_pushed": "2022-08-18T15:07:22.507520Z", "user": null, "priority": 0 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/lock": { "post": { "summary": "Lock Device", "description": "This endpoint sends an MDM command to remotely lock a device.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string", "description": "The lock message to display on the device." }, "PhoneNumber": { "type": "string", "description": "The phone number to display on the device." } } }, "example": { "Message": "This device is locked!", "PhoneNumber": "1234567890" } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "PIN": "496406" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/reinstallagent": { "post": { "summary": "Reinstall Agent", "description": "This endpoint sends an MDM command reinstall the Kandji Agent.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/remotedesktop": { "post": { "summary": "Remote Desktop", "description": "This endpoint sends an MDM command to control the Remote Management status on a Mac.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "EnableRemoteDesktop": { "type": "boolean", "description": "Enable or disable Remote Desktop on the device" } }, "required": [ "EnableRemoteDesktop" ] }, "example": { "EnableRemoteDesktop": true } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/renewmdmprofile": { "post": { "summary": "Renew MDM Profile", "description": "This endpoint sends an MDM command to re-install the existing root MDM profile for a given device ID.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Renew MDM Profile", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/restart": { "post": { "summary": "Restart Device", "description": "This endpoint sends an MDM command to remotely restart a device.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "RebuildKernelCache": { "type": "boolean", "description": "If `true`, the system rebuilds the kernel cache during a device restart. If `BootstrapTokenAllowedForAuthentication` is `true` in `SecurityInfoResponse.SecurityInfo`, the device requests the bootstrap token from MDM before executing this command. This value is available in macOS 11 and later. Default: false" }, "NotifyUser": { "type": "boolean", "description": "If `true`, notifies the user to restart the device at their convenience. Forced restart if the device is at `loginwindow` with no logged-in users. The user can dismiss the notification and ignore the request. No further notifications display unless you resend the command. This value is available in macOS 11.3 and later. Default: false" } } }, "example": { "RebuildKernelCache": false, "NotifyUser": false } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/blankpush": { "post": { "summary": "Send Blankpush", "description": "This endpoint sends an MDM command to initiate a blank push.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/setname": { "post": { "summary": "Set Name", "description": "This endpoint sends an MDM command to set the device name.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "DeviceName": { "type": "string", "description": "The new device name to set." } }, "required": [ "DeviceName" ] }, "example": { "DeviceName": "Test Mac Mini" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/shutdown": { "post": { "summary": "Shutdown", "description": "This endpoint sends an MDM command to shutdown a device.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/updateinventory": { "post": { "summary": "Update Inventory", "description": "This endpoint sends an MDM command to start a check-in for a device, initiating the daily MDM commands and MDM logic.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/unlockaccount": { "post": { "summary": "Unlock Account", "description": "This endpoint sends an MDM command to unlock a user account that was locked by the system because of too many failed password attempts.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "UserName": "LocalUserToUnlock" } } } } } } }, "/api/v1/devices/{device_id}/notes": { "get": { "summary": "Get Device Notes", "description": "This request gets all notes for the specified Device ID.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get All Device Notes", "content": { "application/json": { "schema": { "type": "object", "example": [ { "note_id": "e74f34b0-120b-4149-9c0d-3e2f0d08426c", "created_at": "2021-04-09T17:09:07.164617Z", "updated_at": "2021-04-09T17:09:07.164635Z", "author": "Test User", "content": "

This is an example note! 

" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "post": { "summary": "Create Device Note", "description": "This request creates a note for the specified device ID.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the device note." } }, "required": [ "content" ] } } } }, "responses": { "201": { "description": "Create Device Note", "content": { "application/json": { "schema": { "type": "object", "example": { "note_id": "c0f5ba78-06a2-4914-aa3c-e3415f3ee21b", "created_at": "2021-04-07T18:56:25.113229Z", "updated_at": "2021-04-07T18:56:25.113254Z", "author": "Test User", "content": "This is an example note!" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/notes/{note_id}": { "get": { "summary": "Retrieve Device Note", "description": "This request retrieves a specified note (Note ID) for the specified Device ID.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Retrieve Device Note", "content": { "application/json": { "schema": { "type": "object", "example": { "note_id": "c0f5ba78-06a2-4914-aa3c-e3415f3ee21b", "created_at": "2021-04-07T18:56:25.113229Z", "updated_at": "2021-04-07T18:56:25.113254Z", "author": "Nicholas McDonald", "content": "This is an example note!" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "patch": { "summary": "Update Device Note", "description": "This request patches a specified note (Note ID) for the specified Device ID.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "description": "The updated content of the device note." } }, "required": [ "content" ] } } } }, "responses": { "200": { "description": "Update Device Note", "content": { "application/json": { "schema": { "type": "object", "example": { "note_id": "c0f5ba78-06a2-4914-aa3c-e3415f3ee21b", "created_at": "2021-04-07T18:56:25.113229Z", "updated_at": "2021-04-07T18:56:25.113254Z", "author": "Test User", "content": "This is an example of updating a notes contents!" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "delete": { "summary": "Delete Device Note", "description": "This request deletes a specified note (Note ID) for the specified Device ID.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete Device Note", "content": { "application/json": { "schema": { "type": "object", "example": { "note_id": "c0f5ba78-06a2-4914-aa3c-e3415f3ee21b", "deleted_at": "2021-04-07T18:59:17.734091Z" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices": { "get": { "summary": "List Devices", "description": "This request returns a list of devices in an Iru Endpoint Management tenant.", "parameters": [ { "name": "asset_tag", "in": "query", "required": false, "description": "Filter by asset tag", "schema": { "type": "string" } }, { "name": "blueprint_id", "in": "query", "required": false, "description": "Return results \"containing\" the specified blueprint id", "schema": { "type": "string" } }, { "name": "device_id", "in": "query", "required": false, "description": "Filter by device ID", "schema": { "type": "string" } }, { "name": "device_name", "in": "query", "required": false, "description": "Filter by device name", "schema": { "type": "string" } }, { "name": "filevault_enabled", "in": "query", "required": false, "description": "Query for devices that either have FileVault on (true) or off (false). This parameter only applies to macOS. An empty list will be returned if no devices are found with the given parameter value.", "schema": { "type": "string" } }, { "name": "mac_address", "in": "query", "required": false, "description": "Search for a specific device by MAC address", "schema": { "type": "string" } }, { "name": "model", "in": "query", "required": false, "description": "Return model results \"containing\" the specified model string", "schema": { "type": "string" } }, { "name": "ordering", "in": "query", "required": false, "description": "The ordering parameter can be used to define how the device records are ordered in the response. Prepending a dash (-) to the parameter value will reverse the order of the returned results. Possible values are asset_tag, blueprint_id, device_id, device_name, last_check_in, model, platform, os_version, serial_number, user. Multiple values can be combined in a comma separated list.", "schema": { "type": "string" } }, { "name": "os_version", "in": "query", "required": false, "description": "Return all device records containing the specified OS version", "schema": { "type": "string" } }, { "name": "platform", "in": "query", "required": false, "description": "Return all records matching a specific platform. Possible values are Mac, iPad, iPhone, AppleTV", "schema": { "type": "string" } }, { "name": "serial_number", "in": "query", "required": false, "description": "Search for a specific device by Serial Number. If partial serial number is provided in the query, all device containing the partial string will be returned", "schema": { "type": "string" } }, { "name": "tag_name", "in": "query", "required": false, "description": "Return results for given tag name. Case sensitive", "schema": { "type": "string" } }, { "name": "tag_name_in", "in": "query", "required": false, "description": "Return results for given tag names separate by commas. Case sensitive", "schema": { "type": "string" } }, { "name": "tag_id", "in": "query", "required": false, "description": "Search for a tag by its ID. Case sensitive", "schema": { "type": "string" } }, { "name": "tag_id_in", "in": "query", "required": false, "description": "Return results for given tag IDs separated by commas. Case sensitive", "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": false, "description": "Return results \"containing\" the user name", "schema": { "type": "string" } }, { "name": "user_email", "in": "query", "required": false, "description": "Return results \"containing\" search on email address", "schema": { "type": "string" } }, { "name": "user_email_exact", "in": "query", "required": false, "description": "Return results \"matching\" the specified email address", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "description": "exact match on kandji user ID", "schema": { "type": "string" } }, { "name": "user_name", "in": "query", "required": false, "description": "Return results \"containing\" the assigned user Display Name", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/details": { "get": { "summary": "Get Device Details", "description": "This request returns the device details for a specified Device ID.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/details/lostmode": { "get": { "summary": "Get device lost mode details", "description": "This request returns lost mode details for a device.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lost mode details", "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "description": "The unique identifier of the device" }, "lost_mode": { "type": "object", "properties": { "lost_mode_status": { "type": "string", "description": "The current status of Lost Mode", "enum": [ "ENABLED", "DISABLED" ] }, "enabled_by": { "type": "string", "description": "The user who enabled Lost Mode" }, "enable_status_at": { "type": "string", "format": "date-time", "description": "When Lost Mode was enabled" }, "lock_screen_message": { "type": "string", "description": "The message displayed on the lock screen" }, "lock_screen_phone_number": { "type": "string", "description": "The phone number displayed on the lock screen" }, "lock_screen_footnote": { "type": "string", "description": "The footnote displayed on the lock screen" }, "disable_status": { "type": "string", "description": "The status of disabling Lost Mode" }, "disabled_by": { "type": "string", "description": "The user who disabled Lost Mode" }, "disable_status_at": { "type": "string", "format": "date-time", "description": "When Lost Mode was disabled" }, "last_location_status": { "type": "string", "description": "The status of the last location update", "enum": [ "SUCCESS", "FAILED" ] }, "last_location_status_at": { "type": "string", "format": "date-time", "description": "When the last location status was updated" }, "last_location": { "type": "object", "properties": { "latitude": { "type": "string", "description": "The latitude of the last known location" }, "longitude": { "type": "string", "description": "The longitude of the last known location" } } }, "last_location_at": { "type": "string", "format": "date-time", "description": "When the last location was recorded" }, "sound_status": { "type": "string", "description": "The status of the Lost Mode sound", "enum": [ "SUCCESS", "FAILED" ] }, "sound_status_at": { "type": "string", "format": "date-time", "description": "When the sound status was last updated" } } } } }, "example": { "device_id": "4820db3b-dec7-40b2-9c8f-eb771ac1a250", "lost_mode": { "lost_mode_status": "ENABLED", "enabled_by": "Accuhive Admin", "enable_status_at": "2022-12-13T20:19:08.116096Z", "lock_screen_message": "Hey i just did this from the enable lost mode API", "lock_screen_phone_number": "1234567890", "lock_screen_footnote": "This is an example footnote.", "disable_status": "", "disabled_by": "", "disable_status_at": "", "last_location_status": "SUCCESS", "last_location_status_at": "2022-12-13T20:20:10.103693Z", "last_location": { "latitude": "33.93410519355257", "longitude": "-84.47411387632086" }, "last_location_at": "2022-12-13T20:20:10.093380Z", "sound_status": "SUCCESS", "sound_status_at": "2022-12-13T20:21:38.992261Z" } } } } } } }, "delete": { "summary": "Cancel Lost Mode", "description": "This endpoint can be used to send a cancelation request if Lost Mode is in an error state for a given iOS or iPadOS device.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lost Mode cancellation request sent successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" } } } } } } } } }, "/api/v1/devices/{device_id}/activity": { "get": { "summary": "Get Device Activity", "description": "This request returns the device activity for a specified Device ID.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/apps": { "get": { "summary": "Get Device Apps", "description": "This request returns a list of all installed apps for a specified Device ID.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/library-items": { "get": { "summary": "Get Device Library Items", "description": "This request gets all library items and their statuses for a specified Device ID\n#### Possible library item status values", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "edr status", "content": { "application/json": { "schema": { "type": "object", "example": { "device_id": "bd4eb679-d679-4071-a395-5855807b6829", "library_items": [ { "id": 14603, "status": "PENDING", "reported_at": null, "log": null, "last_audit_run": null, "last_audit_log": null, "control_log": null, "control_reported_at": null, "item_id": "f16e7f13-ba73-4c30-9640-a31b2758bcbe", "name": "Avert", "type": "threat-security-policy", "computer": { "id": "912bc505-a7ee-4d0b-906d-2102f332a4b3", "name": "testuser’s MacBook Air" }, "blueprint": { "id": "ab102b9d-8e9c-420d-a498-f2a1123091c7", "name": "_test_something" }, "rules_present": false, "edr_status": { "status": "enabled", "malware_posture": "Protect", "pup_posture": "Protect", "last_baseline_scan": "Feb 27, 2024 at 7:34:21 AM", "next_baseline_scan": "Mar 26, 2024 at 5:48:10 AM", "baseline_scan_runtime": "Kandji checked 339,254 files in 3 minutes, 41 seconds." } } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/parameters": { "get": { "summary": "Get Device Parameters", "description": "This request returns the parameters and their statuses for a specified Device ID", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get Device Parameters", "content": { "application/json": { "schema": { "type": "object", "example": { "device_id": "77883d40-5656-4a24-9d70-49b6e751a923", "parameters": [ { "status": "PASS", "item_id": "1e4be748-e072-4c1f-b1ff-a98f076b8e8e", "name": "Disable the \"root\" user", "category": "User Accounts & Authentication", "subcategory": "User Accounts" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/status": { "get": { "summary": "Get Device Status", "description": "This request returns the full status (parameters and library items) for a specified Device ID.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get Device Status", "content": { "application/json": { "schema": { "type": "object", "example": { "device_id": "77883d40-5656-4a24-9d70-49b6e751a923", "library_items": [ { "id": 1222, "item_id": "4a98cb3d-3b55-46bf-829d-7dd7bd6ed832", "name": "zoom", "status": "PASS", "reported_at": "2021-05-11T19:45:19Z", "type": "custom-app", "last_audit_log": "Executing audit script...\nScript exited with non-zero status.", "log": "Executing audit script...\nScript exited with non-zero status.\nDownloading zoom\nCompleted download in four minutes, fifty seconds.\nInstalling zoom\nCompleted package installation in four seconds." }, { "id": 1218, "item_id": "b81b0ed6-c703-45a0-8d49-8255ff21d413", "name": "Microsoft Edge", "status": "PASS", "reported_at": "2021-05-10T17:20:55Z", "type": "automatic-app", "last_audit_log": "Kandji is set to automatically enforce updates for Microsoft Edge two weeks after they are released.\nMicrosoft Edge 90.0.818.56 is installed, which is newer than the version being enforced.", "log": "Downloading Microsoft Edge\nCompleted download in six seconds.\nInstalling Microsoft Edge\nCompleted package installation in twenty-three seconds.\nAdded icon to end of Dock for all users." }, { "id": 1224, "item_id": "59be1e8e-5ba5-4bbc-bead-8b3e2006c3e5", "name": "Custom Script", "status": "PASS", "reported_at": "2021-05-10T17:20:55Z", "type": "custom-script", "last_audit_log": null, "log": "Executing Custom Script...\nExit code: 0" }, { "id": 1220, "item_id": "e517e593-5d9b-4492-abc1-64247f242f21", "name": "Brave", "status": "PASS", "reported_at": "2021-05-10T17:20:55Z", "type": "automatic-app", "last_audit_log": "Brave 81.1.8.95 is installed and up to date.\nKandji is set to enforce a minimum version (81.1.8.95) of Brave.", "log": "Downloading Brave\nCompleted download in three seconds.\nInstalling Brave\nCompleted package installation in eight seconds." }, { "id": 1219, "item_id": "ba02261d-e482-4e4f-b0ce-c108ba7b35a4", "name": "Firefox", "status": "PASS", "reported_at": "2021-05-10T17:20:55Z", "type": "automatic-app", "last_audit_log": "Firefox 82.0.2 is installed and up to date.\nKandji is set to enforce a minimum version (82.0.2) of Firefox.", "log": "Downloading Firefox\nCompleted download in three seconds.\nInstalling Firefox\nCompleted package installation in seven seconds." }, { "id": 1221, "item_id": "62189209-7f84-4132-a4f7-89a12cb5a9c3", "name": "Atom", "status": "PASS", "reported_at": "2021-05-10T17:20:55Z", "type": "automatic-app", "last_audit_log": "Atom 1.53.0 is installed and up to date.\nKandji is set to enforce a minimum version (1.46.0) of Atom.", "log": "Downloading Atom\nCompleted download in six seconds.\nInstalling Atom\nCompleted package installation in one minute, one second.\nAdded icon to end of Dock for all users." }, { "id": 1225, "item_id": "ae55bb5f-d1fc-4bab-a2ca-d4f34c703b5f", "name": "Notion", "status": "PASS", "reported_at": "2021-05-10T17:20:55Z", "type": "automatic-app", "last_audit_log": "Notion 2.0.7 is installed and up to date.\nKandji is set to enforce a minimum version (2.0.7) of Notion.", "log": "Downloading Notion\nCompleted download in four seconds.\nInstalling Notion\nCompleted package installation in ten seconds." }, { "id": 1223, "item_id": "73be2f87-6ea8-4db9-8e42-af8a4dfec36f", "name": "Chrome", "status": "PASS", "reported_at": "2021-05-10T17:20:55Z", "type": "custom-app", "last_audit_log": null, "log": "Downloading Chrome\nCompleted download in two seconds.\nInstalling Chrome\nCompleted package installation in twenty-four seconds." } ], "parameters": [ { "status": "PASS", "item_id": "1e4be748-e072-4c1f-b1ff-a98f076b8e8e", "name": "Disable the \"root\" user", "category": "User Accounts & Authentication", "subcategory": "User Accounts" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/secrets/bypasscode": { "get": { "summary": "Get Activation Lock Bypass Code", "description": "This request allows you to retrieve the Activation Lock Bypass code.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "user_based_albc": { "type": "string", "description": "The user-based Activation Lock bypass code for when Activation Lock is enabled using a personal Apple ID and Find My", "example": "A00M6-04XTY-YDMG-JNTE-EMZ3-FTJ5" }, "device_based_albc": { "type": "string", "description": "The device-based Activation Lock bypass code for when Activation Lock is enabled by the MDM server", "example": "A00M6-04XTY-YDMG-JNTE-EMZ3-FTJ5" } }, "required": [ "user_based_albc", "device_based_albc" ] }, "example": { "user_based_albc": "A00M6-04XTY-YDMG-JNTE-EMZ3-FTJ5", "device_based_albc": "A00M6-04XTY-YDMG-JNTE-EMZ3-FTJ5" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/secrets/filevaultkey": { "get": { "summary": "Get FileVault Recovery Key", "description": "This request allows you to retrieve the FileVault Recovery key for a macOS device.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "key": "9A2U-CDK6-P6NH-FAB3-LTUH-2MYP" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/secrets/unlockpin": { "get": { "summary": "Get Unlock Pin", "description": "This request allows you to retrieve the device unlock pin for a macOS device.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "pin": "192746" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/secrets/recoverypassword": { "get": { "summary": "Get Recovery Lock Password", "description": "This request returns the Recovery Lock password.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "recovery_password": "AAAAA-BBBBB-CCCC-1111-2222-3333" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/library/custom-apps": { "get": { "summary": "List Custom Apps", "description": "This endpoint makes a request to retrieve a list of custom apps from the Iru Endpoint Management library.", "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Optional page number. Used when results exceed pagination threshold. A hard upper limit is set at 300 device records returned per request.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Number of results to return per page. A hard upper limit is set at 300 records returned per request.", "schema": { "type": "integer", "minimum": 1, "maximum": 300, "default": 300 }, "example": 300 }, { "name": "offset", "in": "query", "required": false, "description": "The initial index from which to return the results. Used for offset-based pagination.", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "example": 0 } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 2, "next": null, "previous": null, "results": [ { "id": "03fd3564-1e29-433f-8e67-6f987f3d242d", "name": "ms_company_portal", "file_key": "companies/companies/28344fcc-579a-4d42-bcf7-cdbf97585066/library/custom_apps/CompanyPortal_5.2310.5-Installer_0f04055b.pkg", "install_type": "package", "install_enforcement": "install_once", "audit_script": "", "unzip_location": "", "active": true, "restart": false, "preinstall_script": "", "postinstall_script": "", "file_url": "shortlived S3 URL", "file_size": 42375997, "file_updated": "2024-01-20T20:07:48Z", "created_at": "2024-01-20T20:07:53.612150Z", "updated_at": "2024-02-26T22:31:53.632505Z", "show_in_self_service": false } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "post": { "summary": "Create Custom App", "description": "This request allows you to create a custom app in the Iru Endpoint Management library.", "parameters": [], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name for this Custom App" }, "file_key": { "type": "string", "description": "The S3 key from the Upload Custom App endpoint used to upload the custom app file." }, "install_type": { "type": "string", "description": "Options are package, zip, image" }, "install_enforcement": { "type": "string", "description": "Options are install_once, continuously_enforce, no_enforcement" }, "audit_script": { "type": "string", "description": "Optional audit script for the custom app." }, "unzip_location": { "type": "string", "description": "Optional unzip location for the custom app." }, "active": { "type": "boolean", "description": "Whether the custom app is active." }, "restart": { "type": "boolean", "description": "Whether to restart after installation." }, "preinstall_script": { "type": "string", "description": "Optional preinstall script." }, "postinstall_script": { "type": "string", "description": "Optional postinstall script." } }, "required": [ "name", "file_key", "install_type", "install_enforcement" ] }, "example": { "name": "Custom Apps Test", "file_key": "companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg", "install_type": "package", "install_enforcement": "install_once", "audit_script": "", "unzip_location": "", "active": "true", "restart": "false", "preinstall_script": "", "postinstall_script": "" } } } }, "responses": { "201": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "58429143-b55c-42d3-a9a3-7c699ddd0ce1", "name": "Custom Apps Test", "file_key": "companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg", "install_type": "package", "install_enforcement": "install_once", "audit_script": "", "unzip_location": "", "active": true, "restart": false, "preinstall_script": "", "postinstall_script": "", "file_url": "(temporary download link from S3)", "sha256": "30e14955ebf1352266dc2ff8067e68104607e750abb9d3b36582b8af909fcb58", "file_size": 1048576, "file_updated": "2023-10-05T21:25:19Z", "created_at": "2023-10-13T17:25:45.868709Z", "updated_at": "2023-10-13T17:25:45.868789Z", "show_in_self_service": true, "self_service_category_id": "e6f6d5b4-0659-4b37-872c-5471115d453b", "self_service_recommended": true } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/library/custom-apps/{library_item_id}": { "get": { "summary": "Get Custom App", "description": "This endpoint retrieves details about a specific custom app from the Kandji library.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "03fd3564-1e29-433f-8e67-6f987f3d242d", "name": "ms_company_portal", "file_key": "companies/companies/28344fcc-579a-4d42-bcf7-cdbf97585066/library/custom_apps/CompanyPortal_5.2310.5-Installer_0f04055b.pkg", "install_type": "package", "install_enforcement": "install_once", "audit_script": "", "unzip_location": "", "active": true, "restart": false, "preinstall_script": "", "postinstall_script": "", "file_url": "shortlived S3 URL", "file_size": 42375997, "file_updated": "2024-01-20T20:07:48Z", "created_at": "2024-01-20T20:07:53.612150Z", "updated_at": "2024-02-26T22:31:53.632505Z", "show_in_self_service": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "patch": { "summary": "Update Custom App", "description": "This request allows you to update a custom app in the Iru Endpoint Management library.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name for this Custom App" }, "install_enforcement": { "type": "string", "description": "Options are install_once, continuously_enforce, no_enforcement" }, "file_key": { "type": "string", "description": "The S3 key used to upload the file" }, "install_type": { "type": "string", "description": "Options are package, zip, image" }, "audit_script": { "type": "string", "description": "Optional audit script for the custom app." }, "unzip_location": { "type": "string", "description": "Optional unzip location for the custom app." }, "active": { "type": "boolean", "description": "Whether the custom app is active." }, "restart": { "type": "boolean", "description": "Whether to restart after installation." }, "preinstall_script": { "type": "string", "description": "Optional preinstall script." }, "postinstall_script": { "type": "string", "description": "Optional postinstall script." } } }, "example": { "name": "Custom App 3", "install_enforcement": "install_once", "file_key": "companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg", "install_type": "package", "audit_script": "", "unzip_location": "", "active": "true", "restart": "false", "preinstall_script": "", "postinstall_script": "" } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "58429143-b55c-42d3-a9a3-7c699ddd0ce1", "name": "New Custom App Test Name", "file_key": "companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg", "install_type": "package", "install_enforcement": "install_once", "audit_script": "", "unzip_location": "", "active": true, "restart": false, "preinstall_script": "", "postinstall_script": "", "file_url": "(temporary S3 download URL)", "sha256": "30e14955ebf1352266dc2ff8067e68104607e750abb9d3b36582b8af909fcb58", "file_size": 1048576, "file_updated": "2023-10-05T21:25:19Z", "created_at": "2023-10-13T17:25:45.868709Z", "updated_at": "2023-10-13T17:28:30.388475Z", "show_in_self_service": true, "self_service_category_id": "e6f6d5b4-0659-4b37-872c-5471115d453b", "self_service_recommended": true } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "delete": { "summary": "Delete Custom App", "description": "This endpoint sends a request to delete a specific custom app from the Kandji library.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/library/custom-apps/upload": { "post": { "summary": "Upload Custom App", "description": "This request retrieves the S3 upload details need for uploading the app to Amazon S3.", "parameters": [], "responses": { "201": { "description": "success - create s3 upload", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "required": true, "description": "JSON payload containing the name of the file being uploaded", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Required - name of file being uploaded", "example": "example.pkg" } }, "required": [ "name" ] }, "example": { "name": "example.pkg" } } } } } }, "/api/v1/library/ipa-apps": { "get": { "summary": "List In-House Apps", "description": "This endpoint returns a list of In-House App Library Items in your Iru Endpoint Management tenant.", "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Optional page number. Used when results exceed pagination threshold. A hard upper limit is set at 300 app records returned per request.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Number of results to return per page. A hard upper limit is set at 300 records returned per request.", "schema": { "type": "integer", "minimum": 1, "maximum": 300, "default": 300 }, "example": 300 }, { "name": "offset", "in": "query", "required": false, "description": "The initial index from which to return the results. Used for offset-based pagination.", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "example": 0 } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 2, "next": null, "previous": null, "results": [ { "id": "13cc4ab7-0380-4d64-b80f-d2c22136e522", "name": "Sammy 1.0.1", "file_key": "tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce.ipa", "active": true, "icon": "tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce-Icon.png", "ipad_icon": "tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce-IpadIcon.png", "identifier": "io.kandji.sammy", "app_identifier": "io.kandji.sammy", "app_name": "Sammy", "app_version": "1.0.1", "supported_device_families": [ "iPhone", "iPad" ], "minimum_os_version": "17.5", "file_url": "https://{sub_domain}.api.kandji.io/tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce.ipa?auth=eyJhbGci...ubVg", "sha256": "862031764fc7368cde2a2267c4891b212b4bbc94aa0534b89be2f6294b8547f0", "file_size": 2191516, "file_updated": "2024-10-22T19:45:42Z", "created_at": "2024-10-22T19:46:13.080681Z", "updated_at": "2024-10-22T19:46:13.080707Z", "runs_on_iphone": true, "runs_on_ipad": true, "runs_on_tv": false, "runs_on_mac": false, "runs_on_ipod": false, "runs_on_watch": false }, { "id": "26403d86-146c-4b34-ae05-e44f08ee5807", "name": "Sammy 1.0.4", "file_key": "tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_1.0.4_48b8d621.ipa", "active": true, "icon": "tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_1.0.4_48b8d621-Icon.png", "ipad_icon": "tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_1.0.4_48b8d621-IpadIcon.png", "identifier": "io.kandji.sammy", "app_identifier": "io.kandji.sammy", "app_name": "Sammy", "app_version": "1.0.4", "supported_device_families": [ "iPhone", "iPad" ], "minimum_os_version": "17.5", "file_url": "https://{sub_domain}.api.kandji.io/tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_1.0.4_48b8d621.ipa?auth=eyJhbGci...9HaQ", "sha256": "a502ada7d4b6f5eace779889a9149229fa1d385444b008fe752e43d2c8ea1863", "file_size": 2191525, "file_updated": "2024-10-30T15:50:37Z", "created_at": "2024-10-30T15:50:50.642163Z", "updated_at": "2024-10-30T15:50:50.642182Z", "runs_on_iphone": true, "runs_on_ipad": true, "runs_on_tv": false, "runs_on_mac": false, "runs_on_ipod": false, "runs_on_watch": false } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "post": { "summary": "Create In-House App", "description": "This endpoint creates a new In-House App Library Item in the Kandji library.", "parameters": [], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "required": true, "description": "JSON payload containing the in-house app configuration", "content": { "application/json": { "schema": { "type": "object", "properties": { "file_key": { "type": "string", "description": "The file key generated from the Upload In-House App to S3 endpoint", "example": "companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/test_app_18cf0dfc.ipa" }, "name": { "type": "string", "description": "Arbitrary value used for setting the name of the Library Item as it appears in Iru Endpoint Management", "example": "My In-House App" }, "runs_on_iphone": { "type": "boolean", "description": "Whether the app runs on iPhone", "example": true }, "runs_on_ipad": { "type": "boolean", "description": "Whether the app runs on iPad", "example": true }, "runs_on_tv": { "type": "boolean", "description": "Whether the app runs on Apple TV", "example": false }, "active": { "type": "boolean", "description": "Whether the app is active", "example": true } }, "required": [ "file_key", "name" ] }, "example": { "file_key": "companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/test_app_18cf0dfc.ipa", "name": "My In-House App", "runs_on_iphone": true, "runs_on_ipad": true, "runs_on_tv": false, "active": true } } } } } }, "/api/v1/library/ipa-apps/{library_item_id}": { "get": { "summary": "Get In-House App", "description": "This endpoint retrieves information about a specific In-House App Library Item.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "13cc4ab7-0380-4d64-b80f-d2c22136e522", "name": "Sammy 1.0.1", "file_key": "tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce.ipa", "active": true, "icon": "tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce-Icon.png", "ipad_icon": "tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce-IpadIcon.png", "identifier": "io.kandji.sammy", "app_identifier": "io.kandji.sammy", "app_name": "Sammy", "app_version": "1.0.1", "supported_device_families": [ "iPhone", "iPad" ], "minimum_os_version": "17.5", "file_url": "https://{sub_domain}.api.kandji.io/tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce.ipa?auth=eyJhbGci...ubVg", "sha256": "862031764fc7368cde2a2267c4891b212b4bbc94aa0534b89be2f6294b8547f0", "file_size": 2191516, "file_updated": "2024-10-22T19:45:42Z", "created_at": "2024-10-22T19:46:13.080681Z", "updated_at": "2024-10-22T19:46:13.080707Z", "runs_on_iphone": true, "runs_on_ipad": true, "runs_on_tv": false, "runs_on_mac": false, "runs_on_ipod": false, "runs_on_watch": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "patch": { "summary": "Update In-House App", "description": "This request allows you to update an existing In-House App in the Kandji library.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the library item", "example": "13cc4ab7-0380-4d64-b80f-d2c22136e522" } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "required": true, "description": "JSON payload containing the in-house app update configuration", "content": { "application/json": { "schema": { "type": "object", "properties": { "file_key": { "type": "string", "description": "The file key generated from the Upload In-House App to S3 endpoint", "example": "companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/test_app_18cf0dfc.ipa" }, "name": { "type": "string", "description": "Name of your Library Item", "example": "Name of your Library Item here" }, "runs_on_iphone": { "type": "boolean", "description": "Whether the app runs on iPhone", "example": true }, "runs_on_ipad": { "type": "boolean", "description": "Whether the app runs on iPad", "example": true }, "runs_on_tv": { "type": "boolean", "description": "Whether the app runs on Apple TV", "example": false }, "active": { "type": "boolean", "description": "Whether the app is active", "example": true } } }, "example": { "file_key": "file_key", "name": "Name of your Library Item here", "runs_on_iphone": true, "runs_on_ipad": true, "runs_on_tv": false, "active": true } } } } }, "delete": { "summary": "Delete In-House App", "description": "This endpoint sends a request to delete a specific In-House App Library Item from Kandji.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the Library Item", "example": "13cc4ab7-0380-4d64-b80f-d2c22136e522" } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/library/ipa-apps/upload": { "post": { "summary": "Upload In-House App", "description": "Creates a pre-signed post_url to upload a new In-House App to S3.", "parameters": [], "responses": { "201": { "description": "success - create s3 upload", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "3603e636-ab6b-48e0-ad7e-cb7ab24bc6bc", "filename": "Sammy_2a450666.ipa", "sha256": null, "expires": "2024-10-31T16:51:13.156205Z", "post_url": "https://kandji-prod.s3.amazonaws.com/", "post_data": { "key": "tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_2a450666.ipa", "x-amz-algorithm": "AWS4-HMAC-SHA256", "x-amz-credential": "ASI...RDLC/20241030/us-west-2/s3/aws4_request", "x-amz-date": "20241030T165113Z", "x-amz-security-token": "IQoJb3Jp...Hgg==", "policy": "eyJleHBp...6482", "x-amz-signature": "75df0e9b...ddd5" }, "file_key": "tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_2a450666.ipa" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "required": true, "description": "JSON payload containing the filename for the in-house app upload", "content": { "application/json": { "schema": { "type": "object", "properties": { "filename": { "type": "string", "description": "The filename of the in-house app to upload", "example": "example.ipa" } }, "required": [ "filename" ] }, "example": { "filename": "example.ipa" } } } } } }, "/api/v1/library/ipa-apps/upload/{pending_upload_id}/status": { "get": { "summary": "Upload In-House App Status", "description": "This endpoint retrieves the current upload status of an In-House App .ipa file to Amazon S3.", "parameters": [ { "name": "pending_upload_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "This should be the id from the [Upload In-House App](/en/endpoint/api/upload-in-house-app) API response" } ], "responses": { "200": { "description": "validate failed - validation failed", "content": { "application/json": { "schema": { "type": "object", "example": { "reason": "The IPA file validation timed out", "status": "VALIDATE_FAILED", "sha256": "9bbdeac4fd91ea4ac231f6320821e51a706d56219884bc071a834a08d3ecf99d" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/library/custom-profiles": { "get": { "summary": "List Custom Profiles", "description": "This endpoint makes a request to retrieve a list of custom profiles from the Iru Endpoint Management library.", "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Optional page number. Used when results exceed pagination threshold. A hard upper limit is set at 300 device records returned per request.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 2, "next": null, "previous": null, "results": [ { "id": "a403f056-b1ec-4053-a79d-72ad2fe92485", "name": "odt-sso-ext-test", "active": false, "profile": "", "mdm_identifier": "com.kandji.profile.custom.a403f056-b1ec-4053-a79d-72ad2fe92485", "runs_on_mac": false, "runs_on_iphone": true, "runs_on_ipad": true, "runs_on_tv": false, "runs_on_vision": false, "created_at": "2023-03-10T19:27:58.677287Z", "updated_at": "2023-03-10T20:06:28.622392Z" }, { "id": "fdf05e37-f157-4cbf-9eab-2e2ef43938ab", "name": "Custom Profile New Name", "active": false, "profile": "", "mdm_identifier": "com.kandji.profile.custom.fdf05e37-f157-4cbf-9eab-2e2ef43938ab", "runs_on_mac": false, "runs_on_iphone": true, "runs_on_ipad": true, "runs_on_tv": false, "runs_on_vision": false, "created_at": "2024-01-28T12:12:40.716224Z", "updated_at": "2024-01-28T12:19:47.897192Z" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "post": { "summary": "Create Custom Profile", "description": "This request allows you to create a custom profile in the Kandji library.", "parameters": [], "responses": { "201": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "e8f93d8e-77da-45a3-b5bf-ede2cf1a330d", "name": "Custom Profile Test", "active": true, "profile": "(XML contents of profile)", "mdm_identifier": "com.kandji.profile.custom.e8f93d8e-77da-45a3-b5bf-ede2cf1a330d", "runs_on_mac": true, "runs_on_iphone": false, "runs_on_ipad": false, "runs_on_tv": false, "runs_on_vision": false, "created_at": "2023-10-13T17:29:57.339336Z", "updated_at": "2023-10-13T17:29:57.339416Z" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "required": true, "description": "Form data payload containing the custom profile configuration", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The profile name", "example": "Custom Profile Test" }, "file": { "type": "string", "format": "binary", "description": "The path to the profile's .mobileconfig file" }, "active": { "type": "boolean", "description": "Whether this library item is active (default=true)", "default": true, "example": false }, "runs_on_mac": { "type": "boolean", "description": "Whether the profile runs on Mac", "example": true }, "runs_on_iphone": { "type": "boolean", "description": "Whether the profile runs on iPhone", "example": true }, "runs_on_ipad": { "type": "boolean", "description": "Whether the profile runs on iPad", "example": true }, "runs_on_tv": { "type": "boolean", "description": "Whether the profile runs on Apple TV", "example": true } }, "required": [ "name", "file" ] } } } } } }, "/api/v1/library/custom-profiles/{library_item_id}": { "get": { "summary": "Get Custom Profile", "description": "This endpoint retrieves details about a specific custom profile from the Kandji library.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the library item", "example": "a403f056-b1ec-4053-a79d-72ad2fe92485" } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "a403f056-b1ec-4053-a79d-72ad2fe92485", "name": "odt-sso-ext-test", "active": false, "profile": "", "mdm_identifier": "com.kandji.profile.custom.a403f056-b1ec-4053-a79d-72ad2fe92485", "runs_on_mac": false, "runs_on_iphone": true, "runs_on_ipad": true, "runs_on_tv": false, "runs_on_vision": false, "created_at": "2023-03-10T19:27:58.677287Z", "updated_at": "2023-03-10T20:06:28.622392Z" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "patch": { "summary": "Update Custom Profile", "description": "This request allows you to update a custom profile in the Kandji library.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the library item", "example": "a403f056-b1ec-4053-a79d-72ad2fe92485" } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "e8f93d8e-77da-45a3-b5bf-ede2cf1a330d", "name": "Custom Profile New Name", "active": true, "profile": "(XML of profile, including new name)", "mdm_identifier": "com.kandji.profile.custom.e8f93d8e-77da-45a3-b5bf-ede2cf1a330d", "runs_on_mac": true, "runs_on_iphone": false, "runs_on_ipad": false, "runs_on_tv": false, "runs_on_vision": false, "created_at": "2023-10-13T17:29:57.339336Z", "updated_at": "2023-10-13T17:31:08.086441Z" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "required": true, "description": "Form data payload containing the custom profile update configuration", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The profile name", "example": "Custom Profile New Name" }, "file": { "type": "string", "format": "binary", "description": "The path to the profile's .mobileconfig file" }, "active": { "type": "boolean", "description": "Whether this library item is active", "example": false }, "runs_on_mac": { "type": "boolean", "description": "Whether the profile runs on Mac", "example": true }, "runs_on_iphone": { "type": "boolean", "description": "Whether the profile runs on iPhone", "example": true }, "runs_on_ipad": { "type": "boolean", "description": "Whether the profile runs on iPad", "example": true }, "runs_on_tv": { "type": "boolean", "description": "Whether the profile runs on Apple TV", "example": true } } } } } } }, "delete": { "summary": "Delete Custom Profile", "description": "This endpoint sends a request to delete a specific custom profile from the Kandji library.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the library item", "example": "e8f93d8e-77da-45a3-b5bf-ede2cf1a330d" } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/library/custom-scripts": { "get": { "summary": "List Custom Scripts", "description": "This endpoint makes a request to retrieve a list of custom scripts from the Iru Endpoint Management library.", "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Optional page number. Used when results exceed pagination threshold. A hard upper limit is set at 300 device records returned per request.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 2, "next": null, "previous": null, "results": [ { "id": "a155ffb7-ab75-4e5f-ab1d-1334153efad3", "name": "Custom Script One", "active": true, "execution_frequency": "no_enforcement", "restart": false, "script": "echo \"Hello World!\"", "remediation_script": "", "created_at": "2022-03-24T17:30:26.625839Z", "updated_at": "2022-03-24T17:30:26.625856Z" }, { "id": "2b1aa89d-88f8-4fca-a075-af774615015a", "name": "Custom Script Two", "active": true, "execution_frequency": "every_day", "restart": false, "script": "echo \"Test script\"", "remediation_script": "", "created_at": "2023-08-02T16:25:38.479746Z", "updated_at": "2023-08-02T16:28:17.209484Z" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "post": { "summary": "Create Custom Script", "description": "This request allows you to create a custom script in the Kandji library.", "parameters": [], "responses": { "201": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "1cdbbf21-682b-4573-aa22-5aff027a337b", "name": "new_custom_script", "active": false, "execution_frequency": "once", "restart": false, "script": "/usr/bin/env zsh\necho \"hi, hello world!\"", "remediation_script": "", "created_at": "2024-05-08T23:06:49.419056Z", "updated_at": "2024-05-08T23:06:49.419071Z", "show_in_self_service": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "required": true, "description": "JSON payload containing the custom script configuration", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the custom script", "example": "new_custom_script" }, "execution_frequency": { "type": "string", "description": "How often the script should be executed", "enum": [ "once", "every_15_min", "every_day", "no_enforcement" ], "example": "once" }, "script": { "type": "string", "description": "The script content to execute", "example": "/usr/bin/env zsh\necho \"hi, hello world!\"" }, "remediation_script": { "type": "string", "description": "Optional remediation script to run if the main script fails", "example": "echo \"goodbye\"" }, "show_in_self_service": { "type": "boolean", "description": "Whether to show this script in self service", "example": false }, "self_service_category_id": { "type": "string", "description": "The ID of the self service category (from List Self Service Categories endpoint)", "example": "e6f6d5b4-0659-4b37-872c-5471115d453b" }, "self_service_recommended": { "type": "boolean", "description": "Whether this script is recommended in self service", "example": false }, "active": { "type": "boolean", "description": "Whether the script is active", "example": false }, "restart": { "type": "boolean", "description": "Whether to restart the device after script execution", "example": false } }, "required": [ "name", "execution_frequency", "script" ] }, "example": { "name": "new_custom_script", "execution_frequency": "once", "script": "/usr/bin/env zsh\necho \"hi, hello world!\"", "remediation_script": "echo \"goodbye\"", "show_in_self_service": false, "self_service_category_id": "e6f6d5b4-0659-4b37-872c-5471115d453b", "self_service_recommended": false, "active": false, "restart": false } } } } } }, "/api/v1/library/custom-scripts/{library_item_id}": { "get": { "summary": "Get Custom Script", "description": "This endpoint retrieves details about a specific custom script from the Kandji library.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the library item", "example": "1cdbbf21-682b-4573-aa22-5aff027a337b" } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "a155ffb7-ab75-4e5f-ab1d-1334153efad3", "name": "Custom Script One", "active": true, "execution_frequency": "no_enforcement", "restart": false, "script": "echo \"Hello World!\"", "remediation_script": "", "created_at": "2022-03-24T17:30:26.625839Z", "updated_at": "2022-03-24T17:30:26.625856Z" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "patch": { "summary": "Update Custom Script", "description": "This request allows you to update a custom script in the Kandji library.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success - zsh example", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "f673d61c-a174-43c5-8e85-412442fb0a2a", "name": "updated_custom_script", "active": false, "execution_frequency": "once", "restart": false, "script": "/usr/bin/env zsh\necho \"hi, hello world!\"", "remediation_script": "", "created_at": "2024-05-06T23:32:44.597037Z", "updated_at": "2024-05-08T23:05:39.462672Z", "show_in_self_service": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "required": true, "description": "JSON payload containing the custom script update configuration", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the custom script", "example": "updated_custom_script" }, "execution_frequency": { "type": "string", "description": "How often the script should be executed", "enum": [ "once", "every_15_min", "every_day", "no_enforcement" ], "example": "once" }, "script": { "type": "string", "description": "The script content to execute", "example": "echo \"hi, hello world!\"" }, "remediation_script": { "type": "string", "description": "Optional remediation script to run if the main script fails", "example": "echo \"goodbye\"" }, "show_in_self_service": { "type": "boolean", "description": "Whether to show this script in self service", "example": false }, "self_service_category_id": { "type": "string", "description": "The ID of the self service category (from List Self Service Categories endpoint)", "example": "e6f6d5b4-0659-4b37-872c-5471115d453b" }, "self_service_recommended": { "type": "boolean", "description": "Whether this script is recommended in self service", "example": false }, "active": { "type": "boolean", "description": "Whether the script is active", "example": false }, "restart": { "type": "boolean", "description": "Whether to restart the device after script execution", "example": false } } }, "example": { "name": "updated_custom_script", "execution_frequency": "once", "script": "echo \"hi, hello world!\"", "remediation_script": "echo \"goodbye\"", "show_in_self_service": false, "self_service_category_id": "e6f6d5b4-0659-4b37-872c-5471115d453b", "self_service_recommended": false, "active": false, "restart": false } } } } }, "delete": { "summary": "Delete Custom Script", "description": "This endpoint sends a request to delete a specific custom script from the Kandji library.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the library item", "example": "1cdbbf21-682b-4573-aa22-5aff027a337b" } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/self-service/categories": { "get": { "summary": "List Self Service Categories", "description": "This endpoint retrieves a list of self-service categories and their associated IDs.", "parameters": [], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": [ { "id": "e9010a08-a546-470b-a633-04ee27dadfb3", "name": "Apps" }, { "id": "1087f69d-37a3-44f6-a0d8-2b33f5a336bb", "name": "Productivity" }, { "id": "26a01803-f871-40b7-8c1a-6cae9983c22e", "name": "Utilities" }, { "id": "2f9912d1-d784-4248-905c-3834812c5537", "name": "Security" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/library/library-items/{library_item_id}/activity": { "get": { "summary": "Get Library Item Activity", "description": "This endpoint retrieves the activity related to a specific library item. Activity is listed from newest to oldest.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 8, "next": null, "previous": null, "results": [ { "id": 1862, "activity_time": "2024-01-20T20:31:30.325831Z", "activity_type": "library_item_assignment_changed", "user_id": "4b9b080b-f82b-41e9-814b-a5668fdd8a3e", "user_email": "accuhive@kandji.io", "details": null }, { "id": 1860, "activity_time": "2024-01-20T20:31:28.430284Z", "activity_type": "library_item_assignment_changed", "user_id": "4b9b080b-f82b-41e9-814b-a5668fdd8a3e", "user_email": "accuhive@kandji.io", "details": null }, { "id": 1858, "activity_time": "2024-01-20T20:27:34.379144Z", "activity_type": "library_item_assignment_changed", "user_id": "4b9b080b-f82b-41e9-814b-a5668fdd8a3e", "user_email": "accuhive@kandji.io", "details": null }, { "id": 1856, "activity_time": "2024-01-20T20:20:20.845315Z", "activity_type": "library_item_assignment_changed", "user_id": "4b9b080b-f82b-41e9-814b-a5668fdd8a3e", "user_email": "accuhive@kandji.io", "details": null }, { "id": 1854, "activity_time": "2024-01-20T20:20:14.628260Z", "activity_type": "library_item_assignment_changed", "user_id": "4b9b080b-f82b-41e9-814b-a5668fdd8a3e", "user_email": "accuhive@kandji.io", "details": null }, { "id": 1852, "activity_time": "2024-01-20T20:09:09.539169Z", "activity_type": "library_item_edited", "user_id": "4b9b080b-f82b-41e9-814b-a5668fdd8a3e", "user_email": "accuhive@kandji.io", "details": [ "Name: test_custom_app → ms_company_portal" ] }, { "id": 1851, "activity_time": "2024-01-20T20:08:19.874100Z", "activity_type": "library_item_assignment_changed", "user_id": "4b9b080b-f82b-41e9-814b-a5668fdd8a3e", "user_email": "accuhive@kandji.io", "details": null }, { "id": 1849, "activity_time": "2024-01-20T20:07:53.701713Z", "activity_type": "library_item_created", "user_id": "4b9b080b-f82b-41e9-814b-a5668fdd8a3e", "user_email": "accuhive@kandji.io`", "details": null } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/library/library-items/{library_item_id}/status": { "get": { "summary": "Get Library Item Statuses", "description": "This endpoint retrieves the statuses related to a specific library item.", "parameters": [ { "name": "library_item_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "computer_id", "in": "query", "required": false, "description": "Query for the status of one device.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters.", "schema": { "type": "integer", "maximum": 300, "default": 300 } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "edr status", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 3, "next": null, "previous": null, "results": [ { "id": 14603, "blueprint": { "id": "ab102b9d-8e9c-420d-a498-f2a1123091c7", "name": "_test_something" }, "computer": { "id": "912bc505-a7ee-4d0b-906d-2102f332a4b3", "name": "testuser’s MacBook Air" }, "status": "PENDING", "reported_at": null, "log": null, "last_audit_run": null, "last_audit_log": null, "control_log": null, "control_reported_at": null, "edr_status": { "status": "enabled", "malware_posture": "Protect", "pup_posture": "Protect", "last_baseline_scan": "Feb 27, 2024 at 7:34:21 AM", "next_baseline_scan": "Mar 26, 2024 at 5:48:10 AM", "baseline_scan_runtime": "Kandji checked 339,254 files in 3 minutes, 41 seconds." }, "type": "threat-security-policy" }, { "id": 14602, "blueprint": { "id": "ab102b9d-8e9c-420d-a498-f2a1123091c7", "name": "_test_something" }, "computer": { "id": "977942ac-8303-4ec9-b7bf-439f4e9f18dd", "name": "as_13_4_dummy_vm_009" }, "status": "PENDING", "reported_at": null, "log": null, "last_audit_run": null, "last_audit_log": null, "control_log": null, "control_reported_at": null, "edr_status": null, "type": "threat-security-policy" }, { "id": 14600, "blueprint": { "id": "ab102b9d-8e9c-420d-a498-f2a1123091c7", "name": "_test_something" }, "computer": { "id": "2f25e13e-3b1c-4717-bf7e-7d23e61bb68c", "name": "Mac mini" }, "status": "PENDING", "reported_at": null, "log": null, "last_audit_run": null, "last_audit_log": null, "control_log": null, "control_reported_at": null, "edr_status": null, "type": "threat-security-policy" } ] } }, "example": { "count": 5, "next": null, "previous": null, "results": [ { "id": 13908, "blueprint": { "id": "ab102b9d-8e9c-420d-a498-f2a1123091c7", "name": "_test_something" }, "computer": { "id": "2f25e13e-3b1c-4717-bf7e-7d23e61bb68c", "name": "Mac mini" }, "status": "PENDING", "reported_at": null, "log": null, "last_audit_run": null, "last_audit_log": null, "control_log": null, "control_reported_at": null }, { "id": 13907, "blueprint": { "id": "ab102b9d-8e9c-420d-a498-f2a1123091c7", "name": "_test_something" }, "computer": { "id": "912bc505-a7ee-4d0b-906d-2102f332a4b3", "name": "testuser's MacBook Air" }, "status": "PENDING", "reported_at": null, "log": null, "last_audit_run": null, "last_audit_log": null, "control_log": null, "control_reported_at": null }, { "id": 13906, "blueprint": { "id": "ab102b9d-8e9c-420d-a498-f2a1123091c7", "name": "_test_something" }, "computer": { "id": "977942ac-8303-4ec9-b7bf-439f4e9f18dd", "name": "as_13_4_dummy_vm_009" }, "status": "PENDING", "reported_at": null, "log": null, "last_audit_run": null, "last_audit_log": null, "control_log": null, "control_reported_at": null }, { "id": 13905, "blueprint": { "id": "ab102b9d-8e9c-420d-a498-f2a1123091c7", "name": "_test_something" }, "computer": { "id": "83b91e8a-23ad-4883-99fb-ffea6d10a049", "name": "dev_odt_testing_01" }, "status": "PENDING", "reported_at": null, "log": null, "last_audit_run": null, "last_audit_log": null, "control_log": null, "control_reported_at": null }, { "id": 13904, "blueprint": { "id": "d238e6c6-2b9d-4d38-acba-03893a66ef20", "name": "managed_os_macos" }, "computer": { "id": "ce0e6bbc-1665-471a-9c4c-1c47237c773e", "name": "testuser's MacBook Air" }, "status": "PASS", "reported_at": "2023-10-23T19:47:33Z", "log": "Executing agent_debug_logging...\nExit code: 0\nScript results:\nKandji Agent log level set to DEBUG already ...", "last_audit_run": null, "last_audit_log": null, "control_log": null, "control_reported_at": null } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/activation_lock": { "get": { "summary": "Activation lock", "description": "This request returns activation lock attributes for devices.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": null, "limit": 25, "total": 10, "data": [ { "device_id": "d6ac2d8c-3852-4dc1-afe7-d5a32306ee39", "device__name": "14_1_1_23B81_as_adcs_testing", "device__family": "Mac", "device__user_id": "", "device__user_name": null, "device__user_email": null, "blueprint_id": "449ec92a-186a-44f2-9421-d5ac6e465eb5", "blueprint_name": "demo", "tags": null, "asset_tag": "", "serial_number": "Z6V0YW4M1C", "model_id": "VirtualMac2,1", "count": null, "created_at": "2023-11-30T16:45:23.389926+00:00", "updated_at": "2025-03-18T19:06:43.216114+00:00", "last_changed_at": "2025-03-18T19:06:43.316369+00:00", "last_collected_at": "2025-03-18T19:06:43.216115+00:00", "device_capacity": 47, "host_name": "14_1_1_23B81_as_adcs_testing", "local_hostname": "ankas-Virtual-Machine", "apple_silicon": true, "model": "Virtual Machine", "model_name": "Virtual Machine", "shared_ipad": null, "cellular_technology": null, "data_roaming": null, "hotspot": null, "first_enrollment_date": "2023-11-30T16:44:13.890383+00:00", "last_enrollment_date": "2023-11-30T16:44:13.890383+00:00", "agent_version": "4.3.3 (4811)", "mdm_enabled": true, "agent_installed": true, "os_version": "14.1.1", "os_build": "23B81", "marketing_name": "Sonoma", "supplemental_build_version": "23B81", "supplemental_os_version_extra": null, "display_os_version": "14.1.1", "last_checkin": "2023-12-24T22:00:58.374320+00:00", "last_checkin_agent": "2023-12-24T22:00:58.374320+00:00", "last_checkin_mdm": "2023-12-24T21:39:38.077864+00:00", "battery_health": null, "lost_mode_status": null } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/apps": { "get": { "summary": "Applications", "description": "This request returns the applications installed on macOS, iOS, iPadOS, and tvOS devices.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" }, "example": "{\"name\":{\"not_in\":[\"Okta Verify\"]},\"device__name\":{\"not_in\":[\"testuser’s MacBook Air\"]}}" }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending() order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "integer", "minimum": 1, "maximum": 300, "default": 300 }, "example": 300 }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "example": 0 } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": null, "limit": 25, "total": 165, "data": [ { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-11-18T23:04:43.852118+00:00", "updated_at": "2024-11-18T23:04:43.852118+00:00", "last_changed_at": null, "last_collected_at": "2024-12-18T22:24:03.861846+00:00", "path": "/Applications/1Password 7.app", "obtained_from": "Identified Developer", "bundle_size": null, "bundle_id": "com.agilebits.onepassword7", "name": "1Password 7", "short_version": "70911000", "signature": "Developer ID Application: AgileBits Inc. (2BUA8C4S2C), Developer ID Certification Authority, Apple Root CA", "ad_hoc_code_signed": null, "app_store_vendable": null, "beta_app": null, "device_based_vpp": null, "download_canceled": null, "download_failed": null, "download_paused": null, "download_waiting": null, "dynamic_size": null, "external_version_identifier": null, "has_update_available": null, "installing": null, "version": "7.9.11", "app_clip": null, "validated": null, "executable": "1Password 7", "bundle_name": "1Password 7", "bundle_type": "APPL", "environment_variables": null, "compiler": "com.apple.compilers.llvm.clang.1_0", "bundle_region": "en", "bundle_display_name": null, "info": null, "minimum_system_version": "10.13", "category": "public.app-category.productivity", "apple_scriptable": null, "copyright": "Copyright © AgileBits Inc. All rights reserved.", "developer_name": "AgileBits Inc.", "team_id": "2BUA8C4S2C" }, { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@kandjidev.onmicrosoft.com", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-11-18T23:05:16.300608+00:00", "updated_at": "2024-11-18T23:05:16.300608+00:00", "last_changed_at": null, "last_collected_at": "2024-12-18T22:24:03.861891+00:00", "path": "/Applications/1Password 7.app/Contents/Library/LoginItems/1Password Extension Helper.app", "obtained_from": "Identified Developer", "bundle_size": null, "bundle_id": "2BUA8C4S2C.com.agilebits.onepassword7-helper", "name": "1Password Extension Helper", "short_version": "70911000", "signature": "Developer ID Application: AgileBits Inc. (2BUA8C4S2C), Developer ID Certification Authority, Apple Root CA", "ad_hoc_code_signed": null, "app_store_vendable": null, "beta_app": null, "device_based_vpp": null, "download_canceled": null, "download_failed": null, "download_paused": null, "download_waiting": null, "dynamic_size": null, "external_version_identifier": null, "has_update_available": null, "installing": null, "version": "7.9.11", "app_clip": null, "validated": null, "executable": "1Password Extension Helper", "bundle_name": "1Password Extension Helper", "bundle_type": "APPL", "environment_variables": null, "compiler": "com.apple.compilers.llvm.clang.1_0", "bundle_region": "en", "bundle_display_name": null, "info": null, "minimum_system_version": "10.13", "category": "public.app-category.utilities", "apple_scriptable": null, "copyright": "Copyright © AgileBits Inc. All rights reserved.", "developer_name": "AgileBits Inc.", "team_id": "2BUA8C4S2C" } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/application_firewall": { "get": { "summary": "Application firewall", "description": "This request returns Application Firewall details for macOS.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": 0, "limit": 25, "total": null, "data": [ { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-11-18T21:02:58.411377+00:00", "updated_at": "2024-12-10T16:24:07.767954+00:00", "last_changed_at": null, "last_collected_at": "2024-12-10T16:24:07.767955+00:00", "status": false, "block_all_incoming": false, "logging": true, "logging_option": "throttled", "stealth_mode": false, "version": "1.7", "allow_signed_applications": true, "unloading": false } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/cellular": { "get": { "summary": "Cellular", "description": "This request returns Cellular attributes for devices.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": 0, "limit": 25, "total": null, "data": [ { "device_id": "387a369d-5d12-4dfe-9ac0-d5af8780b959", "device__name": "iPhone", "device__family": "iPhone", "device__user_id": "", "device__user_name": null, "device__user_email": null, "blueprint_id": "9c2a1219-deeb-4b37-845e-b61418275ba1", "blueprint_name": "accuhive", "tags": null, "asset_tag": "", "serial_number": "F4GVJ4Q9JC6H", "model_id": "iPhone10,1", "count": null, "created_at": "2025-02-08T00:55:45.808993+00:00", "updated_at": "2025-02-12T17:33:35.626695+00:00", "last_changed_at": null, "last_collected_at": "2025-02-12T17:33:35.626695+00:00", "cellular_technology": "GSM and CDMA", "data_roaming_enabled": false, "voice_roaming_enabled": false, "modem_firmware_version": "6.21.01", "personal_hotspot_enabled": false, "meid": "35673008397160", "carrier_settings_version_slot_1": null, "current_carrier_network_slot_1": null, "current_mcc_slot_1": null, "current_mnc_slot_1": null, "eid_slot_1": null, "iccid_slot_1": null, "imei_slot_1": "35 673008 397160 8", "is_data_preferred_slot_1": null, "is_roaming_slot_1": null, "is_voice_preferred_slot_1": null, "label_slot_1": null, "label_id_slot_1": null, "phone_number_slot_1": null, "slot_1": "CTSubscriptionSlotOne", "subscriber_carrier_network_slot_1": null, "carrier_settings_version_slot_2": null, "current_carrier_network_slot_2": null, "current_mcc_slot_2": null, "current_mnc_slot_2": null, "eid_slot_2": null, "iccid_slot_2": null, "imei_slot_2": null, "is_data_preferred_slot_2": null, "is_roaming_slot_2": null, "is_voice_preferred_slot_2": null, "label_slot_2": null, "label_id_slot_2": null, "phone_number_slot_2": null, "slot_2": null, "subscriber_carrier_network_slot_2": null } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/certificates": { "get": { "summary": "Certificates", "description": "This request returns certificate details.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": 0, "limit": 25, "total": null, "data": [ { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-11-18T21:03:05.323348+00:00", "updated_at": "2024-12-10T14:39:34.950229+00:00", "last_changed_at": null, "last_collected_at": "2024-12-10T14:39:34.950229+00:00", "common_name": "com.apple.kerberos.kdc", "identity_certificate": true }, { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-11-18T21:03:05.323348+00:00", "updated_at": "2024-12-10T14:39:34.950256+00:00", "last_changed_at": null, "last_collected_at": "2024-12-10T14:39:34.950256+00:00", "common_name": "com.apple.systemdefault", "identity_certificate": true }, { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-12-05T21:11:17.891381+00:00", "updated_at": "2024-12-10T14:39:34.950276+00:00", "last_changed_at": null, "last_collected_at": "2024-12-10T14:39:34.950276+00:00", "common_name": "MDM SCEP VERIFIER ...", "identity_certificate": true } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/desktop_and_screensaver": { "get": { "summary": "Desktop and Screensaver", "description": "This request returns Desktop and Screensaver details for macOS.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": null, "limit": 25, "total": 3, "data": [ { "device_id": "d6ac2d8c-3852-4dc1-afe7-d5a32306ee39", "device__name": "14_1_1_23B81_as_adcs_testing", "device__family": "Mac", "device__user_id": "", "device__user_name": null, "device__user_email": null, "blueprint_id": "449ec92a-186a-44f2-9421-d5ac6e465eb5", "blueprint_name": "demo", "tags": null, "asset_tag": "", "serial_number": "Z6V0YW4M1C", "model_id": "VirtualMac2,1", "count": null, "created_at": "2023-11-30T16:45:23.389926+00:00", "updated_at": "2025-03-18T19:06:43.216114+00:00", "last_changed_at": "2025-03-18T19:06:43.316369+00:00", "last_collected_at": "2025-03-18T19:06:43.216115+00:00", "device_capacity": 47, "host_name": "14_1_1_23B81_as_adcs_testing", "local_hostname": "ankas-Virtual-Machine", "apple_silicon": true, "model": "Virtual Machine", "model_name": "Virtual Machine", "shared_ipad": null, "cellular_technology": null, "data_roaming": null, "hotspot": null, "first_enrollment_date": "2023-11-30T16:44:13.890383+00:00", "last_enrollment_date": "2023-11-30T16:44:13.890383+00:00", "agent_version": "4.3.3 (4811)", "mdm_enabled": true, "agent_installed": true, "os_version": "14.1.1", "os_build": "23B81", "marketing_name": "Sonoma", "supplemental_build_version": "23B81", "supplemental_os_version_extra": null, "display_os_version": "14.1.1", "last_checkin": "2023-12-24T22:00:58.374320+00:00", "last_checkin_agent": "2023-12-24T22:00:58.374320+00:00", "last_checkin_mdm": "2023-12-24T21:39:38.077864+00:00", "battery_health": null, "lost_mode_status": null } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/device_information": { "get": { "summary": "Device information", "description": "This request returns device information attributes.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "14afabf2-7599-47af-a942-bf7f0b8fedf8" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" }, "example": "{\"device__name\":{\"in\":[\"testusers's MacBook Air\"]},\"updated_at\":{\"gte\":\"2023-09-03T04:00:00.000Z\",\"lte\":\"2023-09-04T04:00:00.000Z\"}}" }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" }, "example": "serial_number" }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get devices by assigned user name", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": null, "limit": 25, "total": 1, "data": [ { "device_id": "00008347-0695-4145-b0dc-ca800a1332f9", "device__name": "g-473141e", "device__family": "Mac", "device__user_id": "31250", "device__user_name": "Thor Odinson", "device__user_email": "thor.odinson@accuhive.io", "blueprint_id": "9c74bc56-9452-4c41-81ad-4bed3fe3f857", "blueprint_name": "2000 Devices - Okta", "tags": null, "asset_tag": "", "serial_number": "ZGFRNNQGQD", "model_id": "MacBookPro16,1", "count": null, "created_at": "2023-12-01T23:38:29.671124+00:00", "updated_at": "2025-02-13T18:47:49.933506+00:00", "last_changed_at": "2025-02-13T14:33:00.034349+00:00", "last_collected_at": "2023-12-01T23:38:29.169707+00:00", "device_capacity": 49, "host_name": null, "local_hostname": null, "apple_silicon": null, "model": "Mac", "model_name": "MacBook Pro (16-inch, 2019)", "shared_ipad": true, "cellular_technology": "", "data_roaming": false, "hotspot": false, "first_enrollment_date": "2023-12-01T23:38:24.723570+00:00", "last_enrollment_date": "2023-12-01T23:38:24.723570+00:00", "agent_version": null, "mdm_enabled": true, "agent_installed": null, "os_version": "11.0.1", "os_build": "20B29", "marketing_name": "Big Sur", "supplemental_build_version": null, "supplemental_os_version_extra": null, "display_os_version": "11.0.1", "last_checkin": "2023-12-01T23:38:54.367429+00:00", "last_checkin_agent": null, "last_checkin_mdm": "2023-12-01T23:38:54.367429+00:00", "battery_health": null, "lost_mode_status": null } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/filevault": { "get": { "summary": "FileVault", "description": "This request returns FileVault information for macOS.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": 0, "limit": 25, "total": null, "data": [ { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-11-18T21:02:58.179622+00:00", "updated_at": "2024-12-10T14:39:34.740791+00:00", "last_changed_at": null, "last_collected_at": "2024-12-10T14:39:34.740791+00:00", "status": false, "key_type": null, "key_escrowed": false, "regeneration_needed": null, "scheduled_key_rotation": null } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/gatekeeper_and_xprotect": { "get": { "summary": "Gatekeeper and XProtect", "description": "This request returns Gatekeeper and XProtect attributes for macOS.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": 0, "limit": 25, "total": null, "data": [ { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-11-18T21:04:10.947254+00:00", "updated_at": "2024-12-10T16:24:07.770055+00:00", "last_changed_at": "2024-11-20T10:15:31.850834+00:00", "last_collected_at": "2024-12-10T16:24:07.770055+00:00", "gatekeeper_status": true, "trusted_developers": true, "gatekeeper_version": "8.0", "gatekeeper_opaque_version": "94", "xprotect_version": "5283", "malware_removal_tool_version": "1.93" } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/installed_profiles": { "get": { "summary": "Installed profiles", "description": "This request returns Installed Profiles attributes for macOS, iOS, iPadOS, and tvOS.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": null, "limit": 25, "total": 17, "data": [ { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-12-09T15:57:24.580116+00:00", "updated_at": "2024-12-10T14:39:35.670546+00:00", "last_changed_at": null, "last_collected_at": "2024-12-10T14:39:35.670547+00:00", "profile_display_name": "Microsoft Company Portal Settings", "payload_identifier": "com.kandji.profile.autoapp.814351ef-d9ee-4ebe-bf3e-5fb6cc3086bc.Configuration", "payload_uuid": "e9643534-3ef3-5b97-84be-779edbca63bf", "removal_passcode": false, "encrypted": false, "managed": true, "profile_description": null, "organization": "Kandji, Inc.", "removable": false, "signed": true, "profile_data": [ { "type": "com.apple.servicemanagement", "uuid": "8a545c11-80f0-5721-b973-88f19bebbaa0", "version": 1, "identifier": "com.kandji.profile.autoapp.814351ef-d9ee-4ebe-bf3e-5fb6cc3086bc.com.apple.servicemanagement.42085371-8d8c-5fa1-a4c0-0d63a7b93753", "display_name": "Background Service Management", "organization": "Kandji, Inc." } ] } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/kernel_extensions": { "get": { "summary": "Kernel Extensions", "description": "This request returns Kernel Extension attributes for macOS.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success - no kernel extensions", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": null, "limit": 25, "total": 0, "data": [], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/launch_agents_and_daemons": { "get": { "summary": "Launch Agents and Daemons", "description": "This request returns Launch Agents and Daemons installed on macOS.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": null, "limit": 25, "total": 10, "data": [ { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-11-18T21:04:10.693829+00:00", "updated_at": "2024-12-10T19:58:32.506905+00:00", "last_changed_at": null, "last_collected_at": "2024-12-10T19:58:32.506905+00:00", "path": "/Library/LaunchAgents/com.microsoft.update.agent.plist", "file_name": "com.microsoft.update.agent.plist", "label": "com.microsoft.update.agent", "program": null, "run_at_load": true, "keep_alive": false, "disabled": false, "is_disabled": false, "is_loaded": true, "group_name": null, "user_name": null, "standard_out_path": null, "standard_error_path": null, "start_interval": 7200, "program_arguments": "/Library/Application Support/Microsoft/MAU2.0/Microsoft AutoUpdate.app/Contents/MacOS/Microsoft Update Assistant.app/Contents/MacOS/Microsoft Update Assistant, --launchByAgent", "watch_paths": null, "queue_directories": null, "start_on_mount": null, "root_directory": null, "working_directory": null, "process_type": null, "domain": { "system_agent": { "loaded_users": [ { "uid": 501, "username": "testuser" } ], "disabled_users": [] } }, "service_domain": "System Agent", "pid": null, "user_agent_local_user": null, "user_agent_local_user_id": null } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/local_users": { "get": { "summary": "Local users", "description": "This request returns Local Users details for macOS.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": 0, "limit": 25, "total": 117, "data": [ { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-11-18T21:04:10.961862+00:00", "updated_at": "2024-11-18T21:04:10.867144+00:00", "last_changed_at": null, "last_collected_at": "2024-11-18T21:04:10.867144+00:00", "uid": 1, "user_created_at": null, "failed_logins": null, "failed_login_time": null, "password_last_set": null, "generated_uid": "FFFFEEEE-DDDD-CCCC-BBBB-AAAA00000001", "directory": "/Local/Default", "home_directory": "/var/root", "shell": "/usr/bin/false", "type": "Standard", "hidden_user": false, "secure_token": null, "filevault_user": false, "volume_owner": false, "full_name": "System Services", "username": "daemon", "logged_in": false, "logged_in_time": null, "mobile_account": false, "home_folder_secure": false } ], "cursor": "NzgyZjQwNTQtYjk3MS00YmVjLTg1MGItN2JmMTNjZTgwNmZlfDc4" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/startup_settings": { "get": { "summary": "Startup settings", "description": "This request returns Startup settings for macOS.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Startup settings", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": null, "limit": 25, "total": 9, "data": [ { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-11-18T21:02:30.624669+00:00", "updated_at": "2025-01-16T15:59:47.247958+00:00", "last_changed_at": "2024-12-05T21:10:28.712257+00:00", "last_collected_at": "2025-01-16T15:59:47.247958+00:00", "sip": true, "ssv": true, "bootstrap_token_auth": false, "kext_requires_bst": true, "software_update_requires_bst": true, "bootstrap_token_escrowed": true, "external_boot_level": "allowed", "secure_boot_level": "full", "any_signed_os": null, "mdm_manages_kext": null, "user_manages_kext": null } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/system_extensions": { "get": { "summary": "System Extensions", "description": "This request returns System Extension attributes for macOS.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "System Extensions", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": null, "limit": 25, "total": 9, "data": [ { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-11-18T21:04:09.788902+00:00", "updated_at": "2024-12-10T16:24:08.495938+00:00", "last_changed_at": "2024-12-05T21:17:27.933277+00:00", "last_collected_at": "2024-12-10T16:24:08.495938+00:00", "path": "/Applications/Utilities/..", "identifier": "io.kandji.KandjiAgent.ESF", "state": "terminated_waiting_to_uninstall_on_reboot", "name": "Kandji ESF Extension", "short_version": "1.8.24", "bundle_version": "779", "categories": "com.apple.system_extension.endpoint_security", "bundle_path": "/Applications/Utilities/..", "team_id": "P3FGV63VK7", "is_mdm_managed": true } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/transparency_database": { "get": { "summary": "Transparency database", "description": "This request returns Transparency Database (TCC) attributes for macOS.", "parameters": [ { "name": "blueprint_ids", "in": "query", "required": false, "description": "Filter results by one or more blueprint IDs separated by commas.", "schema": { "type": "string" }, "example": "blueprint_id, blueprint_id,blueprint_id" }, { "name": "device_families", "in": "query", "required": false, "description": "Filter results by one or more device families separated by commas (`Mac`, `iPhone`, `iPad`, `tvOS`).", "schema": { "type": "string" }, "example": "Mac,iPhone,iPad,tvOS" }, { "name": "filter", "in": "query", "required": false, "description": "JSON schema object containing one or more key value pairs. Note: For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(-) order.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Transparency database", "content": { "application/json": { "schema": { "type": "object", "example": { "offset": null, "limit": 25, "total": 8, "data": [ { "device_id": "aa79459d-8566-4655-b09a-8f5c6bcf8b43", "device__name": "accuhive_admin", "device__family": "Mac", "device__user_id": "36600", "device__user_name": "Accuhive Admin", "device__user_email": "accuhive@accuhive.io", "blueprint_id": "9b1ce867-83dd-46bb-b79a-ba2b5c3a4acc", "blueprint_name": "_testing_something", "tags": null, "asset_tag": "", "serial_number": "FVHHFKF7Q6L4", "model_id": "MacBookAir10,1", "count": null, "created_at": "2024-11-18T21:08:21.491325+00:00", "updated_at": "2024-12-10T16:24:07.802225+00:00", "last_changed_at": null, "last_collected_at": "2024-12-10T16:24:07.802226+00:00", "service": "BluetoothAlways", "application": "com.okta.mobile", "client_type": "Bundle Identifier", "status": "Allowed", "status_reason": "User Consent", "last_modified": "2024-06-14T00:36:21.000042+00:00", "local_user": "testuser" } ], "cursor": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/export": { "post": { "summary": "Request category export", "description": "Request export of a category.", "parameters": [], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "required": true, "description": "JSON payload containing the export request configuration", "content": { "application/json": { "schema": { "type": "object", "properties": { "blueprint_ids": { "type": "array", "items": { "type": "string" }, "description": "List of one or more comma separate blueprint IDs.", "example": [ "string", "string", "string" ] }, "category": { "type": "string", "description": "Only one category per export request.", "enum": [ "apps", "activation_lock", "desktop_and_screensaver", "device_information", "gatekeeper_and_xprotect", "installed_profiles", "kernel_extensions", "local_users", "launch_agents_and_daemons", "system_extensions", "startup_settings", "transparency_database" ], "example": "device_information" }, "device_families": { "type": "array", "items": { "type": "string", "enum": [ "Mac", "iPhone", "iPad", "tvOS" ] }, "description": "List of one or more comma separated string values for device families.", "example": [ "Mac", "iPhone", "iPad", "tvOS" ] }, "filter": { "type": "object", "description": "JSON schema object containing one or more key value pairs. For detailed information on filters, see the Filters section at the beginning of the Visibility API endpoints in this doc.", "example": { "apple_silicon": { "eq": true }, "device__name": { "like": [ "this", "or_this" ] } } }, "sort_by": { "type": "string", "description": "Sort results by the name of a given response body key in either ascending (default behavior) or descending(`-`) order.", "example": "device__name" } }, "required": [ "category" ] } } } } } }, "/api/v1/prism/export/{export_id}": { "get": { "summary": "Get category export", "description": "Get an export request's status.", "parameters": [ { "name": "export_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "64cb5d3d-b180-4847-8b8a-34b14d8bc8d9", "status": "success", "category": "apps", "args": { "filter": {}, "columns": [], "sort_by": "", "blueprint_ids": [], "device_families": [] }, "error_msg": null, "path": "visibility-export-dev/28344fcc-579a-4d42-bcf7-cdbf97585066/export-2023-09-14-apps-64cb5d3d-b180-4847-8b8a-34b14d8bc8d9.csv", "signed_url": "https://amazonaws.com/28344fcc-579a-4d42-bcf7-cdbf97585066/export-2023-09-14-apps-64cb5d3d-b180-4847-8b8a-34b14d8bc8d9.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIASFTUYWXKYCKI2RPA%2F20230914%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230914T205848Z&X-Amz-Expires=172800&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEGUaCXVzLXdlc3QtMiJIMEYCIQD0Dnaf2gYxvGQXoouHEXGvIYwTOBzF5o5wFKFZwdNekAIhAIuzzarePTLat3Bb8Sof1ihyivS2dQHDWW5L7nUEhAHCKv8ECE4QAxoMMTQ5NDk1MDAyNTgxIgzdFKz6tJU%2BiEwY%2BBEq3ASeotuDFH3Ta%2F8hN34J%2BJjR3xGfmeh8N2c9mwJpWoOWrnVJ0he9aJL44C8tBnm%2FWfRbR3Co%2B9a5f2%2BlH83P83CoEij%2FIRX7XJ3qjpt2LYxZ4GOoME%2FSNP2cno3LMWGnOev5yctX2VkSFo8nVuB0r5a85SUxZq9ZkCiJ9DwYaArcKc5kmGjQ7dtZE3PM0oT4lyHiap5Qupn08ZYpPrAHZP%2BGooCn377hHwQfqAeWT%2BzT%2FLagR%2FGWWWNlaAEMGIkiso0rULgPAZ9tNxDbxTwBoitq0bTXed2wuMHtpiWiUEbs4MLkJh%2B6VbxO58hKFLOapuoKeOS%2FKZsc63Ohi2%2B7s%2BhIAe2cx%2BhzUi%2BQSIDn2RLAXGq0HOF5KWaXKVgGsRDXPGXoXCeiOljgcbPncnl0yEsaRkRitRjA7OJmcfeQc5vSpiGX0NkEOhnPHITtlg4ZEF7q1FG5gT92HLI0feuSwbP45e2o82Uod51lrQWpkaj5E3dCL1i0c5wdc4Um0HqTkXvBTy0wn%2BrMm%2FmbbFP0sA3i5c%2FM0tCHKQ9MKR2C5fI0zgCsT8MZc0c5AtFB76EuOk4xnSdWMlis4ISDF312vbxa6648QVknopJe9J1p8Huc%2FOaJxp0SmUw1a7X5yjlkyeDkol9WyObC8R%2BwA5%2BgxLQyhCE8odmr0LbD0D0xTKSshHYbH71uLWMbnn0HChkQGoqbDcohIxEkxePjF0VFYDizUKfEjgvom%2F6AvJeAe4yIJzgXxAa7DvkwCHE0nLxfioVc6FdinZ3jwvs2pnCYK8qjvU7kjObReYgubBUhMIjojagGOpkBY%2BVVHQWBiKn1ZlgcWyC3ufoMTo75qiz4P0mlvsc%2FLlPei0V5jZVga0KzA%2Bz5lz6JmKaDwww65fFRwVtoz1X7zD6L4HKWQ086EbvJGTjbQtuVfUrDtYHCfVkQfHOF%2Fo9gLXZ5ul7B35Uz7jmvLsf0VfsRxgqVSSI9glVkolZuvwAqwjkezmOBqGkTNxxtBKe8olNGd1Intj8l&X-Amz-Signature=4ad3bea9b06aacc6fe78657e86d80a24cadbc6866bb365d1b8fd8235ccc39020", "created_at": "2023-09-14T20:57:59.298293+00:00", "updated_at": "2023-09-14T20:58:00.341603+00:00" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/prism/count": { "get": { "summary": "Count", "description": "This request returns the total record count for the specified Prism category.", "parameters": [ { "name": "category", "in": "query", "required": false, "description": "Return the count of records for the specified category. \nIf a category contains spaces substitute the spaces for underscores (\"_\") when using the API query.\n\nExamples:\napps\ndevice_information\nkernel_extensions\nsystem_extensions", "schema": { "type": "string" }, "example": "apps" } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 82, "approximate": false } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/settings/licensing": { "get": { "summary": "Licensing", "description": "This request returns Iru Endpoint Management tenant licensing and utilization information.", "parameters": [], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "counts": { "type": "object", "properties": { "computers_count": { "type": "integer", "example": 8 }, "ios_count": { "type": "integer", "example": 0 }, "ipados_count": { "type": "integer", "example": 1 }, "macos_count": { "type": "integer", "example": 7 }, "tvos_count": { "type": "integer", "example": 0 } } }, "limits": { "type": "object", "properties": { "plan_type": { "type": "string", "example": "single_limit" }, "max_devices": { "type": "integer", "example": 10 }, "max_devices_per_platform": { "type": "object", "properties": { "macos": { "type": "integer", "example": 0 }, "ios_ipados": { "type": "integer", "example": 0 } } } } }, "tenantOverLicenseLimit": { "type": "boolean", "example": false } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/tags": { "get": { "summary": "Get Tags", "description": "This request returns configured tags.", "parameters": [ { "name": "search", "in": "query", "required": false, "description": "Return resultes containing a given tag search string.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 2, "next": null, "previous": null, "results": [ { "id": "71dd53f1-104e-41a2-82ca-43a375b7f63d", "name": "accuhive_01" }, { "id": "4fe23c39-7a9a-435c-bab3-d2e9fd1974c6", "name": "accuhive_02" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "post": { "summary": "Create Tag", "description": "This request creates a tag.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tag to create." } }, "required": [ "name" ] }, "example": { "name": "accuhive_01" } } } }, "responses": { "201": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "1467cc35-39e3-435d-8816-34c849c15bc3", "name": "accuhive_01" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/tags/{tag_id}": { "patch": { "summary": "Update Tag", "description": "This request updates a tag name.", "parameters": [ { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "4fe23c39-7a9a-435c-bab3-d2e9fd1974c6", "name": "accuhive_02" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "required": true, "description": "JSON payload containing the tag update information", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The new name for the tag", "example": "accuhive_02" } }, "required": [ "name" ] } } } } }, "delete": { "summary": "Delete Tag", "description": "This request deletes a tag.", "parameters": [ { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/threat-details": { "get": { "summary": "Get Threat Details", "description": "Get threat details.", "parameters": [ { "name": "classification", "in": "query", "required": false, "description": "Return all records matching a specified classification. The following classification options are available: `malware` and `pup`. Leave this parameter empty to return all classification types. Example: `malware`", "schema": { "type": "string", "enum": [ "malware", "pup" ] }, "example": "malware" }, { "name": "date_range", "in": "query", "required": false, "description": "Return all records within a specified number of days. Any positive number of days may be specified. Examples: `7`, `30`, `60`, `90`, `180`, or `365`. Example: `7`", "schema": { "type": "integer", "minimum": 1 }, "example": 7 }, { "name": "device_id", "in": "query", "required": false, "description": "Search for a specific device by the device id (uuid). Example: `15fcec08-xxxx-xxxx-xxxx-7c2f950910eb`", "schema": { "type": "string" }, "example": "15fcec08-xxxx-xxxx-xxxx-7c2f950910eb" }, { "name": "status", "in": "query", "required": false, "description": "Return all records matching a specified status. The following status options are available: `quarantined`, `not_quarantined`, or `released`. Leave this parameter empty to return all status types. Example: `quarantined`", "schema": { "type": "string", "enum": [ "quarantined", "not_quarantined", "released" ] }, "example": "quarantined" }, { "name": "sort_by", "in": "query", "required": false, "description": "Results can be sorted with the following options: `threat_name`, `classification`, `device_name`, `process_name`, `process_owner`, `detection_date`, `status`. Prepending a dash (-) to the parameter value will reverse the order of the returned results. Example: `status` or `-device_name`", "schema": { "type": "string", "enum": [ "threat_name", "classification", "device_name", "process_name", "process_owner", "detection_date", "status" ] }, "example": "status" }, { "name": "term", "in": "query", "required": false, "description": "Search term to filter threat results. The response will include anything matching the following fields: `device_name`, `file_hash`, and `file_path`. Example: `Chrome`", "schema": { "type": "string" }, "example": "Chrome" }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper `limit` is set at 1000 records returned per request. If more records are expected, pagination should be used using the `limit` and `offset` parameters. Example: `1000`", "schema": { "type": "integer", "maximum": 1000, "default": 1000 }, "example": 1000 }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return. Example: `1`", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "example": 1 } ], "responses": { "200": { "description": "using term param", "content": { "application/json": { "schema": { "type": "object", "example": { "count": 24, "next": null, "previous": null, "malware_count": 24, "pup_count": 0, "results": [ { "threat_name": "malware_5", "classification": "MALWARE", "status": "QUARANTINED", "process_name": "chmod", "process_owner": "root", "device_name": "accuhive MacBook Air", "device_id": "df1badd0-1dc9-448b-9b2a-c614a844c69e", "detection_date": "2023-04-21T17:23:13.883134", "date_of_quarantine": "2023-04-21T17:23:15.071621", "date_of_release": "", "released_by": "", "release_note": "", "file_path": "/Users/Shared/malware/malware_5", "file_hash": "2ab79665b07b3be11dd1d4f2d0bafa886a4b393b28ffedb2a02f62efd0061858", "bundle_path": "", "device_serial_number": "FVFGHGK7Q6L7", "blueprint_id": "396cdae2-147e-4e61-8a27-2f6b6963da4f", "blueprint_name": "Threat", "library_item_name": "Avert", "library_item_id": "d0afe50a-1102-4568-86ed-44863b757c85", "pup_posture": "protect", "malware_posture": "protect" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/behavioral-detections": { "get": { "summary": "Get Behavioral Detections", "description": "Get Behavioral Detections.", "parameters": [ { "name": "threat_id", "in": "query", "required": false, "description": "Filter by a specific threat ID. Example: `Kandji_BD_0096`", "schema": { "type": "string" }, "example": "Kandji_BD_0096" }, { "name": "classification", "in": "query", "required": false, "description": "Filter by threat classification. Example: `malicious`", "schema": { "type": "string" }, "example": "malicious" }, { "name": "status", "in": "query", "required": false, "description": "Filter by threat status. Example: `blocked`", "schema": { "type": "string" }, "example": "blocked" }, { "name": "date_range", "in": "query", "required": false, "description": "Return all records within a specified number of days. Example: `30`", "schema": { "type": "integer", "minimum": 1 }, "example": 30 }, { "name": "detection_date_from", "in": "query", "required": false, "description": "Start date for detection date range filter. Example: `2024-01-01`", "schema": { "type": "string", "format": "date" }, "example": "2024-01-01" }, { "name": "detection_date_to", "in": "query", "required": false, "description": "End date for detection date range filter. Example: `2024-01-31`", "schema": { "type": "string", "format": "date" }, "example": "2024-01-31" }, { "name": "device_id", "in": "query", "required": false, "description": "Search for a specific device by the device id (uuid). Example: `123e4567-e89b-12d3-a456-426614174000`", "schema": { "type": "string" }, "example": "123e4567-e89b-12d3-a456-426614174000" }, { "name": "malware_family", "in": "query", "required": false, "description": "Filter by malware family. Example: `TrickBot`", "schema": { "type": "string" }, "example": "TrickBot" }, { "name": "parent_process_name", "in": "query", "required": false, "description": "Filter by parent process. Example: `bash`", "schema": { "type": "string" }, "example": "bash" }, { "name": "target_process_name", "in": "query", "required": false, "description": "Filter by target process. Example: `python`", "schema": { "type": "string" }, "example": "python" }, { "name": "informational_tags", "in": "query", "required": false, "description": "Filter by tags. Example: `exploit,privilege_escalation`", "schema": { "type": "string" }, "example": "exploit,privilege_escalation" }, { "name": "term", "in": "query", "required": false, "description": "Search term to filter threat results. Device name, file hash, image path. Example: `device_name`", "schema": { "type": "string" }, "example": "device_name" }, { "name": "sort_by", "in": "query", "required": false, "description": "Detections can be sorted by any of the following keys. Prepending a dash (-) to the parameter value will reverse the order. Example: `status` or `-status`", "schema": { "type": "string", "enum": [ "threat_id", "classification", "device_name", "parent_process_name", "target_process_name", "detection_date", "status" ] }, "example": "status" }, { "name": "limit", "in": "query", "required": false, "description": "A hard upper limit is set at 1000 records returned per request. If more records are expected, pagination should be used using the limit and offset parameters. Example: `100`", "schema": { "type": "integer", "maximum": 1000, "default": 1000 }, "example": 100 }, { "name": "offset", "in": "query", "required": false, "description": "Specify the starting record to return. Example: `0`", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "example": 0 } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "total_count": 71, "next": null, "previous": null, "malicious_count": 37, "suspicious_count": 34, "results": [ { "id": "CC80F462-1F4D-4A04-9380-C21743DFC308", "threat_id": "KTI_BD_0163", "rule_version": 2, "description": "TP2419 long descriptionnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn123", "classification": "malicious", "informational_tags": [], "malware_family": [], "detection_date": "2025-03-08T17:35:30.462076+00:00", "threat_status": "detected", "device_info": { "id": "ddfc3341-f319-4ef0-bf9a-80791b15a79a", "name": "arm-14_7_0", "serial_number": "ZMN33JFKKC" }, "parent_process": { "name": "zsh", "command_line": "-zsh", "image_path": "/bin/zsh", "pid": 7657, "owner": "root", "sha256": "0ba6f44f486330453af994834aa406c8d398bfda68a54f3176bf3696ccc09c91" }, "target_process": { "name": "vim", "command_line": "vim 123", "image_path": "/usr/bin/vim", "pid": 7759, "owner": "root", "sha256": "c765f827442004d59ac6bd907f16fbda645f970a3bec94c2651a9f297a0f8030" }, "library_item": { "id": "6d4efe51-331a-4e92-bd63-33b1f2797ae5", "name": "Andreu LI", "mal_posture_mode": "protect" }, "blueprint": { "id": "f8034d27-d566-456e-8bbe-6a4dd1848961", "name": "Andreu BP" } }, { "id": "B42DF93B-1610-42CF-AB12-E8BF8C7A9D13", "threat_id": "KTI_BD_2796", "rule_version": 4, "description": "QA Testing Rule", "classification": "malicious", "informational_tags": [], "malware_family": [ "3CX", "AceDeceiver", "Activator", "AdvancedMacCleaner", "Adware.Gen", "AMCleaner", "AnyKeylogger" ], "detection_date": "2025-03-08T17:35:30.462076+00:00", "threat_status": "detected", "device_info": { "id": "ddfc3341-f319-4ef0-bf9a-80791b15a79a", "name": "arm-14_7_0", "serial_number": "ZMN33JFKKC" }, "parent_process": { "name": "zsh", "command_line": "-zsh", "image_path": "/bin/zsh", "pid": 7657, "owner": "root", "sha256": "0ba6f44f486330453af994834aa406c8d398bfda68a54f3176bf3696ccc09c91" }, "target_process": { "name": "vim", "command_line": "vim 123", "image_path": "/usr/bin/vim", "pid": 7759, "owner": "root", "sha256": "c765f827442004d59ac6bd907f16fbda645f970a3bec94c2651a9f297a0f8030" }, "library_item": { "id": "6d4efe51-331a-4e92-bd63-33b1f2797ae5", "name": "Andreu LI", "mal_posture_mode": "protect" }, "blueprint": { "id": "f8034d27-d566-456e-8bbe-6a4dd1848961", "name": "Andreu BP" } }, { "id": "AA97B8C8-7CBD-401A-9EC3-63A15A9936BC", "threat_id": "KTI_BD_0141", "rule_version": 10, "description": "Detects removal of Little Snitch by unloading the Little Snitch Launch Daemon.", "classification": "suspicious", "informational_tags": [ "exec", "Little Snitch", "Disable", "Launch Daemon", "unload" ], "malware_family": [], "detection_date": "2025-03-07T17:40:15.984091+00:00", "threat_status": "informational", "device_info": { "id": "ddfc3341-f319-4ef0-bf9a-80791b15a79a", "name": "arm-14_7_0", "serial_number": "ZMN33JFKKC" }, "parent_process": { "name": "zsh", "command_line": "-zsh", "image_path": "/bin/zsh", "pid": 462, "owner": "root", "sha256": "0ba6f44f486330453af994834aa406c8d398bfda68a54f3176bf3696ccc09c91" }, "target_process": { "name": "sudo", "command_line": "sudo launchctl unload /Library/LaunchDaemons/at.obdev.littlesnitchd.plist", "image_path": "/usr/bin/sudo", "pid": 5735, "owner": "root", "sha256": "938921ccaa776ab1bf2ca538e1ba63a8f981f047f236197581bcd968cd08f99f" }, "library_item": { "id": "6d4efe51-331a-4e92-bd63-33b1f2797ae5", "name": "Andreu LI", "mal_posture_mode": "protect" }, "blueprint": { "id": "f8034d27-d566-456e-8bbe-6a4dd1848961", "name": "Andreu BP" } } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/vulnerability-management/detections": { "get": { "summary": "List Detections", "description": "Retrieve a list of all vulnerability detections across the device fleet.", "parameters": [ { "name": "after", "in": "query", "required": false, "description": "Cursor token for pagination. Example: `eyJpZCI6MTIzNDU2Nzg5fQ==`", "schema": { "type": "string" }, "example": "eyJpZCI6MTIzNDU2Nzg5fQ==" }, { "name": "size", "in": "query", "required": false, "description": "A hard upper `limit` is set at 300 records returned per request. If more records are expected, pagination should be used using the URL value returned in the `next` attribute. Additionally, filters can be added to a request to limit the results. Example: `300`", "schema": { "type": "integer", "maximum": 300, "default": 300 }, "example": 300 }, { "name": "filter", "in": "query", "required": false, "description": "Filter on any key attribute within the response.\n\nAvailable fields: `device_id`, `device_name`, `device_serial_number`, `device_model`, `device_os_version`, `blueprint_id`, `blueprint_name`, `name`, `path`, `version`, `bundle_id`, `cve_id`, `cve_description`, `cve_link`, `cvss_score`, `cvss_severity`, `detection_datetime`, `cve_published_at`, `cve_modified_at`.\n\nExample: `{\"cve_id\":{\"in\":[\"CVE-2024-24795\"]}}`", "schema": { "type": "string" }, "example": "{\"cve_id\":{\"in\":[\"CVE-2024-24795\"]}}" } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" }, "example": { "next": null, "previous": null, "results": [ { "device_id": "abcd", "device_name": "accuhive MacBook Air", "device_serial_number": "FVFGHGK7Q6L7", "device_model": "MacBook", "device_os_version": "12.9", "blueprint_id": "396cdae2-147e-4e61-8a27-2f6b6963da4f", "blueprint_name": "Threat", "name": "Example", "version": "1.0.0", "path": "/path/to/app", "bundle_id": "com.microsoft", "cve_id": "CVE-2024-12345", "cve_description": "description of the cve from nvd", "cve_link": "https://nvd.nist.gov/vuln/detail/CVE-2024-12345", "cvss_score": 3.2, "cvss_severity": "Low", "first_detection_date": "2023-10-13 16:15:00.000000", "latest_detection_date": "2023-10-13 16:15:00.000000" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/vulnerability-management/vulnerabilities": { "get": { "summary": "List Vulnerabilities", "description": "Retrieve a list of all vulnerabilities grouped by CVE.", "parameters": [ { "name": "page", "in": "query", "required": false, "description": "The page number of the response. Example: `1`", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": 1 }, { "name": "size", "in": "query", "required": false, "description": "A hard upper `limit` is set at 50 records returned per request. If more records are expected, pagination should be used using the URL value returned in the `next` attribute. Additionally, filters can be added to a request to limit the results. Example: `50`", "schema": { "type": "integer", "maximum": 50, "default": 50 }, "example": 50 }, { "name": "sort_by", "in": "query", "required": false, "description": "Field to sort by. Available options: `age`, `cve_id`, `cvss_score`, `device_count`, `known_exploit`, `software` (software name), `severity`, `status`. Example: `cve_id`", "schema": { "type": "string", "enum": [ "age", "cve_id", "cvss_score", "device_count", "known_exploit", "software", "severity", "status" ] }, "example": "cve_id" }, { "name": "filter", "in": "query", "required": false, "description": "Filter results. Similar to prism filters.\n\nFilterable columns: `cve_id`, `software`, `severity`, `first_detection_date`, `status`.\n\nExample: `{\"cve_id\":{\"in\":[\"CVE-2024-24795\"]}}`", "schema": { "type": "string" }, "example": "{\"cve_id\":{\"in\":[\"CVE-2024-24795\"]}}" } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" }, "example": { "total": 1, "size": 50, "results": [ { "cve_id": "CVE-2024-24795", "severity": "High", "cvss_score": 7.5, "kev_score": 0, "cve_link": "https://nvd.nist.gov/vuln/detail/CVE-2018-25032", "first_detection_date": "2025-05-23T13:21:37.792889Z", "latest_detection_date": "2025-05-23T13:21:37.831775Z", "device_count": 1, "software": [ "macOS 12 Monterey" ], "status": "Active" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/blueprints/{blueprint_id}": { "patch": { "summary": "Update Blueprint", "description": "This request allows updating of the name, icon, icon color, description, enrollment code, and active status on an existing blueprint.", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the blueprint." } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "6391086e-85a1-4820-813c-f9c75025fff4", "name": "Default Blueprint", "icon": "ss-quote", "color": "orange-500", "description": "An example blueprint description", "params": {}, "computers_count": 1, "missing_computers_count": 1, "enrollment_code": { "code": "999858", "is_active": false } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } }, "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Update the name of the Blueprint" }, "color": { "type": "string", "description": "Update the color of the Blueprint icon. A list of possible color codes can be found at https://github.com/kandji-inc/support/wiki/Blueprint-API---Color-Codes. Color will be ignored for the map type." }, "description": { "type": "string", "description": "Update the description of the Blueprint" }, "enrollment_code.code": { "type": "string", "description": "Update the enrollment code of the Blueprint" }, "enrollment_code.is_active": { "type": "boolean", "description": "Disable the Blueprint for manual device enrollment from the enrollment portal" }, "icon": { "type": "string", "description": "Update the Blueprint icon. A list of possible icon codes can be found at https://github.com/kandji-inc/support/wiki/Blueprint-API-Icon-Codes. Icon will be ignored for the map type." } } } } } } }, "get": { "summary": "Get Blueprint", "description": "This request returns information about a specific blueprint based on blueprint ID.", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the blueprint." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "example": { "id": "b38787e4-401c-4c4b-86dc-f1cca2072531", "name": "auto_app_testing", "icon": "ss-paintdisabled", "color": "aqua-500", "description": "", "params": {}, "computers_count": 0, "enrollment_code": { "code": "752477", "is_active": true }, "type": "classic" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } }, "delete": { "summary": "Delete Blueprint", "description": "This is a HIGHLY destructive action - deleting a Blueprint will un-manage ALL devices assigned to the Blueprint.", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the blueprint." } ], "responses": { "204": { "description": "Blueprint deleted successfully" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/deleteuser": { "post": { "summary": "Delete device user", "description": "This endpoint sends an MDM command to delete a local user account on macOS and Shared iPad.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the device." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "DeleteAllUsers": { "type": "boolean", "description": "Delete all users on the device" }, "ForceDeletion": { "type": "boolean", "description": "Force deletion of the user" }, "UserName": { "type": "string", "description": "Username of the user to delete" } } } } } }, "responses": { "200": { "description": "User deletion command sent successfully", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/users": { "get": { "summary": "List users", "description": "This endpoint makes a request to retrieve a list of users from user directory integrations.", "parameters": [ { "name": "email", "in": "query", "required": false, "description": "Returns users with email addresses containing the provided string. Example: `test_user_01@accuhive.io`", "schema": { "type": "string" }, "example": "test_user_01@accuhive.io" }, { "name": "id", "in": "query", "required": false, "description": "Search for a user matching the provided UUID value. Example: `69c009ca-1f78-4bdf-bb93-08d6d39041db`", "schema": { "type": "string" }, "example": "69c009ca-1f78-4bdf-bb93-08d6d39041db" }, { "name": "integration_id", "in": "query", "required": false, "description": "Search for an integration matching the provided UUID value. Example: `f7461096-4ef9-43aa-88e9-ca1967ba0b38`", "schema": { "type": "string" }, "example": "f7461096-4ef9-43aa-88e9-ca1967ba0b38" }, { "name": "archived", "in": "query", "required": false, "description": "Return only users that are either archived (`true`) or not archived (`false`). Archived users are users that appear in the Users module under the Archived tab. Example: `false`", "schema": { "type": "boolean" }, "example": false }, { "name": "cursor", "in": "query", "required": false, "description": "Cursor for the next or previous page of results. Can also store the URL in the `next` and `previous` fields in the response. Example: `eyJpZCI6MTIzNDU2Nzg5fQ==`", "schema": { "type": "string" }, "example": "eyJpZCI6MTIzNDU2Nzg5fQ==" } ], "responses": { "200": { "description": "List of users", "content": { "application/json": { "schema": { "type": "object", "properties": { "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "type": "object", "properties": { "active": { "type": "boolean" }, "archived": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "department": { "type": "string", "nullable": true }, "deprecated_user_id": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "integration": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "uuid": { "type": "string" }, "type": { "type": "string" } } }, "job_title": { "type": "string", "nullable": true }, "name": { "type": "string" }, "device_count": { "type": "integer" }, "updated_at": { "type": "string", "format": "date-time" } } } } }, "example": { "next": "https://accuhive.kandji.io/api/v1/users?cursor=cD0yOTE0Mw%3D%3D", "previous": null, "results": [ { "active": true, "archived": false, "created_at": "2024-09-06T21:00:04.304248Z", "department": null, "deprecated_user_id": "29360", "email": "test_user_01@accuhive.io", "id": "69c009ca-1f78-4bdf-bb93-08d6d39041db", "integration": { "id": 634, "name": "accuhive", "uuid": "f7461096-4ef9-43aa-88e9-ca1967ba0b38", "type": "office365" }, "job_title": null, "name": "test_user_01", "device_count": 2, "updated_at": "2024-09-06T21:00:04.304280Z" }, { "active": true, "archived": false, "created_at": "2024-09-06T17:00:04.503800Z", "department": null, "deprecated_user_id": "29359", "email": "test_user_02@accuhive.io", "id": "adacf177-fbc2-4485-be26-05d8d965a8a6", "integration": { "id": 634, "name": "accuhive", "uuid": "f7461096-4ef9-43aa-88e9-ca1967ba0b38", "type": "office365" }, "job_title": null, "name": "test_user_02", "device_count": 0, "updated_at": "2024-09-06T17:00:04.503814Z" } ] } }, "example": { "next": "https://accuhive.kandji.io/api/v1/users?cursor=cD0yOTE0Mw%3D%3D", "previous": null, "results": [ { "active": true, "archived": false, "created_at": "2024-09-06T21:00:04.304248Z", "department": null, "deprecated_user_id": "29360", "email": "test_user_01@accuhive.io", "id": "69c009ca-1f78-4bdf-bb93-08d6d39041db", "integration": { "id": 634, "name": "accuhive", "uuid": "f7461096-4ef9-43aa-88e9-ca1967ba0b38", "type": "office365" }, "job_title": null, "name": "test_user_01", "device_count": 2, "updated_at": "2024-09-06T21:00:04.304280Z" }, { "active": true, "archived": false, "created_at": "2024-09-06T17:00:04.503800Z", "department": null, "deprecated_user_id": "29359", "email": "test_user_02@accuhive.io", "id": "adacf177-fbc2-4485-be26-05d8d965a8a6", "integration": { "id": 634, "name": "accuhive", "uuid": "f7461096-4ef9-43aa-88e9-ca1967ba0b38", "type": "office365" }, "job_title": null, "name": "test_user_02", "device_count": 0, "updated_at": "2024-09-06T17:00:04.503814Z" } ] } } } } } } }, "/api/v1/users/{user_id}": { "get": { "summary": "Get user", "description": "This request returns a specific user.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the user directory integration user." } ], "responses": { "200": { "description": "User details", "content": { "application/json": { "schema": { "type": "object", "example": { "active": true, "archived": false, "created_at": "2024-09-06T21:00:04.304248Z", "department": null, "deprecated_user_id": "29360", "email": "test_user_01@accuhive.io", "id": "69c009ca-1f78-4bdf-bb93-08d6d39041db", "integration": { "id": 634, "name": "accuhive", "uuid": "f7461096-4ef9-43aa-88e9-ca1967ba0b38", "type": "office365" }, "job_title": null, "name": "test_user_01", "device_count": 2, "updated_at": "2024-09-06T21:00:04.304280Z" } }, "example": { "active": true, "archived": false, "created_at": "2024-09-06T21:00:04.304248Z", "department": null, "deprecated_user_id": "29360", "email": "test_user_01@accuhive.io", "id": "69c009ca-1f78-4bdf-bb93-08d6d39041db", "integration": { "id": 634, "name": "accuhive", "uuid": "f7461096-4ef9-43aa-88e9-ca1967ba0b38", "type": "office365" }, "job_title": null, "name": "test_user_01", "device_count": 2, "updated_at": "2024-09-06T21:00:04.304280Z" } } } } } }, "delete": { "summary": "Delete user", "description": "This request deletes a user directory integration user.", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the user directory integration user." } ], "responses": { "200": { "description": "User deleted successfully", "content": { "application/json": { "schema": { "type": "object", "example": { "detail": "User deleted successfully" } } } } }, "400": { "description": "User still assigned to one or more devices", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "User still assigned to one or more devices." } } } } } } } } }, "/api/v1/blueprints/{blueprint_id}/assign-library-item": { "post": { "summary": "Assign Library Item", "description": "This endpoint allows assigning a library item to a specific blueprint (classic and maps).", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the blueprint." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "library_item_id": { "type": "string", "description": "The unique identifier of the library item to assign. Example: `12345678-1234-1234-1234-123456789012`" }, "assignment_node_id": { "type": "string", "description": "The assignment node ID for maps. Not required for classic blueprints or maps without conditional logic. Example: `node-123`" } }, "required": [ "library_item_id" ] }, "example": { "library_item_id": "12345678-1234-1234-1234-123456789012", "assignment_node_id": "node-123" } } } }, "responses": { "200": { "description": "success - classic", "content": { "application/json": { "schema": { "type": "object", "example": [ "c0148e35-c734-4402-b2fb-1c61aab72550", "a6063468-48aa-4e52-a098-fd9c7902201e", "e3d94912-d8bd-474b-9b90-c32288f84f99" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/blueprints/{blueprint_id}/list-library-items": { "get": { "summary": "List Library Items", "description": "This API endpoint retrieves a list of library items associated with a specific blueprint (classic and maps).", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the blueprint." } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "The total count of library items" }, "next": { "type": "string", "nullable": true, "description": "The URL for the next page of results, if available. If not available will value will be null" }, "previous": { "type": "string", "nullable": true, "description": "The URL for the previous page of results, if available. If not available will value will be null" }, "results": { "type": "array", "description": "An array containing library item objects", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the library item" }, "name": { "type": "string", "description": "The name of the library item" } } } } } }, "example": { "count": 3, "next": null, "previous": null, "results": [ { "id": "12345678-1234-1234-1234-123456789012", "name": "Custom App Example" }, { "id": "87654321-4321-4321-4321-210987654321", "name": "Custom Profile Example" }, { "id": "11111111-2222-3333-4444-555555555555", "name": "Custom Script Example" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/vulnerability-management/vulnerabilities/{cve_id}": { "get": { "summary": "Get Vulnerability Description", "description": "Retrieve information about a CVE.", "parameters": [ { "name": "cve_id", "in": "path", "required": true, "description": "The unique identifier of the vulnerability. Example: `CVE-2024-12345`", "schema": { "type": "string" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "cve_id": "CVE-2024-12345", "severity": "Low", "cvss_score": 3.2, "kev_score": 1, "epss_score": 0, "cve_link": "https://nvd.nist.gov/vuln/detail/CVE-2023-12345", "description": "description of the cve from nvd", "first_detection_date": "2023-10-13 16:15:00.000000", "software_count": 3, "latest_detection_date": "2023-10-13 16:15:00.000000", "device_count": 2, "cve_published_at": "2023-10-13 16:15:00.000000", "cve_modified_at": "2023-10-13 16:15:00.000000" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/vulnerability-management/vulnerabilities/{cve_id}/devices": { "get": { "summary": "List Affected Devices", "description": "Retrieve a list of devices impacted by a specified cve_id vulnerability for a tenants fleet.", "parameters": [ { "name": "cve_id", "in": "path", "required": true, "description": "The unique identifier of the vulnerability. Example: `CVE-2024-12345`", "schema": { "type": "string" }, "example": "CVE-2024-12345" }, { "name": "page", "in": "query", "required": false, "description": "The page number of the response. Example: `1`", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": 1 }, { "name": "size", "in": "query", "required": false, "description": "A hard upper `limit` is set at 50 records returned per request. If more records are expected, pagination should be used using the URL value returned in the `next` attribute. Additionally, filters can be added to a request to limit the results. Example: `50`", "schema": { "type": "integer", "maximum": 50, "default": 50 }, "example": 50 }, { "name": "sort_by", "in": "query", "required": false, "description": "Field to sort by. Available options: `name` (device name), `detection_datetime`. Example: `software_name`", "schema": { "type": "string", "enum": [ "name", "detection_datetime" ] }, "example": "software_name" }, { "name": "filter", "in": "query", "required": false, "description": "Filter results.\n\nFilterable columns: `name`, `detection_datetime`.\n\nExample: `{\"detection_datetime\":{\"gte\":\"2025-05-23T17:11:31.816587Z\"}}`", "schema": { "type": "string" }, "example": "{\"detection_datetime\":{\"gte\":\"2025-05-23T17:11:31.816587Z\"}}" } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object" }, "example": { "total": 2, "page": 1, "size": 50, "results": [ { "device_id": "abcd", "name": "accuhive MacBook Air", "serial_number": "FVFGHGK7Q6L7", "model": "Macbook", "os_version": "12.5", "blueprint_id": "396cdae2-147e-4e61-8a27-2f6b6963da4f", "blueprint_name": "Vuln", "assigned_user": "User Name", "no_of_installs": 2, "software_summary": { "name": "macOS 11 Catalina", "detection_date": "2023-10-13 16:15:00.000000", "path": "/path/to/app", "version": "1.2.1" } } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/vulnerability-management/vulnerabilities/{cve_id}/software": { "get": { "summary": "List Affected Software", "description": "This endpoint makes a request to retrieve a list of software impacted by a specified cve_id vulnerability for a tenant's fleet.", "parameters": [ { "name": "cve_id", "in": "path", "required": true, "description": "The unique identifier of the vulnerability. Example: `CVE-2024-12345`", "schema": { "type": "string" }, "example": "CVE-2024-12345" }, { "name": "page", "in": "query", "required": false, "description": "The page number of the response. Example: `1`", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": 1 }, { "name": "size", "in": "query", "required": false, "description": "A hard upper `limit` is set at 50 records returned per request. If more records are expected, pagination should be used using the URL value returned in the `next` attribute. Additionally, filters can be added to a request to limit the results. Example: `50`", "schema": { "type": "integer", "maximum": 50, "default": 50 }, "example": 50 }, { "name": "sort_by", "in": "query", "required": false, "description": "Field to sort by. Available options: `software` (software name), `detection_datetime`. Example: `software`", "schema": { "type": "string", "enum": [ "software", "detection_datetime" ] }, "example": "software" }, { "name": "filter", "in": "query", "required": false, "description": "Filter results. Similar to prism filters.\n\nFilterable columns: `blueprint_id`, `detection_datetime`.\n\nExample: `{\"detection_datetime\":{\"gte\":\"2025-05-23T17:11:31.816587Z\"}}`", "schema": { "type": "string" }, "example": "{\"detection_datetime\":{\"gte\":\"2025-05-23T17:11:31.816587Z\"}}" } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "example": { "total": 1, "page": 1, "size": 50, "results": [ { "name": "app_name", "bundle_id": "bundle_id", "num_versions": 2, "type": null, "blueprints": [ { "id": "blueprint", "name": "name_blueprint" } ], "num_devices": 2, "software_versions": [ { "latest_detection_date": "2023-10-13 16:15:00.000000", "blueprints": [ { "id": "id_num", "name": "my_blueprint" } ], "version": "1.2.1", "devices_impacted": 2 }, { "latest_detection_date": "2023-10-13 16:15:00.000000", "blueprints": [ { "id": "id_num", "name": "my_blueprint" } ], "version": "1.3.1", "devices_impacted": 1 } ] }, { "cve_id": "CVE-2018-25032", "severity": "High", "cvss_score": 7.5, "kev_score": 0, "cve_link": "https://nvd.nist.gov/vuln/detail/CVE-2018-25032", "first_detection_date": "2025-05-23T13:21:37.792889Z", "latest_detection_date": "2025-05-23T13:21:37.831775Z", "device_count": 1, "software": [ "macOS 12 Monterey" ], "status": "Active" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Bad Request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" } } } } } } } } }, "/api/v1/devices/{device_id}/action/dailycheckin": { "post": { "summary": "Daily check-in", "description": "This endpoint sends a daily check-in command to a device.", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Daily check-in command sent successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" } } } } } } } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string", "description": "Error message" } } } } }, "security": [ { "BearerAuth": [] } ] }