Safeguard.sh Documentation Center
Portal

Manage Your Repository

Organize and manage your SBOM repository in Portal

Manage Your Repository

The repository management features in Portal help you organize, maintain, and govern your SBOM collection effectively.

Overview

Repository management enables you to:

  • Organize SBOMs into folders and categories
  • Set retention policies
  • Manage storage and quotas
  • Configure access controls
  • Maintain SBOM quality

Repository Structure

Hierarchy

Repository
├── Products/
│   ├── Product A/
│   │   ├── v1.0.0 (SBOM)
│   │   ├── v1.1.0 (SBOM)
│   │   └── v2.0.0 (SBOM)
│   └── Product B/
├── Third-Party/
│   ├── Vendor A/
│   └── Vendor B/
├── Internal/
└── Archive/

Folders

Create folders to organize SBOMs:

  1. Navigate to PortalRepository
  2. Click + New Folder
  3. Enter folder name
  4. Set folder properties
  5. Click Create

Folder Properties

PropertyDescription
NameFolder display name
DescriptionPurpose of folder
ParentParent folder (for nesting)
AccessWho can access
RetentionAuto-archive policy

Managing SBOMs

Uploading SBOMs

Upload new SBOMs to your repository:

  1. Navigate to target folder
  2. Click Upload
  3. Drag files or click Browse
  4. Enter SBOM metadata
  5. Click Upload

SBOM Metadata

FieldDescriptionRequired
NameDisplay nameYes
VersionVersion identifierYes
ProductAssociated productNo
DescriptionSBOM descriptionNo
TagsClassification tagsNo

Moving SBOMs

Move SBOMs between folders:

  1. Select SBOM(s)
  2. Click Move
  3. Select destination folder
  4. Confirm move

Copying SBOMs

Create copies:

  1. Select SBOM(s)
  2. Click Copy
  3. Select destination
  4. Optionally rename
  5. Confirm copy

Deleting SBOMs

Remove SBOMs:

  1. Select SBOM(s)
  2. Click Delete
  3. Confirm deletion

Note: Deleted SBOMs are moved to Trash and can be restored within 30 days.

Tagging System

Creating Tags

Set up tags for classification:

  1. Go to SettingsTags
  2. Click + New Tag
  3. Enter tag name and color
  4. Save

Applying Tags

Add tags to SBOMs:

  1. Select SBOM
  2. Click Tags
  3. Select applicable tags
  4. Save

Tag-Based Views

Filter repository by tags:

  1. Click Filter
  2. Select tag(s)
  3. View filtered results

Retention Policies

Policy Types

PolicyDescription
Keep AllNo automatic deletion
Keep Latest NKeep N most recent versions
Time-BasedDelete after X days
Archive AfterMove to archive after X days

Setting Retention

Configure retention at folder level:

  1. Open folder settings
  2. Go to Retention tab
  3. Select policy type
  4. Configure parameters
  5. Save

Retention Exceptions

Exclude specific SBOMs from retention:

  1. Open SBOM
  2. Click Settings
  3. Enable Exclude from retention

Storage Management

View Storage Usage

Monitor storage consumption:

  1. Go to SettingsStorage
  2. View usage summary:
    • Total storage used
    • Usage by folder
    • Largest SBOMs
    • Growth trends

Storage Quotas

PlanStorage Limit
Free1 GB
Pro50 GB
EnterpriseUnlimited

Reducing Storage

Free up storage:

  • Delete unused SBOMs
  • Archive old versions
  • Enable retention policies
  • Remove duplicate SBOMs

Bulk Operations

Bulk Upload

Upload multiple SBOMs:

  1. Click Bulk Upload
  2. Select files (ZIP archive supported)
  3. Map to products/folders
  4. Review and confirm
  5. Monitor progress

Bulk Download

Download multiple SBOMs:

  1. Select SBOMs
  2. Click Download
  3. Choose format
  4. Download archive

Bulk Edit

Edit multiple SBOMs:

  1. Select SBOMs
  2. Click Bulk Edit
  3. Modify common fields
  4. Apply changes

Access Control

Folder Permissions

Set access at folder level:

PermissionCapabilities
OwnerFull control
EditorAdd, modify, delete
ViewerView and download
NoneNo access

Inheritance

Child folders inherit parent permissions unless overridden.

Sharing Folders

Share folders with team members:

  1. Open folder settings
  2. Go to Sharing tab
  3. Add users/teams
  4. Set permission level
  5. Save

Search and Filter

Search within repository:

  • Type in search box
  • Search by name, tag, metadata
  • Results update in real-time

Advanced Filters

FilterOptions
FolderSpecific folder(s)
DateUpload date range
TagsSelected tags
FormatCycloneDX, SPDX
ComplianceCompliance status

Saved Searches

Save common searches:

  1. Apply filters
  2. Click Save Search
  3. Name the search
  4. Access from Saved Searches

Audit Trail

Repository Activity

View repository activity log:

  1. Go to RepositoryActivity
  2. View recent actions:
    • Uploads
    • Downloads
    • Modifications
    • Deletions

Export Audit Log

Export for compliance:

  1. Click Export
  2. Select date range
  3. Choose format
  4. Download log

API Access

# List repository contents
curl -X GET https://api.safeguard.sh/v1/portal/repository \
  -H "Authorization: Bearer $API_KEY"

# Create folder
curl -X POST https://api.safeguard.sh/v1/portal/repository/folders \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"name": "Products", "parent_id": null}'

# Upload SBOM
curl -X POST https://api.safeguard.sh/v1/portal/repository/sboms \
  -H "Authorization: Bearer $API_KEY" \
  -F "file=@sbom.json" \
  -F "name=My Product" \
  -F "version=1.0.0"

# Delete SBOM
curl -X DELETE https://api.safeguard.sh/v1/portal/repository/sboms/{id} \
  -H "Authorization: Bearer $API_KEY"

Best Practices

Organization

  • Create logical folder structure
  • Use consistent naming conventions
  • Apply tags consistently
  • Document folder purposes

Maintenance

  • Review storage regularly
  • Apply appropriate retention
  • Archive old versions
  • Clean up duplicates

Security

  • Set appropriate permissions
  • Review access regularly
  • Audit sensitive operations
  • Use least privilege

Next Steps

On this page