| Required roles: | TenantReader, TenantAdmin |
| POST | /api/timeseries/ | Creates a new time series definition | |
|---|---|---|---|
| POST | /timeseries/ | Creates a new time series definition |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantName | header | string | Yes | |
| Name | body | string | Yes | The unique name of the time series |
| DisplayName | body | string | No | The time series display name |
| Description | body | string | No | A more detailed description for the series |
| SourceType | body | string | No | The source type of the time series. Only used when AutoCollection is true |
| AutoCollectionQuery | body | string | No | The query used to extract datapoints from source table. Only used when AutoCollection is true |
| AutoCollectionInterval | body | int | No | How often a datapoint will be collected, Only used when AutoCollection is true |
| AutoCollectionIntervalUnit | body | int | No | The interval unit for auto collection, Only used when AutoCollection is true |
| AutoCollectionTime | body | string | No | The time (UTC), when the query will be executed to collect the datapoints, Only used when AutoCollection is true |
| AutoCollection | body | bool | No | How often a datapoint will be collected, Only used when AutoCollection is true |
| RetentionTimeMonths | body | double | No | How many months to keep data in the time series before deleting them |
| None | |
| ConfigItem | |
| Tenant | |
| Collection | |
| Resource | |
| ComputeNode | |
| VirtualMachine | |
| PhysicalMachine | |
| Disk | |
| Subnet | |
| IPAddress | |
| Job | |
| JobEvent | |
| FreezePeriod | |
| ResourceGroup | |
| Deployment | |
| ResourceGroupTemplate | |
| DeploymentTemplate | |
| ResourceProvider | |
| GenericResource | |
| Role | |
| Permission | |
| User | |
| PatchingWindow | |
| Update | |
| ReportDefinition | |
| TimeSeries | |
| DataPoint | |
| Action | |
| ActionAssignment | |
| UserNote |
| Second | |
| Minute | |
| Hour | |
| Day | |
| Week | |
| Month | |
| Year |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | Yes | |
| Description | form | string | No | |
| SourceType | form | ObjectTypes | No | |
| AutoCollectionQuery | form | string | No | |
| AutoCollectionInterval | form | double? | No | |
| AutoCollectionIntervalUnit | form | IntervalUnits? | No | |
| AutoCollectionTime | form | TimeOnly? | No | |
| LastAutoCollected | form | DateTime? | No | |
| AutoCollection | form | bool | No | |
| RetentionTimeMonths | form | int? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/timeseries/ HTTP/1.1
Host: core.starburst.svc
Accept: application/json
Content-Type: application/json
Content-Length: length
{"tenantName":"String","name":"String","displayName":"String","description":"String","sourceType":"None","autoCollectionQuery":"String","autoCollectionInterval":0,"autoCollectionIntervalUnit":"Second","autoCollectionTime":"00:00","autoCollection":false,"retentionTimeMonths":0,"txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"id":"00000000-0000-0000-0000-000000000000","name":"String","description":"String","sourceType":"None","autoCollectionQuery":"String","autoCollectionInterval":0,"autoCollectionIntervalUnit":"Second","autoCollectionTime":"00:00","lastAutoCollected":"0001-01-01T00:00:00.0000000Z","autoCollection":false,"retentionTimeMonths":0}