{ "info": { "_postman_id": "ad6e620b-b7f2-44e4-b47b-674c973acf39", "name": "ThingsBoard Admin admin-controller domain-controller API", "description": "ThingsBoard Admin API \u2014 subset of the ThingsBoard REST API (open-source IoT platform). Covers: Admin, Audit Log, Event, Usage Info, Queue, Queue Stats, Mail Config Template, Qr Code Settings, Job.\n\nContact Support:\n Name: ThingsBoard team\n Email: info@thingsboard.io", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:12:30.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "lastUpdatedBy": "35240", "uid": "35240-ad6e620b-b7f2-44e4-b47b-674c973acf39" }, "item": [ { "name": "api", "item": [ { "name": "domain", "item": [ { "name": "{id}", "item": [ { "name": "oauth2Clients", "item": [ { "name": "Update Oauth2 Clients (updateOauth2Clients)", "id": "39c7ab45-1079-4150-a00f-59c6d314bcfc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/:id/oauth2Clients", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", ":id", "oauth2Clients" ], "variable": [ { "id": "ca79f78d-8fa7-4762-8450-d083d8f84552", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Update oauth2 clients for the specified domain. " }, "response": [ { "id": "fd3c8f77-8890-43fb-ab6b-c05415348ce9", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/:id/oauth2Clients", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", ":id", "oauth2Clients" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-fd3c8f77-8890-43fb-ab6b-c05415348ce9" } ], "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-39c7ab45-1079-4150-a00f-59c6d314bcfc" } ], "id": "153d24bf-2100-4302-a12f-4c0633454be3", "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-153d24bf-2100-4302-a12f-4c0633454be3" }, { "name": "Delete Domain by ID (deleteDomain)", "id": "f152562d-e8b9-43e2-afbc-9f65e5b5a49d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/domain/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", ":id" ], "variable": [ { "id": "77e3b321-f796-4067-9448-9fe98ead636f", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Deletes Domain by ID. Referencing non-existing domain Id will cause an error.\n\nAvailable for users with 'SYS_ADMIN' authority." }, "response": [ { "id": "1a1a7ded-e5eb-4dc4-9f7d-26f964166427", "name": "OK", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/domain/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-1a1a7ded-e5eb-4dc4-9f7d-26f964166427" } ], "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-f152562d-e8b9-43e2-afbc-9f65e5b5a49d" } ], "id": "b7aa306a-6c22-4837-9133-2c5479af3dae", "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-b7aa306a-6c22-4837-9133-2c5479af3dae" }, { "name": "infos", "item": [ { "name": "Get Domain Infos (getTenantDomainInfos)", "id": "272005a3-adb8-46c0-974a-05c080fd823b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/domain/infos?pageSize=&page=&textSearch=&sortProperty=&sortOrder=", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "infos" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Case-insensitive 'substring' filter based on domain's name", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "" } ] }, "description": "\n\nAvailable for users with 'SYS_ADMIN' authority." }, "response": [ { "id": "71dfe159-4d3f-4fae-8afb-0c322f75bb23", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/domain/infos?pageSize=&page=&textSearch=&sortProperty=&sortOrder=", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "infos" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Case-insensitive 'substring' filter based on domain's name", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"MOBILE_APP\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"oauth2Enabled\": \"\",\n \"propagateToEdge\": \"\",\n \"oauth2ClientInfos\": [\n {\n \"id\": {\n \"entityType\": \"QUEUE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"title\": \"\",\n \"providerName\": \"\",\n \"platforms\": [\n \"IOS\",\n \"WEB\"\n ],\n \"name\": \"\"\n },\n {\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"title\": \"\",\n \"providerName\": \"\",\n \"platforms\": [\n \"IOS\",\n \"WEB\"\n ],\n \"name\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_RULE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"oauth2Enabled\": \"\",\n \"propagateToEdge\": \"\",\n \"oauth2ClientInfos\": [\n {\n \"id\": {\n \"entityType\": \"NOTIFICATION_REQUEST\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"title\": \"\",\n \"providerName\": \"\",\n \"platforms\": [\n \"WEB\",\n \"IOS\"\n ],\n \"name\": \"\"\n },\n {\n \"id\": {\n \"entityType\": \"ADMIN_SETTINGS\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"title\": \"\",\n \"providerName\": \"\",\n \"platforms\": [\n \"WEB\",\n \"WEB\"\n ],\n \"name\": \"\"\n }\n ]\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-71dfe159-4d3f-4fae-8afb-0c322f75bb23" } ], "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-272005a3-adb8-46c0-974a-05c080fd823b" } ], "id": "8174d69a-c428-4abe-a9e3-b7fb67f6bfb9", "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-8174d69a-c428-4abe-a9e3-b7fb67f6bfb9" }, { "name": "info", "item": [ { "name": "{id}", "item": [ { "name": "Get Domain Info by Id (getDomainInfoById)", "id": "071e258f-775c-47ee-ae80-a9748b8d896c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/domain/info/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "info", ":id" ], "variable": [ { "id": "2009c88a-d438-47a0-b84b-5d344fc19c77", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "\n\nAvailable for users with 'SYS_ADMIN' authority." }, "response": [ { "id": "155cf912-532b-4cc8-863f-d113585abc6c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/domain/info/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "info", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"ALARM\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"oauth2Enabled\": \"\",\n \"propagateToEdge\": \"\",\n \"oauth2ClientInfos\": [\n {\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"title\": \"\",\n \"providerName\": \"\",\n \"platforms\": [\n \"ANDROID\",\n \"WEB\"\n ],\n \"name\": \"\"\n },\n {\n \"id\": {\n \"entityType\": \"CALCULATED_FIELD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"title\": \"\",\n \"providerName\": \"\",\n \"platforms\": [\n \"ANDROID\",\n \"WEB\"\n ],\n \"name\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-155cf912-532b-4cc8-863f-d113585abc6c" } ], "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-071e258f-775c-47ee-ae80-a9748b8d896c" } ], "id": "512dc968-dd9c-4e79-87a3-97dc24c4d10c", "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-512dc968-dd9c-4e79-87a3-97dc24c4d10c" } ], "id": "4a19636e-f1af-444d-8dc7-c7fc011895be", "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-4a19636e-f1af-444d-8dc7-c7fc011895be" }, { "name": "Save or Update Domain (saveDomain)", "id": "9fb0f5ab-461e-4db7-9c57-10146eff748f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"API_USAGE_STATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"oauth2Enabled\": \"\",\n \"propagateToEdge\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain?oauth2ClientIds=&oauth2ClientIds=", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain" ], "query": [ { "description": "A list of oauth2 client registration ids, separated by comma ','", "key": "oauth2ClientIds", "value": "" }, { "description": "A list of oauth2 client registration ids, separated by comma ','", "key": "oauth2ClientIds", "value": "" } ] }, "description": "Create or update the Domain. When creating domain, platform generates Domain Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Domain Id will be present in the response. Specify existing Domain Id to update the domain. Referencing non-existing Domain Id will cause 'Not Found' error.\n\nDomain name is unique for entire platform setup.\n\n\n\nAvailable for users with 'SYS_ADMIN' authority." }, "response": [ { "id": "a1fe360b-36af-406a-854c-921cc19b3c98", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"API_USAGE_STATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"oauth2Enabled\": \"\",\n \"propagateToEdge\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain?oauth2ClientIds=", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain" ], "query": [ { "description": "A list of oauth2 client registration ids, separated by comma ','", "key": "oauth2ClientIds", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"API_USAGE_STATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"oauth2Enabled\": \"\",\n \"propagateToEdge\": \"\"\n}", "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-a1fe360b-36af-406a-854c-921cc19b3c98" } ], "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-9fb0f5ab-461e-4db7-9c57-10146eff748f" } ], "id": "2d7ba1c1-f22d-4475-855c-abd78c35d922", "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-2d7ba1c1-f22d-4475-855c-abd78c35d922" } ], "id": "f0849bec-d7f2-46f4-aac2-8fd494344e28", "createdAt": "2026-07-28T03:12:31.000Z", "updatedAt": "2026-07-28T03:12:31.000Z", "uid": "35240-f0849bec-d7f2-46f4-aac2-8fd494344e28" } ], "variable": [ { "key": "baseUrl", "value": "https://demo.thingsboard.io" } ] }