CoreService

<back to all web services

GetUpdate

Patching - CRUD

Returns a single update by its id

Requires Authentication
Requires the role:TenantReader
The following routes are available for this service:
GET/api/patching/updates/{Id}Returns a single update by its id
GET/patching/updates/{Id}Returns a single update by its id
import Foundation
import ServiceStack

/**
* Returns a single update by its id
*/
// @Api(Description="Returns a single update by its id")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(UpdateDto), StatusCode=200)
public class GetUpdate : IBaseRequest, IHasId, IHasTenantName, IGet, Codable
{
    /**
    * The primary key of every config item
    */
    // @ApiMember(DataType="string", Description="The primary key of every config item", Format="guid", IsRequired=true, ParameterType="path")
    public var id:String

    // @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    // @Validate(Validator="NotEmpty")
    public var tenantName:String

    required public init(){}
}

public class UpdateDto : Codable
{
    public var id:String
    public var name:String
    /**
    * The severity of the vulnerability this update fixes (e.g. Critical, Important, Moderate, etc.)
    */
    public var severity:String
    /**
    * The time the update was first published
    */
    public var published:Date
    /**
    * Update classification/type (e.g. Critical Update, Definition Update, Security Update, etc.)
    */
    public var classifications:[String]
    /**
    * Whether the update needs a reboot or not
    */
    public var isRebootRequired:Bool
    /**
    * In case of windows this is the KB id
    */
    public var extId:String
    /**
    * In case of linux this is the update package version
    */
    public var version:String

    required public init(){}
}


Swift GetUpdate 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/{Id} HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":"00000000-0000-0000-0000-000000000000","name":"String","severity":"String","published":"0001-01-01T00:00:00.0000000Z","classifications":["String"],"isRebootRequired":false,"extId":"String","version":"String"}