Update-available.com - Documentation

Resources

Publisher

As the name suggests, the publisher section is where you can access comprehensive information about the publisher, including relevant details and urls.

The publisher model

The publisher model encapsulates a wealth of information about the publisher, encompassing their name and support URL. Moreover, this model offers you the capability to explore additional software offerings from the same publisher, enhancing your understanding of their diverse range of products.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the publisher.

  • Name
    name
    Type
    string
    Description

    Name of the software from the publisher.

  • Name
    url
    Type
    string
    Description

    Name of the publisher of the software.

  • Name
    support_url
    Type
    string
    Description

    Your notes from the publisher.

  • Name
    privacy_url
    Type
    string
    Description

    Your selected version from the publisher.

  • Name
    created_at
    Type
    datetime
    Description

    Date and Time when the publisher was added.

  • Name
    updated_at
    Type
    datetime
    Description

    Date and Time when the publisher was updated.

GET/api/v1/publisher

List publisher

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

Custom filters

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

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

Read more about filter

Request

curl -G https://update-available.com/api/publisher \
  -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/publisher/ad23e006-8fd2-4669-ad80-116f14ae3324"
      }
    },
    {
      "id": "8b05fa4e-090d-487a-8591-47f451970cb8",
      ...
      }
    }
  ]
}
GET/api/v1/publisher/:id

Get publisher

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

Request

curl -G https://update-available.com/api/publisher/{id} \
  -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/publisher/:id/software

Get software from publisher

This endpoint allows you to retrieve a list of all software from a publisher by providing the publisher id.

Custom filters

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

Read more about filter

Request

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

Response

{
  "data": [
    {
      "id": "5b6468ca-8251-420d-bad2-ba1e020ccbc8",
      "title": "Zoom Outlook Plugin",
      "ShortDescription": "The Zoom Plugin for Outlook installs a button on the Microsoft Outlook tool bar to enable you to start or schedule a meeting with one-click.",
      "url": "https://zoom.us/",
      "last_update": "2023-08-11T19:29:06.000000Z",
      "is_favorite": false,
      "links": {
        "self": "http://update-available.com/api/v1/software/5b6468ca-8251-420d-bad2-ba1e020ccbc8",
        "versions": "http://update-available.com/api/v1/software/5b6468ca-8251-420d-bad2-ba1e020ccbc8/versions",
        "publisher": "http://update-available.com/api/v1/publisher/138f7342-ed86-4113-8bf1-a5fcd74cb19c"
      }
    },
    {
      "id": "723b7b27-4dca-4e03-8575-1d476df71145",
      "title": "Zoom",
      "description": "Zoom's secure, reliable video platform powers all of your communication needs, including meetings, chat, phone, webinars, and online events.",
      "ShortDescription": "Team Chat, Phone, Video & More",
      "url": "https://zoom.us",
      "last_update": "2023-08-11T19:29:06.000000Z",
      "is_favorite": true,
      "links": {
        "self": "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",
        "favorite": "http://update-available.com/api/v1/favorite/9c3c5b33-fd61-4a2d-8a31-0cbd043d34d5"
      }
    }
  ]
}