CoreService

<back to all web services

QueryActions

Action - CRUD

Returns a list of actions

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/actions/Returns a list of actions
GET/actions/Returns a list of actions
QueryActions Parameters:
NameParameterData TypeRequiredDescription
TenantNameheaderstringYes
IncludeDeletedquerybool?NoIf true, also soft deleted items will be returned
GroupByquerystringNoThe property, the data will be grouped on
AggregateOnquerystringNoThe property, used for aggregation
AggregationqueryAggregations?NoThe aggregation function to use
IncludeDefinitionquerybool?NoIf true, also include the json definition
IncludeReferencedObjectsquerybool?NoReturns all referenced object
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Action Parameters:
NameParameterData TypeRequiredDescription
TenantIdformGuidNo
SchemaVersionformintNo
DefinitionJsonformstringYes
DefinitionYamlformstringYes
ParametersformIList<Parameter>Yes
IsDisabledformboolNo
ObjectTypeformObjectTypesNo
ScopeformActionScopesNo
SelfLinkformstringYes
StepsformList<ActionStep>Yes
ConfigItem Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringYes
DisplayNameformstringYes
DescriptionformstringNo
ObjectTypeformObjectTypesNo
SelfLinkformstringYes
TagsformIList<Tag>Yes
PathformIList<PathItem>Yes
Auditable Parameters:
NameParameterData TypeRequiredDescription
CreatedformDateTimeYes
CreateUserformstringYes
CreateUserIdformstringYes
ModifiedformDateTimeYes
ModifyUserformstringYes
ModifyUserIdformstringYes
IsDeletedformboolYes
DeletedformDateTime?No
DeleteUserformstringNo
DeleteUserIdformstringNo
ObjectTypes Enum:
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
Tag Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
ValueformstringNo
IsProtectedformboolNo
PathItem Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
LinkformstringYes
ObjectTypeformObjectTypesNo
ObjectIdformGuidNo
Parameter Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringNo
ValueformstringNo
DefaultformstringNo
OptionalformboolNo
TypeformParameterValueTypeNo
ValidationformstringNo
ParameterValueType Enum:
String
Number
Boolean
SecureString
ActionScopes Enum:
Deployment
ResourceGroup
Resource
ActionStep Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DisplayNameformstringNo
VariablesformDictionary<string, Object>Yes
CredentialformstringNo
LimitformstringNo
TypeformstringNo
ModuleformstringNo
ExecutionEnvironmentformstringNo
InventoryformstringNo
Aggregations Enum:
None
Count
DistinctCount
Sum
Min
Max
Avg
First
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<TimeSeriesDefinition>Yes
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
TimeSeriesDefinition Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
TenantIdformGuidNo
TenantformTenantNo
NameformstringYes
DisplayNameformstringNo
SelfLinkformstringYes
ObjectTypeformObjectTypesYes
DescriptionformstringNo
SourceTypeformObjectTypesNo
AutoCollectionformboolNo
AutoCollectionQueryformstringNo
AutoCollectionIntervalformint?No
AutoCollectionIntervalUnitformIntervalUnits?No
AutoCollectionTimeformTimeOnly?No
LastAutoCollectedformDateTime?No
RetentionTimeMonthsformintNo
Tenant Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
ObjectTypeformObjectTypesYes
SelfLinkformstringYes
VariablesformIList<Variable>Yes
AllowedMailDomainsformIList<string>Yes
LicensedModulesformIList<string>Yes
DefaultDeploymentLifetimeDaysformshortYes
MaxDeploymentLifetimeDaysformshortYes
SystemUnpatchedWarningDaysformshortYes
SystemBackupMissingWarningHoursformshortYes
StopVulnerableResourceAfterDaysformshortYes
DeploymentExpirationWarningDaysformshortYes
PatchNotificationDaysformshortYes
UseCustomHostnamesformboolYes
RemoveInactiveVulnerabilitiesAfterDaysformshortYes
Variable Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
ValueformstringYes
TypeformValueDataTypeNo
DescriptionformstringNo
IsInheritedformboolNo
EnvironmentformEnvironments?No
ValueDataType Enum:
String
Number
Boolean
List
Environments Enum:
Lab
Poc
Dev
Test
Int
Uat
Prod
IntervalUnits Enum:
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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/actions/ 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":[{"tenantId":"00000000-0000-0000-0000-000000000000","schemaVersion":0,"definitionJson":"String","definitionYaml":"String","parameters":null,"isDisabled":false,"objectType":"Action","scope":"Deployment","selfLink":"/actions/00000000-0000-0000-0000-000000000000","steps":[{"name":"String","displayName":"String","variables":{"String":{}},"credential":"String","limit":"String","type":"String","module":"String","executionEnvironment":"String","inventory":"String"}],"id":"00000000-0000-0000-0000-000000000000","name":"String","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"}}}