Check EOL

curl --location --request POST 'https://edb-prod.xeol.io/eol/check' \
--data-raw '{
  "component": {
      "name": "Go",
      "ecosystem": "generic",
      "version": "1.15"
  }
}'

{
  "error": null,
  "result": {
    "componentName": "Go",
    "ecosystem": "generic",
    "version": {
      "id": "cv_92UqG6FZu2uoxebKZs5bcEN8CFoqPGC6bx62kn4fzEwr",
      "version": "1.15",
      "componentId": "c_3qrajMUJoCZLzbYxCA6wxfo1W1nDPTLvr5PMJKuYiFks",
      "releasedAt": "2020-08-11T00:00:00.000Z",
      "createdAt": "2024-03-15T17:00:19.685Z",
      "updatedAt": "2024-03-15T17:00:19.685Z"
    },
    "eol": {
      "now": {
        "primary": {
          "reason": "vendor_announced",
          "date": "2021-08-16T00:00:00.000Z",
          "supportLevel": "STANDARD_SUPPORT",
          "isDefault": true
        },
        "other": []
      },
      "future": null
    },
    "lifecycles": [{
      "id": "life_Hukr1PH1ir9XMmDomzZ4j1hAurbWnJfTr4Hs6i4XZtkJ",
      "eolAt": "2021-08-16T00:00:00.000Z",
      "componentId": "c_3qrajMUJoCZLzbYxCA6wxfo1W1nDPTLvr5PMJKuYiFks",
      "range": "~1.15",
      "supportLevel": "STANDARD_SUPPORT",
      "isDefault": true,
      "uri": null,
      "eolField": "eolAt",
      "isEol": null,
      "componentVersionId": "cv_92UqG6FZu2uoxebKZs5bcEN8CFoqPGC6bx62kn4fzEwr",
      "lifecycleId": "life_Hukr1PH1ir9XMmDomzZ4j1hAurbWnJfTr4Hs6i4XZtkJ"
    }],
    "registry": null
  }
}

{
  "result": null,
  "error": {
    "message": "Json body validation failed: component.ecosystem: invalid enum value. expected 'generic' | 'npm' | 'nuget' | 'pypi' | 'maven' | 'golang', received ''"
  }
}

{
  "result": null,
  "error": {
    "message": "Unauthorized"
  }
}

POST

eol

check

curl --location --request POST 'https://edb-prod.xeol.io/eol/check' \
--data-raw '{
  "component": {
      "name": "Go",
      "ecosystem": "generic",
      "version": "1.15"
  }
}'

{
  "error": null,
  "result": {
    "componentName": "Go",
    "ecosystem": "generic",
    "version": {
      "id": "cv_92UqG6FZu2uoxebKZs5bcEN8CFoqPGC6bx62kn4fzEwr",
      "version": "1.15",
      "componentId": "c_3qrajMUJoCZLzbYxCA6wxfo1W1nDPTLvr5PMJKuYiFks",
      "releasedAt": "2020-08-11T00:00:00.000Z",
      "createdAt": "2024-03-15T17:00:19.685Z",
      "updatedAt": "2024-03-15T17:00:19.685Z"
    },
    "eol": {
      "now": {
        "primary": {
          "reason": "vendor_announced",
          "date": "2021-08-16T00:00:00.000Z",
          "supportLevel": "STANDARD_SUPPORT",
          "isDefault": true
        },
        "other": []
      },
      "future": null
    },
    "lifecycles": [{
      "id": "life_Hukr1PH1ir9XMmDomzZ4j1hAurbWnJfTr4Hs6i4XZtkJ",
      "eolAt": "2021-08-16T00:00:00.000Z",
      "componentId": "c_3qrajMUJoCZLzbYxCA6wxfo1W1nDPTLvr5PMJKuYiFks",
      "range": "~1.15",
      "supportLevel": "STANDARD_SUPPORT",
      "isDefault": true,
      "uri": null,
      "eolField": "eolAt",
      "isEol": null,
      "componentVersionId": "cv_92UqG6FZu2uoxebKZs5bcEN8CFoqPGC6bx62kn4fzEwr",
      "lifecycleId": "life_Hukr1PH1ir9XMmDomzZ4j1hAurbWnJfTr4Hs6i4XZtkJ"
    }],
    "registry": null
  }
}

{
  "result": null,
  "error": {
    "message": "Json body validation failed: component.ecosystem: invalid enum value. expected 'generic' | 'npm' | 'nuget' | 'pypi' | 'maven' | 'golang', received ''"
  }
}

{
  "result": null,
  "error": {
    "message": "Unauthorized"
  }
}

Body

object

required

An identifier to determine an entity’s EOL status. Only one of the following can be provided: cpe, purl, custom.

Show properties

string

required

The name of the software.

string

required

The software version.

string

required

The ecosystem that this software belongs to. Defaults to generic.

string

The field takes a support ID to match against. If not provided, it will default to STANDARD_SUPPORT which is the base level of support for any entity.STANDARD_SUPPORT is defined as the base support level in which security updates are provided for the entity.

Response

boolean

Whether the matched entity is end-of-life.

string

The reason the entity was marked as deprecated. Can be one of VENDOR_ANNOUNCED, REGISTRY_DEPRECATED, or SOURCE_ARCHIVED.

string

The end-of-life date for the matched entity.

object

Information about the match.

Show match

bool

Whether a match was found.

string

Information about why the match was not found.

boolean

Whether the entity support was found.

object

The request that triggered this response.

Show request

object

Entity identifier object for the request.

Show identifier

string

Common Platform Enumeration identifier

object

Evidence supporting the eol status.

Show evidence

string

Schema version

string

Unique identifier

datetime

Last modified date

datetime

Published date

object

Matched entity info.

Show entity

boolean

Whether the matched entity has Long Term Support

string

Name of the matched entity

datetime

Release date of the matched entity

string

Type of the matched entity. Will be one of: service, device, software, package, os.

string

Vendor of the matched entity

string

Version of the matched entity

object[]

The available support levels for the matched entity.

Show support

datetime

End-of-life date

string

Support ID

integer

Support level

object[]

References are used to provide additional information about the matched entity.

Show references

string

Type of reference. Will be one of: CHANGELOG, ARTICLE, WEB, SOURCE, PACKAGE

string

URL of the reference

object

Identification methods used.

Show identification

string[]

List of Common Platform Enumeration identifiers

object

Custom identification

Show custom

string

Custom name

string

Custom vendor

string[]

List of Package URL identifiers

string[]

List of versions

curl --location --request POST 'https://edb-prod.xeol.io/eol/check' \
--data-raw '{
  "component": {
      "name": "Go",
      "ecosystem": "generic",
      "version": "1.15"
  }
}'

{
  "error": null,
  "result": {
    "componentName": "Go",
    "ecosystem": "generic",
    "version": {
      "id": "cv_92UqG6FZu2uoxebKZs5bcEN8CFoqPGC6bx62kn4fzEwr",
      "version": "1.15",
      "componentId": "c_3qrajMUJoCZLzbYxCA6wxfo1W1nDPTLvr5PMJKuYiFks",
      "releasedAt": "2020-08-11T00:00:00.000Z",
      "createdAt": "2024-03-15T17:00:19.685Z",
      "updatedAt": "2024-03-15T17:00:19.685Z"
    },
    "eol": {
      "now": {
        "primary": {
          "reason": "vendor_announced",
          "date": "2021-08-16T00:00:00.000Z",
          "supportLevel": "STANDARD_SUPPORT",
          "isDefault": true
        },
        "other": []
      },
      "future": null
    },
    "lifecycles": [{
      "id": "life_Hukr1PH1ir9XMmDomzZ4j1hAurbWnJfTr4Hs6i4XZtkJ",
      "eolAt": "2021-08-16T00:00:00.000Z",
      "componentId": "c_3qrajMUJoCZLzbYxCA6wxfo1W1nDPTLvr5PMJKuYiFks",
      "range": "~1.15",
      "supportLevel": "STANDARD_SUPPORT",
      "isDefault": true,
      "uri": null,
      "eolField": "eolAt",
      "isEol": null,
      "componentVersionId": "cv_92UqG6FZu2uoxebKZs5bcEN8CFoqPGC6bx62kn4fzEwr",
      "lifecycleId": "life_Hukr1PH1ir9XMmDomzZ4j1hAurbWnJfTr4Hs6i4XZtkJ"
    }],
    "registry": null
  }
}

{
  "result": null,
  "error": {
    "message": "Json body validation failed: component.ecosystem: invalid enum value. expected 'generic' | 'npm' | 'nuget' | 'pypi' | 'maven' | 'golang', received ''"
  }
}

{
  "result": null,
  "error": {
    "message": "Unauthorized"
  }
}

API

Architecture

Body

Response