POST api/v1/integrations/users/heartbeats

Create integration user heartbeat

Request Information

URI Parameters

None.

Body Parameters

request

CreateIntegrationUserHeartbeatV1Request
NameDescriptionTypeAdditional information
Configuration

Configuration

string

Required

Example value: { "DataSources": { .. }, "Integrations": { .. }, "CleanupFolder": { .. } }

Max length: 10000

Version

Version

string

Required

Example value: 1.0.0.0

Max length: 100

Drives

Drives

Collection of CreateIntegrationUserHeartbeatV1RequestDrive

None.

DataSourceEnabled

Data source enabled

boolean

Required

Example value: True

DataSources

Data sources

Collection of CreateIntegrationUserHeartbeatV1RequestDataSource

Required

IntegrationEnabled

Integration enabled

boolean

Required

Example value: True

IntegrationDefaultEnabled

Integration default enabled

boolean

Required

Example value: True

Integrations

Integrations

Collection of CreateIntegrationUserHeartbeatV1RequestIntegration

Required

Request Formats

application/json

Sample:
{
  "Configuration": "{ \"DataSources\": { .. }, \"Integrations\": { .. }, \"CleanupFolder\": { .. } }",
  "Version": "1.0.0.0",
  "Drives": [
    {
      "Path": "C:\\",
      "AvailableFreeSpace": 212199067648,
      "TotalFreeSpace": 212199067648,
      "TotalSize": 445561290752
    },
    {
      "Path": "C:\\",
      "AvailableFreeSpace": 212199067648,
      "TotalFreeSpace": 212199067648,
      "TotalSize": 445561290752
    }
  ],
  "DataSourceEnabled": true,
  "DataSources": [
    {
      "DataSourceId": "dedc2af7-cc8a-450b-ab48-28ba04e3f00b"
    },
    {
      "DataSourceId": "dedc2af7-cc8a-450b-ab48-28ba04e3f00b"
    }
  ],
  "IntegrationEnabled": true,
  "IntegrationDefaultEnabled": true,
  "Integrations": [
    {
      "IntegrationId": "f7a7d62f-ba5b-42bf-b432-77e47d0f51fc"
    },
    {
      "IntegrationId": "f7a7d62f-ba5b-42bf-b432-77e47d0f51fc"
    }
  ]
}

Response Information

Resource Description

Create integration user heartbeat

CreateIntegrationUserHeartbeatV1Response
NameDescriptionTypeAdditional information
IntegrationUserHeartbeatId

Integration user heartbeat id

universally unique identifier

Required

Example value: bfaae461-8755-4e81-8e68-183249367136

Response Formats

application/json

Sample:
{
  "IntegrationUserHeartbeatId": "bfaae461-8755-4e81-8e68-183249367136"
}