Skip to content
Sursa Developers

Objects

CatalogService

Entry of the external service catalog, full form (ServiceRef plus group, domain and descriptions).

Fields

  • categorystringrequired

    Category slug (GET /v1/catalog/categories).

  • description_enstring | nullrequired

    Short description in English. null if there is no description.

  • domainstring | nullrequired

    Website domain without www.. null if there is no website.

  • group_namestring | nullrequired

    Group (vendor) if the service belongs to a product family, for example Atlassian; otherwise null.

  • iconbooleanrequired

    Whether an icon ships with Sursa.

  • icon_urlstring | nullrequired

    Icon URL (/v1/catalog/services/{service_id}/icon?v=… or an external address configured by the installation). null if there is no icon.

  • idstring (uuid)required
  • namestringrequired
  • slugstringrequired
  • websitestring | nullrequired

    Website URL (https://…) or null.

Used by