| Required role: | TenantReader |
| GET | /api/timeseries/ | Returns all timeseries | |
|---|---|---|---|
| GET | /timeseries/ | Returns all timeseries |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantName | header | string | Yes | |
| IncludeDeleted | query | bool? | No | If true, also soft deleted items will be returned |
| GroupBy | query | string | No | The property, the data will be grouped on |
| AggregateOn | query | string | No | The property, used for aggregation |
| Aggregation | query | Aggregations? | No | The aggregation function to use |
| IncludeReferencedObjects | query | bool? | No | Returns all referenced object |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| TenantId | form | Guid | No | |
| Tenant | form | Tenant | No | |
| Name | form | string | Yes | |
| DisplayName | form | string | No | |
| SelfLink | form | string | Yes | |
| ObjectType | form | ObjectTypes | Yes | |
| Description | form | string | No | |
| SourceType | form | ObjectTypes | No | |
| AutoCollection | form | bool | No | |
| AutoCollectionQuery | form | string | No | |
| AutoCollectionInterval | form | int? | No | |
| AutoCollectionIntervalUnit | form | IntervalUnits? | No | |
| AutoCollectionTime | form | TimeOnly? | No | |
| LastAutoCollected | form | DateTime? | No | |
| RetentionTimeMonths | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Created | form | DateTime | Yes | |
| CreateUser | form | string | Yes | |
| CreateUserId | form | string | Yes | |
| Modified | form | DateTime | Yes | |
| ModifyUser | form | string | Yes | |
| ModifyUserId | form | string | Yes | |
| IsDeleted | form | bool | Yes | |
| Deleted | form | DateTime? | No | |
| DeleteUser | form | string | No | |
| DeleteUserId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| ObjectType | form | ObjectTypes | Yes | |
| SelfLink | form | string | Yes | |
| Variables | form | IList<Variable> | Yes | |
| AllowedMailDomains | form | IList<string> | Yes | |
| LicensedModules | form | IList<string> | Yes | |
| DefaultDeploymentLifetimeDays | form | short | Yes | |
| MaxDeploymentLifetimeDays | form | short | Yes | |
| SystemUnpatchedWarningDays | form | short | Yes | |
| SystemBackupMissingWarningHours | form | short | Yes | |
| StopVulnerableResourceAfterDays | form | short | Yes | |
| DeploymentExpirationWarningDays | form | short | Yes | |
| PatchNotificationDays | form | short | Yes | |
| UseCustomHostnames | form | bool | Yes | |
| RemoveInactiveVulnerabilitiesAfterDays | form | short | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | Yes | |
| DisplayName | form | string | Yes | |
| Description | form | string | No | |
| ObjectType | form | ObjectTypes | No | |
| SelfLink | form | string | Yes | |
| Tags | form | IList<Tag> | Yes | |
| Path | form | IList<PathItem> | Yes |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Value | form | string | No | |
| IsProtected | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Label | form | string | Yes | |
| Link | form | string | Yes | |
| ObjectType | form | ObjectTypes | No | |
| ObjectId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Value | form | string | Yes | |
| Type | form | ValueDataType | No | |
| Description | form | string | No | |
| IsInherited | form | bool | No | |
| Environment | form | Environments? | No |
| String | |
| Number | |
| Boolean | |
| List |
| Lab | |
| Poc | |
| Dev | |
| Test | |
| Int | |
| Uat | |
| Prod |
| Second | |
| Minute | |
| Hour | |
| Day | |
| Week | |
| Month | |
| Year |
| None | |
| Count | |
| DistinctCount | |
| Sum | |
| Min | |
| Max | |
| Avg | |
| First |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<TimeSeriesDefinition> | Yes | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | 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.
GET /api/timeseries/ HTTP/1.1 Host: core.starburst.svc Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"offset":0,"total":0,"results":[{"id":"00000000-0000-0000-0000-000000000000","tenantId":"00000000-0000-0000-0000-000000000000","tenant":{"name":"String","objectType":"Tenant","selfLink":"/tenants/00000000-0000-0000-0000-000000000000","variables":null,"allowedMailDomains":null,"licensedModules":null,"defaultDeploymentLifetimeDays":0,"maxDeploymentLifetimeDays":0,"systemUnpatchedWarningDays":0,"systemBackupMissingWarningHours":0,"stopVulnerableResourceAfterDays":0,"deploymentExpirationWarningDays":0,"patchNotificationDays":0,"useCustomHostnames":false,"removeInactiveVulnerabilitiesAfterDays":0,"id":"00000000-0000-0000-0000-000000000000","displayName":"String","description":"String","tags":null,"path":null,"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String"},"name":"String","displayName":"String","selfLink":"/timeseries/00000000-0000-0000-0000-000000000000","objectType":"TimeSeries","description":"String","sourceType":"None","autoCollection":false,"autoCollectionQuery":"String","autoCollectionInterval":0,"autoCollectionIntervalUnit":"Second","autoCollectionTime":"00:00","lastAutoCollected":"0001-01-01T00:00:00.0000000Z","retentionTimeMonths":0,"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}