Resources

Software

As the name implies, software lies at the heart of our platform — it's the fundamental reason our platform exists, facilitating seamless management of diverse software products. On this page, we'll delve into the various software endpoints you can leverage to programmatically oversee software applications. We'll explore techniques for querying software entries, empowering you with comprehensive control over your software ecosystem.

The software model

The software model encompasses comprehensive information about various aspects, including the name, description, and publisher of the software. Furthermore, you have the capability to retrieve additional details, such as different versions of the software. This model allows you to gain a comprehensive understanding of the pertinent software details while also exploring different versions available.

Properties

Name

id

Type

string

Description

Unique identifier for the software.
Name

name

Type

string

Description

Name of the software.
Name

description

Type

string

Description

The description of that software
Name

short_description

Type

string

Description

A shorter description from the software.
Name

url

Type

string

Description

The url from the software.
Name

publisher

Type

array

Description

The publisher resource.
Name

latest_version

Type

array

Description

The latest version from the software.
Name

versions

Type

string

Description

All versions from the software in the database.
Name

last_update

Type

datetime

Description

Date and Time when the software was updated.
Name

is_favorite

Type

boolean

Description

Is this software marked as favorite.

GET/api/v1/software

List software

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

Custom filters

Name

name

Type

[eq], [ne], [like]

Description
Name

last_update

Type

[gt], [gte], [lt], [lte]

Description

Includes

Name

includeLatestVersion

Type

Description

Includes the latest version from that software.
Name

includePublisher

Type

Description

Includes the publisher information.

Request

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

Response

{
  "data": [
    {
      "id": "ad23e006-8fd2-4669-ad80-116f14ae3324",
      "name": "Microsoft Corporation",
      "url": "https://www.microsoft.com/en-US/",
      "support_url": "https://support.microsoft.com/en-us/microsoft-edge",
      "privacy_url": "https://privacy.microsoft.com/en-US/privacystatement",
      "created_at": "2023-01-22T10:35:40.000000Z",
      "updated_at": "2023-08-12T13:17:05.000000Z",
      "links": {
        "self": "http://update-available.com/api/v1/software/ad23e006-8fd2-4669-ad80-116f14ae3324"
      }
    },
    {
      "id": "8b05fa4e-090d-487a-8591-47f451970cb8",
      ...
      }
    }
  ]
}

GET/api/v1/software/:id

Get software

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

Includes

Name

includeLatestVersion

Type

Description

Includes the latest version from that software.
Name

includePublisher

Type

Description

Includes the publisher information.

Request

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

Response

{
  "data": {
    "id": "6340c311-af77-4e6b-aaf0-d86cc71e4b64",
    "name": "Compass",
    "short_description": "A standalone Windows CLI for Zype Programming Language.",
    "last_update": "2023-08-11T19:29:06.000000Z",
    "is_favorite": false,
    "links": {
      "self": "http://update-available.com/api/v1/software/6340c311-af77-4e6b-aaf0-d86cc71e4b64",
      "versions": "http://update-available.com/api/v1/software/6340c311-af77-4e6b-aaf0-d86cc71e4b64/versions",
      "publisher": "http://update-available.com/api/v1/publisher/9f43c9d9-378f-4ec3-8df7-2a7745850d65"
    }
  }
}

GET/api/v1/software/:id/publisher

Get publisher from software

This endpoint allows you to get the information from the publisher by providing the software id.

Request

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

Response

{
  "data": {
    "id": "138f7342-ed86-4113-8bf1-a5fcd74cb19c",
    "name": "Zoom",
    "url": "https://zoom.us/",
    "support_url": "https://support.zoom.us/",
    "privacy_url": "https://explore.zoom.us/en/privacy/",
    "created_at": "2023-01-22T10:35:40.000000Z",
    "updated_at": "2023-08-12T13:17:04.000000Z",
    "links": {
      "self": "http://update-available.com/api/v1/publisher/138f7342-ed86-4113-8bf1-a5fcd74cb19c"
    }
  }
}

GET/api/v1/software/:id/versions

Get versions from software

This endpoint allows you to retrieve a list of versions by providing the software id.

Custom filters

Name

version

Type

[gt], [gte] ,[lt] ,[lte], [like]

Description
Name

created_at

Type

[gt], [gte], [lt], [lte]

Description

Request

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

Response

{
  "data": [
    {
      "version": "5.15.6.19959",
      "created_at": "2023-08-10T23:30:10.000000Z"
    },
    {
      "version": "5.15.5.19404",
      "created_at": "2023-07-26T19:00:13.000000Z"
    },
    {
      "version": "5.15.3.18551",
      "created_at": "2023-07-14T16:30:11.000000Z"
    },
    {
      "version": "5.15.2.18096",
      "created_at": "2023-07-02T15:15:08.000000Z"
    },...
  ]
}

GET/api/v1/software/:id/favorite

Get favorite from software

This endpoint allows you to get the favorite information by providing the software id.

Request

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

Response

{
  "data": {
    "uuid": "9c3c5b33-fd61-4a2d-8a31-0cbd043d34d5",
    "software": "Zoom",
    "publisher": "Zoom",
    "notes": "",
    "version": {
      "version": "5.15.6.19959",
      "created_at": "2023-08-10T23:30:10.000000Z"
    },
    "update_available": false,
    "notified_version": {
      "version": "5.15.6.19959",
      "created_at": "2023-08-10T23:30:10.000000Z"
    },
    "notifications_enabled": true,
    "use_default_notification": true,
    "notify_always": false,
    "created_at": "2023-01-26T09:17:33.000000Z",
    "updated_at": "2023-08-12T14:18:51.000000Z",
    "links": {
      "self": "http://update-available.com/api/v1/favorite/9c3c5b33-fd61-4a2d-8a31-0cbd043d34d5",
      "software": "http://update-available.com/api/v1/software/723b7b27-4dca-4e03-8575-1d476df71145",
      "versions": "http://update-available.com/api/v1/software/723b7b27-4dca-4e03-8575-1d476df71145/versions",
      "publisher": "http://update-available.com/api/v1/publisher/138f7342-ed86-4113-8bf1-a5fcd74cb19c"
    }
  }
}