Symbols API Reference
| Field | Value |
|---|---|
| Source spec | symbols/openapi/v1.json |
| OpenAPI version | 3.1.1 |
| API version | 1.0.0 |
| Operations | 22 |
| Path filter | All paths |
Operations
GET /api/v1/buildinfo
API alias for /buildinfo.json (same payload).
| Property | Value |
|---|---|
| Operation ID | StellaOpsBuildInfoApi |
| Tags | StellaOps.Symbols.Server |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
GET /api/v1/symbols/marketplace
List symbol pack catalog entries
Returns a paginated list of symbol pack catalog entries, optionally filtered by source ID and a free-text search term. Results include pack metadata and are bounded by the configured limit and offset. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | ListMarketplaceCatalog |
| Tags | Symbol Marketplace |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
limit | query | no | |
offset | query | no | |
search | query | no | |
sourceId | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
GET /api/v1/symbols/marketplace/installed
List installed symbol packs
Returns all symbol packs currently installed for the requesting tenant. Returns 400 if the X-StellaOps-TenantId header is missing. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | ListInstalledPacks |
| Tags | Symbol Marketplace |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
GET /api/v1/symbols/marketplace/search
Search catalog by PURL or platform
Searches the symbol pack marketplace catalog by a free-text query (q) or platform string. Falls back to platform if q is empty. Returns matching catalog entries up to the specified limit. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | SearchMarketplaceCatalog |
| Tags | Symbol Marketplace |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
limit | query | no | |
platform | query | no | |
q | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
POST /api/v1/symbols/marketplace/sync
Trigger marketplace sync from configured sources
Enqueues a marketplace sync job to refresh the symbol pack catalog from all configured sources for the requesting tenant. Returns 202 Accepted with the queued status. Returns 400 if the X-StellaOps-TenantId header is missing. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | TriggerMarketplaceSync |
| Tags | Symbol Marketplace |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
GET /api/v1/symbols/marketplace/{entryId}
Get catalog entry detail
Returns the full catalog entry record for a specific marketplace entry ID including pack metadata, publisher, version, and install eligibility. Returns 404 if the entry is not found. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | GetMarketplaceCatalogEntry |
| Tags | Symbol Marketplace |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
entryId | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
POST /api/v1/symbols/marketplace/{entryId}/install
Install a symbol pack from the marketplace
Installs a symbol pack from the marketplace catalog for the requesting tenant, recording the installation against the specified catalog entry ID. Returns 200 with the installation status. Returns 400 if the X-StellaOps-TenantId header is missing. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | InstallMarketplacePack |
| Tags | Symbol Marketplace |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
entryId | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
POST /api/v1/symbols/marketplace/{entryId}/uninstall
Uninstall a symbol pack
Removes the installation of a symbol pack for the requesting tenant by catalog entry ID. Returns 200 with the uninstall status. Returns 400 if the X-StellaOps-TenantId header is missing. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | UninstallMarketplacePack |
| Tags | Symbol Marketplace |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
entryId | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
GET /api/v1/symbols/sources
List symbol sources with freshness projections
Returns all configured symbol pack sources with their freshness projections, sync state, and trust metadata. Optionally includes disabled sources when includeDisabled is true. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | ListSymbolSources |
| Tags | Symbol Sources |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
includeDisabled | query | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
POST /api/v1/symbols/sources
Create a new symbol source
Creates a new symbol pack source with the provided configuration. Assigns a new ID if not supplied. Returns 201 Created with the created source record. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | CreateSymbolSource |
| Tags | Symbol Sources |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
GET /api/v1/symbols/sources/summary
Get symbol source summary cards
Returns aggregated health summary cards for all enabled symbol sources including counts of healthy, warning, stale, and unavailable sources and the average trust score across the fleet. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | GetSymbolSourceSummary |
| Tags | Symbol Sources |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
GET /api/v1/symbols/sources/{id}
Get symbol source detail with trust score
Returns the full symbol source record by ID including its sync state, freshness projection, and computed trust score breakdown. Returns 404 if the source is not found. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | GetSymbolSource |
| Tags | Symbol Sources |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
PUT /api/v1/symbols/sources/{id}
Update a symbol source
Replaces the configuration of an existing symbol source by ID, updating its metadata, freshness SLA, and enabled state. Returns 200 with the updated source record. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | UpdateSymbolSource |
| Tags | Symbol Sources |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
DELETE /api/v1/symbols/sources/{id}
Disable (soft-delete) a symbol source
Soft-deletes (disables) a symbol source by ID, preventing it from appearing in default listings without permanently removing its history. Returns 204 No Content on success. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | DisableSymbolSource |
| Tags | Symbol Sources |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
GET /api/v1/symbols/sources/{id}/freshness
Get symbol source freshness detail
Returns freshness detail for a specific symbol source including status, age in seconds, SLA threshold, last sync time, last successful sync, last error, and cumulative sync and error counts. Returns 404 if the source is not found. Requires authentication.
| Property | Value |
|---|---|
| Operation ID | GetSymbolSourceFreshness |
| Tags | Symbol Sources |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
GET /buildinfo.json
Image build provenance (module, gitSha, gitCommitTime, imageBuiltAt, branch) for drift detection.
| Property | Value |
|---|---|
| Operation ID | StellaOpsBuildInfoFile |
| Tags | StellaOps.Symbols.Server |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
GET /health
Health check endpoint
| Property | Value |
|---|---|
| Operation ID | GetHealth |
| Tags | StellaOps.Symbols.Server |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
GET /v1/symbols/by-debug-id/{debugId}
Get manifests by debug ID
| Property | Value |
|---|---|
| Operation ID | GetManifestsByDebugId |
| Tags | StellaOps.Symbols.Server |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
debugId | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
400 | Bad Request | application/problem+json |
GET /v1/symbols/manifests
Query symbol manifests
| Property | Value |
|---|---|
| Operation ID | QuerySymbolManifests |
| Tags | StellaOps.Symbols.Server |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
binaryName | query | no | |
codeId | query | no | |
debugId | query | no | |
limit | query | no | |
offset | query | no | |
platform | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
400 | Bad Request | application/problem+json |
POST /v1/symbols/manifests
Upload a symbol manifest
| Property | Value |
|---|---|
| Operation ID | UploadSymbolManifest |
| Tags | StellaOps.Symbols.Server |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|---|---|
201 | Created | - |
400 | Bad Request | application/problem+json |
GET /v1/symbols/manifests/{manifestId}
Get symbol manifest by ID
| Property | Value |
|---|---|
| Operation ID | GetSymbolManifest |
| Tags | StellaOps.Symbols.Server |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
manifestId | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
400 | Bad Request | application/problem+json |
404 | Not Found | - |
POST /v1/symbols/resolve
Resolve symbol addresses
| Property | Value |
|---|---|
| Operation ID | ResolveSymbols |
| Tags | StellaOps.Symbols.Server |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | - |
400 | Bad Request | application/problem+json |
