Guide API Reference

Use the Swagger Guide API reference for searching component and vulnerability data.

Sonatype Guide API OAS 3.1

https://sonatype.github.io/sonatype-documentation/api/guide/latest/guide-api.json

REST API for searching component and security vulnerability data.

Servers

https://api.guide.sonatype.com - API Server

Authorize

Usage Credit usage and billing period APIs

• GET/usage
  Get usage information
• GET/usage/ossi-history
  Get historical OSSI usage
• GET/usage/cumulative
  Get cumulative credit usage for a billing period
• GET/usage/credit-periods
  Get credit periods

Vulnerabilities Vulnerability search and filtering API

• GET/vulnerabilities/{id}
  Get vulnerability by ID
• GET/vulnerabilities/{id}/components
  Get affected components for a vulnerability

Current User Tokens Personal Access Token management APIs

• GET/users/me/tokens
  List all Personal Access Tokens
• POST/users/me/tokens
  Create a new Personal Access Token
• GET/users/me/tokens/{tokenId}
  Get a Personal Access Token by ID
• DELETE/users/me/tokens/{tokenId}
  Revoke a Personal Access Token

Components Component search and filtering API

• POST/components/latest-version
  Get latest version of a component
• GET/components/vulnerabilities
  Get vulnerabilities for a component by coordinates (query parameters)
• GET/components/versions
  Get all component versions by coordinates (query parameters)
• GET/components/detail
  Get component detail by coordinates (query parameters)
• GET/components/dependencies
  Get dependencies for a component by coordinates (query parameters)

OSS Index Compatibility Legacy OSSI API providing backward compatibility. Allows existing OSSI users to continue using their OSSI API tokens without creating a new Sonatype Guide account. Authentication requires HTTP Basic Auth with OSSI username and API token.

• POST/api/v3/component-report
  Get component reports for multiple PURLs
• POST/api/v3/authorized/component-report
  Get component reports for multiple PURLs
• GET/api/v3/version
  Get API version
• GET/api/v3/authorized/component-report/*
  Get component report by PURL
• GET/api/v3/component-report/*
  Get component report by PURL

Billing Billing and subscription management API

• GET/billing
  Get billing information
• GET/billing/plans
  Get all available plans
• GET/billing/invoices
  Get user invoice history
• GET/billing/invoices/{invoiceId}/pdf
  Download invoice PDF

Current User Organization Current user organization management APIs

• GET/users/me/organization
  Get current user's organization
• PUT/users/me/organization
  Update current user's organization
• POST/users/me/organization/members/invite
  Invite users to current user's an organization
• POST/users/me/organization/invitations/{invitationToken}/accept
  Accept organization invitation
• GET/users/me/organization/onboarding-banner
  Get onboarding banner status
• DELETE/users/me/organization/onboarding-banner
  Dismiss onboarding banner
• GET/users/me/organization/members
  Retrieve current user's organization members and invitees
• DELETE/users/me/organization/members
  Bulk remove members or invitations from organization
• DELETE/users/me/organization/membership
  Leave organization
• DELETE/users/me/organization/members/{email}
  Remove member or invitation from organization

Recommendations Version upgrade recommendation API

• POST/recommendations
  Get version upgrade recommendations

Schemas

• UpdateOrganizationRequest
• OrganizationDTO
• CreateTokenRequest
• UserTokenDTO
• UserTokenWithPlaintextDTO
• InviteUsersRequest
• OrganizationMembersResponse
• RecommendationRequest
• DtsDimensions
• FromVersion
• MethodSignature
• PolicyCompliance
• PolicyConditionResult
• RecommendationResponse
• RecommendationVulnerableMethod
• RecommendedVersion
• LatestVersionRequest
• ComponentDetailDocument
• PurlRequest_Post
• ComponentReport_Post
• OssiVulnerability_Post
• Reference
• VulnerabilityDetailDocument
• VulnerableMethod
• ApiSearchResponse
• AffectedComponentVersion
• ApiSearchResponseAffectedComponentVersion
• OnboardingBannerStatusDTO
• PeriodDTO
• UsageDTO
• OssiMonthlyUsage
• OssiUsageDataRange
• OssiUsageHistoryDTO
• OssiUsageSummary
• CumulativeCreditUsage
• DailyCreditUsage
• ApiSearchResponseVulnerabilityDocument
• VulnerabilityDocument
• ApiSearchResponseComponentDetailDocument
• ApiSearchResponseComponentDocument
• ComponentDocument
• BillingDTO
• PlanDTO
• Invoice
• ComponentReport_Get
• OssiVulnerability_Get
• BulkRemoveMembersRequest