| Required role: | TenantReader |
| GET | /api/resourcegroups/search | Returns all resourcegroups | |
|---|---|---|---|
| GET | /resourcegroups/search | Returns all resourcegroups |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Identity | query | string | No | Searches for name or displayname containing the value |
| Name | query | string | No | |
| DisplayName | query | string | No | |
| TenantName | header | string | Yes | |
| IncludeDeleted | query | bool? | No | If true, also soft deleted items will be returned |
| IncludeReferencedObjects | query | bool? | No | Returns all referenced object |
| 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 useAllowable Values
|
| 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 |
|---|---|---|---|---|
| ShortId | form | string | Yes | |
| TenantId | form | Guid | Yes | |
| Name | form | string | Yes | |
| ObjectType | form | ObjectTypes | Yes | |
| SelfLink | form | string | Yes | |
| Environment | form | Environments | Yes | |
| State | form | LifecycleStates | Yes | |
| ParentId | form | Guid | Yes | |
| Parent | form | Deployment | No | |
| TemplateId | form | Guid? | No | |
| Parameters | form | IList<Parameter> | Yes | |
| Variables | form | IList<Variable> | Yes | |
| NextPatchDate | form | DateTime? | No | |
| Composition | form | ResourceCompositions | No |
| 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 |
| 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 |
| 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 |
| Lab | |
| Poc | |
| Dev | |
| Test | |
| Int | |
| Uat | |
| Prod |
| New | |
| Deploying | |
| Deployed | |
| Removing | |
| Removed | |
| Failure | |
| Imported |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShortId | form | string | Yes | |
| TenantId | form | Guid | Yes | |
| Name | form | string | Yes | |
| NameUserDefinedPart | form | string | Yes | |
| ObjectType | form | ObjectTypes | Yes | |
| SelfLink | form | string | Yes | |
| State | form | LifecycleStates | Yes | |
| Environment | form | Environments | Yes | |
| TemplateId | form | Guid? | No | |
| Parameters | form | IList<Parameter> | Yes | |
| Variables | form | IList<Variable> | Yes | |
| VariablesSnapshot | form | IList<Variable> | Yes | |
| ParentId | form | Guid | Yes | |
| Parent | form | DeploymentCollection | No | |
| ValidFrom | form | DateTime | Yes | |
| ValidUntil | form | DateTime? | No | |
| IsNeverExpiring | form | bool | Yes | |
| NextPatchDate | form | DateTime? | No | |
| DefaultResourceProviderId | form | Guid | Yes | |
| NeedsAttention | form | bool | Yes | |
| Composition | form | ResourceCompositions | No | |
| MonthlyBudget | form | decimal | No | |
| SendBudgetNotificationMails | form | bool | No | |
| BudgetWarningThresholdPercent | form | int | No | |
| OperationalState | form | OperationalStates | No | |
| ResourcesRunning | form | int | No | |
| ResourcesTotal | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | No | |
| Value | form | string | No | |
| Default | form | string | No | |
| Optional | form | bool | No | |
| Type | form | ParameterValueType | No | |
| Validation | form | string | No |
| String | |
| Number | |
| Boolean | |
| SecureString |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantId | form | Guid | Yes | |
| Name | form | string | Yes | |
| ObjectType | form | ObjectTypes | Yes | |
| SelfLink | form | string | Yes | |
| Variables | form | IList<Variable> | Yes | |
| IsLostAndFound | form | bool | Yes | |
| MonthlyBudget | form | decimal | No | |
| SendBudgetNotificationMails | form | bool | No | |
| BudgetWarningThresholdPercent | form | int | No |
| Native | |
| Foreign | |
| Mixed |
| None | |
| Starting | |
| Running | |
| Stopping | |
| Stopped | |
| Restarting | |
| Deleting | |
| Unknown |
| 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 |
| 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 |
|---|---|---|---|---|
| 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 |
| Second | |
| Minute | |
| Hour | |
| Day | |
| Week | |
| Month | |
| Year |
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/resourcegroups/search 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":[{"shortId":"String","tenantId":"00000000-0000-0000-0000-000000000000","name":"String","objectType":"ResourceGroup","selfLink":"/resourcegroups/00000000-0000-0000-0000-000000000000","environment":"Lab","state":"New","parentId":"00000000-0000-0000-0000-000000000000","parent":{"shortId":"String","tenantId":"00000000-0000-0000-0000-000000000000","name":"String","nameUserDefinedPart":"String","objectType":"Deployment","selfLink":"/deployments/00000000-0000-0000-0000-000000000000","state":"New","environment":"Lab","templateId":"00000000-0000-0000-0000-000000000000","parameters":null,"variables":null,"variablesSnapshot":null,"parentId":"00000000-0000-0000-0000-000000000000","parent":{"tenantId":"00000000-0000-0000-0000-000000000000","name":"String","objectType":"Collection","selfLink":"/collections/00000000-0000-0000-0000-000000000000","variables":null,"isLostAndFound":false,"monthlyBudget":0,"sendBudgetNotificationMails":false,"budgetWarningThresholdPercent":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"},"validFrom":"0001-01-01T00:00:00.0000000Z","validUntil":"0001-01-01T00:00:00.0000000Z","isNeverExpiring":false,"nextPatchDate":"0001-01-01T00:00:00.0000000Z","defaultResourceProviderId":"00000000-0000-0000-0000-000000000000","needsAttention":false,"composition":"Native","monthlyBudget":0,"sendBudgetNotificationMails":false,"budgetWarningThresholdPercent":0,"operationalState":"None","resourcesRunning":0,"resourcesTotal":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"},"templateId":"00000000-0000-0000-0000-000000000000","parameters":null,"variables":null,"nextPatchDate":"0001-01-01T00:00:00.0000000Z","composition":"Native","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"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}