Trigger Integration Module's refresh operation
POST/homes/{homeId}/intmods/{configId}/refresh
Base URL: https://api.tinkermode.com
Trigger the refresh operations and return the list of jobs that are invoked and run asynchronously.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain the API key of a user or service account who has the permission to request OAuth2 authorization tokens for the specified integration module configuration, or a Project API Key with admin permission.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
homeId | integer | Yes | The unique ID for a specified home. | |
configId | string | Yes | Integration Module Configuration ID |
Responses
200 Trigger refresh operation successfully.
Content type: application/json
Represents an integration module configuration created in a project.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
catalogType | string | Yes | Catalog type of the integration module. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
claims | object | No | Claims is the definition of the authentication method and credentials for the integration module. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
configId | string | Yes | read-only (server-generated) | Unique Integration Module ID. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
homeId | integer | Yes | Home that this integration module belongs to. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
projectId | integer | Yes | read-only (server-generated) | Project that this integration module belongs to. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
schedule | object | No | Schedule is the definition of the schedule for the integration module. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response example
[
{
"configId": "safie-h1",
"createdAt": "2025-03-28T04:34:17.904Z",
"expiresAfter": "2025-03-29T04:34:17.904Z",
"homeId": 1,
"id": "67e626c9e10ae4e034ba1753",
"numDispatchedMessages": 4,
"numFailedMessages": 0,
"numSuccessfulMessages": 4,
"operation": {
"name": "devices",
"parameters": [
{
"name": "offset",
"value": 0
}
]
},
"projectId": 2,
"status": "succeeded",
"updatedAt": "2025-03-28T04:49:43.769Z"
},
{
"configId": "safie-h1",
"createdAt": "2025-03-28T04:33:49.48Z",
"expiresAfter": "2025-03-29T04:33:49.48Z",
"homeId": 1,
"id": "67e626ade10ae4e034ba174d",
"numDispatchedMessages": 2,
"numFailedMessages": 0,
"numSuccessfulMessages": 1,
"operation": {
"name": "devices",
"parameters": [
{
"name": "offset",
"value": 0
}
]
},
"projectId": 2,
"status": "timedOut",
"updatedAt": "2025-03-28T04:34:45.3Z"
}
]401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 Request failed because of invalid data or denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |