Update-available.com - Documentation

Resources

Favorite

By utilizing the Favorites feature, you have the ability to mark and track specific software products. This allows you to not only keep an eye on updates but also receive notifications when changes occur, ensuring you're always up to date. When an update occurs, notifications are sent through the designated channels you've set up, such as emails, OPSgenie, and more.

The favorite model

The favorite model contains all the information about your favorite, such as their name, publisher, and your notes. Additionally, through this model, you can establish references to the software, version, or publisher, enabling you to retrieve further details and pertinent information.

Properties

  • Name
    uuid
    Type
    string
    Description

    Unique identifier for the favorite.

  • Name
    software
    Type
    string
    Description

    Name of the software from the favorite.

  • Name
    publisher
    Type
    string
    Description

    Name of the publisher of the software.

  • Name
    notes
    Type
    string
    Description

    Your notes from the favorite.

  • Name
    version
    Type
    string
    Description

    Your selected version from the favorite.

  • Name
    update_available
    Type
    boolean
    Description

    TRUE if update for software is available.

  • Name
    notified_version
    Type
    string
    Description

    The last notified version.

  • Name
    notifications_enabled
    Type
    boolean
    Description

    TRUE if a notification is send if an update is found.

  • Name
    use_default_notification
    Type
    boolean
    Description

    TRUE if the default notifications were used.

  • Name
    notify_always
    Type
    boolean
    Description

    TRUE if you always get a notification

  • Name
    created_at
    Type
    datetime
    Description

    Date and Time when the favorite was added.

  • Name
    updated_at
    Type
    datetime
    Description

    Date and Time when the favorite was updated.

  • Name
    links
    Type
    array
    Description

    Links to the software, versions from the software and the publisher.

GET/api/v1/favorite

List favorites

This endpoint allows you to retrieve a paginated list of all your favorites. By default, a maximum of 50 favorites are shown per page.

Custom filters

  • Name
    software
    Type
    [eq], [ne], [like]
    Description

  • Name
    update_available
    Type
    [eq]
    Description

  • Name
    last_update
    Type
    [gt], [gte], [lt], [lte]
    Description

Read more about filter

Request

curl -G https://update-available.com/api/favorite \
  -H "Authorization: Bearer {token}"

Response

{
  "data": [
    {
      "uuid": "c2181660-a002-4ba7-961a-82ba093fd536",
      "software": "VLC media player",
      "publisher": "VideoLAN",
      "version": {
        "version": "3.0.18",
        "created_at": "2023-01-22T10:43:24.000000Z"
      },
      "update_available": false,
      "notified_version": {
        "version": "3.0.18",
        "created_at": "2023-01-22T10:43:24.000000Z"
      },
      "notifications_enabled": false,
      "use_default_notification": false,
      "notify_always": false,
      "created_at": "2023-01-23T18:17:53.000000Z",
      "updated_at": "2023-08-12T14:46:44.000000Z",
      "links": {
        "self": "http://update-available.com/api/v1/favorite/c2181660-a002-4ba7-961a-82ba093fd536",
        "software": "http://update-available.com/api/v1/software/3601a88f-ac8d-472b-b54d-ec40e0a3ff97",
        "versions": "http://update-available.com/api/v1/software/3601a88f-ac8d-472b-b54d-ec40e0a3ff97/versions",
        "publisher": "http://update-available.com/api/v1/publisher/4b348c26-3948-4bd4-9147-5f2caef471ff"
      }
    }
  ]
}
POST/api/v1/favorite/

Create favorite

This endpoint allows you to add a new favorite for the software. A software and version id is required to create a favorite.

Required parameters

  • Name
    software
    Type
    uuid
    Description

    Unique identifier for the software.

  • Name
    version
    Type
    uuid
    Description

    Unique identifier for the version.

Optional parameters

  • Name
    notes
    Type
    string
    Description

    Your notes from the favorite.

  • Name
    use_default_notification
    Type
    boolean
    Description

    Use the default notifications in your profile.

  • Name
    notify_always
    Type
    boolean
    Description

    Get always a notification.

Request

curl -G https://update-available.com/api/favorite \
  -H "Authorization: Bearer {token}"
  --data '{
    "software": "6340c311-af77-4e6b-aaf0-d86cc71e4b64",
    "version": "1c5ebf95-3dc7-4b01-81fb-171818690b3e"
  }'

Response

{
  "data": {
    "uuid": "9c3c5b33-fd61-4a2d-8a31-0cbd043d34d5",
    "software": "Compass",
    "publisher": "Zype, Inc.",
    "notes": "",
    "version": {
      "id": "1c5ebf95-3dc7-4b01-81fb-171818690b3e",
      "version": "1.1.0",
      "created_at": "2023-01-22T10:39:42.000000Z"
    },
    "update_available": false,
    "notified_version": {
      "id": "de228b44-ffc5-4870-ba57-a8cf394238ba",
      "version": "5.15.7.20303",
      "created_at": "2023-08-14T15:45:08.000000Z"
    },
    "notifications_enabled": true,
    "use_default_notification": true,
    "notify_always": false,
    "created_at": "2023-01-26T09:17:33.000000Z",
    "updated_at": "2023-08-14T15:45:09.000000Z"
  }
}
GET/api/v1/favorite/:id

Get favorite

This endpoint allows you to retrieve a favorite by providing the favorite id.

Request

curl -G https://update-available.com/api/favorite/{id} \
  -H "Authorization: Bearer {token}"

Response

{
  "data": {
    "uuid": "c2181660-a002-4ba7-961a-82ba093fd536",
    "software": "VLC media player",
    "publisher": "VideoLAN",
    "version": {
      "version": "3.0.18",
      "created_at": "2023-01-22T10:43:24.000000Z"
    },
    "update_available": false,
    "notified_version": {
      "version": "3.0.18",
      "created_at": "2023-01-22T10:43:24.000000Z"
    },
    "notifications_enabled": false,
    "use_default_notification": false,
    "notify_always": false,
    "created_at": "2023-01-23T18:17:53.000000Z",
    "updated_at": "2023-08-12T14:46:44.000000Z",
    "links": {
      "self": "http://update-available.com/api/v1/favorite/c2181660-a002-4ba7-961a-82ba093fd536",
      "software": "http://update-available.com/api/v1/software/3601a88f-ac8d-472b-b54d-ec40e0a3ff97",
      "versions": "http://update-available.com/api/v1/software/3601a88f-ac8d-472b-b54d-ec40e0a3ff97/versions",
      "publisher": "http://update-available.com/api/v1/publisher/4b348c26-3948-4bd4-9147-5f2caef471ff"
    }
  }
}
PUT/api/v1/favorite/:id

Update favorite

This endpoint allows you to perform an update on a favorite. Examples of updates are changing the version or updating the notification settings.

Parameters

  • Name
    software
    Type
    uuid
    Description

    Unique identifier for the software.

  • Name
    version
    Type
    uuid
    Description

    Unique identifier for the version.

  • Name
    notes
    Type
    string
    Description

    Your notes from the favorite.

  • Name
    use_default_notification
    Type
    boolean
    Description

    Use the default notifications in your profile.

  • Name
    notify_always
    Type
    boolean
    Description

    Get always a notification.

Request

curl -G https://update-available.com/api/favorite/{id} \
  -H "Authorization: Bearer {token}"
  --data '{
    "software": "6340c311-af77-4e6b-aaf0-d86cc71e4b64",
    "version": "1c5ebf95-3dc7-4b01-81fb-171818690b3e"
  }'

Response

{
  "data": {
    "uuid": "9c3c5b33-fd61-4a2d-8a31-0cbd043d34d5",
    "software": "Compass",
    "publisher": "Zype, Inc.",
    "notes": "",
    "version": {
      "id": "1c5ebf95-3dc7-4b01-81fb-171818690b3e",
      "version": "1.1.0",
      "created_at": "2023-01-22T10:39:42.000000Z"
    },
    "update_available": false,
    "notified_version": {
      "id": "de228b44-ffc5-4870-ba57-a8cf394238ba",
      "version": "5.15.7.20303",
      "created_at": "2023-08-14T15:45:08.000000Z"
    },
    "notifications_enabled": true,
    "use_default_notification": true,
    "notify_always": false,
    "created_at": "2023-01-26T09:17:33.000000Z",
    "updated_at": "2023-08-14T15:45:09.000000Z"
  }
}
DELETE/api/v1/favorite/:id

Delete favorite

This endpoint allows you to delete a favorite. Note: This will permanently delete the favorite and all its notes.

Request

curl -X DELETE https://update-available.com/api/favorite/{id} \
  -H "Authorization: Bearer {token}"
GET/api/v1/favorite/:id/update-to-latest-version

Update favorite to the latest software version

This endpoint allows you to update directly the version id from the software to the latest.

Request

curl -G https://update-available.com/api/favorite/{id}/update-to-latest-version \
  -H "Authorization: Bearer {token}"

Response

{
  "data": {
    "uuid": "c2181660-a002-4ba7-961a-82ba093fd536",
    "software": "VLC media player",
    "publisher": "VideoLAN",
    "version": {
      "version": "3.0.18",
      "created_at": "2023-01-22T10:43:24.000000Z"
    },
    "update_available": false,
    "notified_version": {
      "version": "3.0.18",
      "created_at": "2023-01-22T10:43:24.000000Z"
    },
    "notifications_enabled": false,
    "use_default_notification": false,
    "notify_always": false,
    "created_at": "2023-01-23T18:17:53.000000Z",
    "updated_at": "2023-08-12T14:46:44.000000Z",
    "links": {
      "self": "http://update-available.com/api/v1/favorite/c2181660-a002-4ba7-961a-82ba093fd536",
      "software": "http://update-available.com/api/v1/software/3601a88f-ac8d-472b-b54d-ec40e0a3ff97",
      "versions": "http://update-available.com/api/v1/software/3601a88f-ac8d-472b-b54d-ec40e0a3ff97/versions",
      "publisher": "http://update-available.com/api/v1/publisher/4b348c26-3948-4bd4-9147-5f2caef471ff"
    }
  }
}