Skip to content

ortelius/ms-sbom-export

ortelius-ms-sbom-export

Release license

Build MegaLinter CodeQL OpenSSF -Scorecard

Discord

Version 10.0.0

RestAPI endpoint for retrieving SBOM data to a component

Path Table

Method Path Description
GET /health Health
GET /msapi/sbom Export Sbom

Reference Table

Name Path Description
HTTPValidationError #/components/schemas/HTTPValidationError
StatusMsg #/components/schemas/StatusMsg
ValidationError #/components/schemas/ValidationError

Path Details


[GET]/health

  • Summary
    Health

  • Description
    This health check end point used by Kubernetes

Responses

  • 200 Successful Response

application/json

{
  status?: string
  service_name?: string
}

[GET]/msapi/sbom

  • Summary
    Export Sbom

  • Description
    This is the end point used to create PDF of the Application/Component SBOM

Parameters(Query)

compid?: Partial(string) & Partial(null)
appid?: Partial(string) & Partial(null)
envid?: Partial(string) & Partial(null)

Responses

  • 200 Successful Response

application/json

{}
  • 422 Validation Error

application/json

{
  detail: {
    loc?: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

References

#/components/schemas/HTTPValidationError

{
  detail: {
    loc?: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

#/components/schemas/StatusMsg

{
  status?: string
  service_name?: string
}

#/components/schemas/ValidationError

{
  loc?: Partial(string) & Partial(integer)[]
  msg: string
  type: string
}