CoreService

<back to all web services

QueryUpdates

Patching - CRUD

Returns a list of updates

Requires Authentication
Requires the role:TenantReader
The following routes are available for this service:
GET/api/patching/updatesReturns a list of updates
GET/patching/updatesReturns a list of updates
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    @staticmethod
    def response_type(): return QueryResponse[T]


class ObjectTypes(str, Enum):
    NONE = 'None'
    CONFIG_ITEM = 'ConfigItem'
    TENANT = 'Tenant'
    COLLECTION = 'Collection'
    RESOURCE = 'Resource'
    COMPUTE_NODE = 'ComputeNode'
    VIRTUAL_MACHINE = 'VirtualMachine'
    PHYSICAL_MACHINE = 'PhysicalMachine'
    DISK = 'Disk'
    SUBNET = 'Subnet'
    IP_ADDRESS = 'IPAddress'
    JOB = 'Job'
    JOB_EVENT = 'JobEvent'
    FREEZE_PERIOD = 'FreezePeriod'
    RESOURCE_GROUP = 'ResourceGroup'
    DEPLOYMENT = 'Deployment'
    RESOURCE_GROUP_TEMPLATE = 'ResourceGroupTemplate'
    DEPLOYMENT_TEMPLATE = 'DeploymentTemplate'
    RESOURCE_PROVIDER = 'ResourceProvider'
    GENERIC_RESOURCE = 'GenericResource'
    ROLE = 'Role'
    PERMISSION = 'Permission'
    USER = 'User'
    PATCHING_WINDOW = 'PatchingWindow'
    UPDATE = 'Update'
    REPORT_DEFINITION = 'ReportDefinition'
    TIME_SERIES = 'TimeSeries'
    DATA_POINT = 'DataPoint'
    ACTION = 'Action'
    ACTION_ASSIGNMENT = 'ActionAssignment'
    USER_NOTE = 'UserNote'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Update(IHasIdName, IHasObjectType, INotSoftDeletable):
    id: Optional[str] = None
    # @Required()
    # @StringLength(512)
    name: Optional[str] = None

    # @Required()
    object_type: Optional[ObjectTypes] = None

    # @StringLength(50)
    severity: Optional[str] = None

    # @Required()
    published: datetime.datetime = datetime.datetime(1, 1, 1)

    classifications: Optional[List[str]] = None
    # @Required()
    is_reboot_required: bool = False

    # @StringLength(350)
    ext_id: Optional[str] = None

    # @StringLength(200)
    version: Optional[str] = None

    # @Ignore()
    self_link: Optional[str] = None


class Aggregations(str, Enum):
    NONE = 'None'
    COUNT = 'Count'
    DISTINCT_COUNT = 'DistinctCount'
    SUM = 'Sum'
    MIN = 'Min'
    MAX = 'Max'
    AVG = 'Avg'
    FIRST = 'First'


# @Api(Description="Returns a list of updates")
# @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(0, Culture=neutral, PublicKeyToken=null]]), StatusCode=200)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryUpdates(QueryDb[Update], IHasTenantName, IGet, IGroupable):
    """
    Returns a list of updates
    """

    # @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    # @Validate(Validator="NotEmpty")
    tenant_name: Optional[str] = None

    # @ApiMember(Description="The property, the data will be grouped on", ParameterType="query")
    group_by: Optional[str] = None
    """
    The property, the data will be grouped on
    """


    # @ApiMember(Description="The property, used for aggregation", ParameterType="query")
    aggregate_on: Optional[str] = None
    """
    The property, used for aggregation
    """


    # @ApiMember(Description="The aggregation function to use", ParameterType="query")
    aggregation: Optional[Aggregations] = None
    """
    The aggregation function to use
    """


    # @ApiMember(Description="The version of the update", ParameterType="query")
    version: Optional[str] = None
    """
    The version of the update
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Auditable(IAuditable):
    # @Required()
    created: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Required()
    create_user: Optional[str] = None

    # @Required()
    create_user_id: Optional[str] = None

    # @Required()
    modified: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Required()
    modify_user: Optional[str] = None

    # @Required()
    modify_user_id: Optional[str] = None

    # @Required()
    is_deleted: bool = False

    deleted: Optional[datetime.datetime] = None
    delete_user: Optional[str] = None
    delete_user_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Tag:
    name: Optional[str] = None
    value: Optional[str] = None
    is_protected: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PathItem:
    label: Optional[str] = None
    link: Optional[str] = None
    object_type: Optional[ObjectTypes] = None
    object_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConfigItem(Auditable, IConfigItem):
    id: Optional[str] = None
    # @Required()
    name: Optional[str] = None

    # @Required()
    # @StringLength(250)
    display_name: Optional[str] = None

    # @StringLength(8000)
    description: Optional[str] = None

    object_type: Optional[ObjectTypes] = None
    # @Ignore()
    self_link: Optional[str] = None

    # @Required()
    tags: Optional[IList[Tag]] = None

    # @Required()
    path: Optional[IList[PathItem]] = None


class ValueDataType(str, Enum):
    STRING = 'String'
    NUMBER = 'Number'
    BOOLEAN = 'Boolean'
    LIST = 'List'


class Environments(str, Enum):
    LAB = 'Lab'
    POC = 'Poc'
    DEV = 'Dev'
    TEST = 'Test'
    INT_ = 'Int'
    UAT = 'Uat'
    PROD = 'Prod'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Variable:
    name: Optional[str] = None
    value: Optional[str] = None
    type: Optional[ValueDataType] = None
    description: Optional[str] = None
    is_inherited: bool = False
    environment: Optional[Environments] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Tenant(ConfigItem, IHasVariables):
    # @Required()
    # @StringLength(10)
    name: Optional[str] = None

    # @Required()
    object_type: Optional[ObjectTypes] = None

    # @Ignore()
    self_link: Optional[str] = None

    # @Required()
    variables: Optional[IList[Variable]] = None

    # @Required()
    allowed_mail_domains: Optional[IList[str]] = None

    # @Required()
    licensed_modules: Optional[IList[str]] = None

    # @Required()
    default_deployment_lifetime_days: int = 0

    # @Required()
    max_deployment_lifetime_days: int = 0

    # @Required()
    system_unpatched_warning_days: int = 0

    # @Required()
    system_backup_missing_warning_hours: int = 0

    # @Required()
    stop_vulnerable_resource_after_days: int = 0

    # @Required()
    deployment_expiration_warning_days: int = 0

    # @Required()
    patch_notification_days: int = 0

    # @Required()
    use_custom_hostnames: bool = False

    # @Required()
    remove_inactive_vulnerabilities_after_days: int = 0


class IntervalUnits(str, Enum):
    SECOND = 'Second'
    MINUTE = 'Minute'
    HOUR = 'Hour'
    DAY = 'Day'
    WEEK = 'Week'
    MONTH = 'Month'
    YEAR = 'Year'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TimeSeriesDefinition(Auditable, IHasIdName, IHasTenantId, IHasObjectType):
    id: Optional[str] = None
    # @References(typeof(Tenant))
    tenant_id: Optional[str] = None

    tenant: Optional[Tenant] = None
    name: Optional[str] = None
    display_name: Optional[str] = None
    # @Ignore()
    self_link: Optional[str] = None

    # @Required()
    object_type: Optional[ObjectTypes] = None

    description: Optional[str] = None
    source_type: Optional[ObjectTypes] = None
    auto_collection: bool = False
    auto_collection_query: Optional[str] = None
    auto_collection_interval: Optional[int] = None
    auto_collection_interval_unit: Optional[IntervalUnits] = None
    auto_collection_time: Optional[datetime.timedelta] = None
    last_auto_collected: Optional[datetime.datetime] = None
    retention_time_months: int = 0


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
    offset: int = 0
    total: int = 0
    results: List[TimeSeriesDefinition] = field(default_factory=list)
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python QueryUpdates DTOs

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/patching/updates 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","name":"String","objectType":"Update","severity":"String","published":"0001-01-01T00:00:00.0000000Z","classifications":["String"],"isRebootRequired":false,"extId":"String","version":"String","selfLink":"/patching/updates/00000000-0000-0000-0000-000000000000"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}