index.mdx

---
sidebar_position: 1
---
import { Cards } from 'nextra/components'
import {
  LinkIcon,
  CubeIcon,
  EyeSlashIcon
} from '@heroicons/react/24/outline'

# API Documentation

The ZenDiS Badge API repository scanner provides a JSON API to interact with. The following endpoints are available:

<Cards>
  <Cards.Card
    icon={<EyeSlashIcon />}
    title="SARIF Report per Repository"
    href="api-docs/v1/sarif-per-repo-endpoint"
  />
  <Cards.Card
    icon={<LinkIcon />}
    title="Badge of a Repository as SVG"
    href="api-docs/v1/badges#get-svg-badge"
  />
  <Cards.Card
    icon={<CubeIcon />}
    title="Explanation of a Badge of a Repository"
    href="api-docs/v1/badges#get-badge-explanation"
  />
</Cards>