Skip to Content
veriom

Get workspace architecture truth

Every repository's latest architecture, merged into one map. Each repository in audit scope contributes the newest snapshot of its completed audits. 404 when none has one yet, like an audit's truth.

GET
/v1/workspaces/{workspace_id}/architecture/truth

Every repository's latest architecture, merged into one map.

Each repository in audit scope contributes the newest snapshot of its completed audits. 404 when none has one yet, like an audit's truth.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Response Body

Successful Response

application/json
  1. response

Every repository's latest architecture, merged into one map.

Keys of repository-local elements (the repository, its services, modules, pipelines, APIs and boundaries) carry the repository, so two repositories never share one; a package or cloud resource keeps its key, so repositories that use it meet at one node. audit_id is the newest of the merged audits, style is null, and the counts are the merged map's.

audit_id*Audit Id
Formatuuid
entities*array<>
entity_count*Entity Count
evidence*array<>
generated_at*Generated At
Formatdate-time
missing_sources*array<string>
relationship_count*Relationship Count
relationships*array<>
repositories*array<>

The repositories merged into the map, each with the audit it came from.

source_coverage*Source Coverage
sources*array<string>
status*Status
style?|

The architectural style the Security Architect classified from this snapshot, with evidence, confidence and a plain explanation. Null before it ran.

version*Version
Example Request
curl -X GET 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/architecture/truth'
Example Response
{  "audit_id": "78c04fa6-cfb4-46a0-9aa5-3681ba4f3897",  "entities": [    {      "attributes": {},      "canonical_key": "string",      "confidence": "string",      "contradictions": [        {          "alternatives": [            {              "evidence_ids": [                "973ab5a6-b373-447d-ab9d-bdb660b35afc"              ],              "observed_at": "2019-08-24T14:15:22Z",              "source_keys": [                "string"              ],              "source_refs": [                "string"              ],              "value": "string"            },            {              "evidence_ids": [                "973ab5a6-b373-447d-ab9d-bdb660b35afc"              ],              "observed_at": "2019-08-24T14:15:22Z",              "source_keys": [                "string"              ],              "source_refs": [                "string"              ],              "value": "string"            }          ],          "detected_at": "2019-08-24T14:15:22Z",          "field": "string",          "resolution_summary": "string",          "resolved_at": "2019-08-24T14:15:22Z",          "state": "open"        }      ],      "evidence_ids": [        "string"      ],      "first_observed_at": "2019-08-24T14:15:22Z",      "kind": "string",      "last_observed_at": "2019-08-24T14:15:22Z",      "links": {        "decision_ids": [          "ee5dfe1a-ec80-4b91-a667-92bab6473bc1"        ],        "deployment_evidence_ids": [          "b9ebcd9e-d4d0-470b-b9ae-54dd726b538e"        ],        "finding_ids": [          "d5d48824-6cad-498f-8feb-561fb3cdb809"        ],        "owner_ids": [          "f08e96b0-7632-4168-a4e6-5228d054c122"        ],        "remediation_ids": [          "b8f3922c-cdec-4b4e-8fb9-135818ed224f"        ]      },      "name": "string",      "sources": [        "string"      ]    }  ],  "entity_count": 0,  "evidence": [    {      "content_sha256": "string",      "evidence_kind": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "location": {},      "object_key": "string",      "observed_at": "2019-08-24T14:15:22Z",      "provider": "string",      "relationship_kind": "string",      "source_ref": "string",      "source_type": "code",      "subject_key": "string",      "summary": "string"    }  ],  "generated_at": "2019-08-24T14:15:22Z",  "missing_sources": [    "string"  ],  "relationship_count": 0,  "relationships": [    {      "attributes": {},      "canonical_key": "string",      "confidence": "string",      "contradictions": [        {          "alternatives": [            {              "evidence_ids": [                "973ab5a6-b373-447d-ab9d-bdb660b35afc"              ],              "observed_at": "2019-08-24T14:15:22Z",              "source_keys": [                "string"              ],              "source_refs": [                "string"              ],              "value": "string"            },            {              "evidence_ids": [                "973ab5a6-b373-447d-ab9d-bdb660b35afc"              ],              "observed_at": "2019-08-24T14:15:22Z",              "source_keys": [                "string"              ],              "source_refs": [                "string"              ],              "value": "string"            }          ],          "detected_at": "2019-08-24T14:15:22Z",          "field": "string",          "resolution_summary": "string",          "resolved_at": "2019-08-24T14:15:22Z",          "state": "open"        }      ],      "evidence_ids": [        "string"      ],      "first_observed_at": "2019-08-24T14:15:22Z",      "kind": "string",      "last_observed_at": "2019-08-24T14:15:22Z",      "links": {        "decision_ids": [          "ee5dfe1a-ec80-4b91-a667-92bab6473bc1"        ],        "deployment_evidence_ids": [          "b9ebcd9e-d4d0-470b-b9ae-54dd726b538e"        ],        "finding_ids": [          "d5d48824-6cad-498f-8feb-561fb3cdb809"        ],        "owner_ids": [          "f08e96b0-7632-4168-a4e6-5228d054c122"        ],        "remediation_ids": [          "b8f3922c-cdec-4b4e-8fb9-135818ed224f"        ]      },      "source_key": "string",      "sources": [        "string"      ],      "superseded_at": "2019-08-24T14:15:22Z",      "supersedes_id": "8149cd94-4e90-4a99-91f5-a3e0f9b829dc",      "target_key": "string"    }  ],  "repositories": [    {      "audit_id": "78c04fa6-cfb4-46a0-9aa5-3681ba4f3897",      "generated_at": "2019-08-24T14:15:22Z",      "repository": "string",      "repository_id": "b349ae61-b973-4c6c-a5e0-89183ba99ff3"    }  ],  "source_coverage": "string",  "sources": [    "string"  ],  "status": "string",  "style": {    "deployable_units": 0,    "explanation": "string",    "explanation_source": "deterministic",    "primary": "microservices",    "primary_label": "string",    "styles": [      {        "confidence": 0,        "counter_signals": [          {            "evidence_ids": [              "string"            ],            "statement": "string"          }        ],        "label": "string",        "signals": [          {            "evidence_ids": [              "string"            ],            "statement": "string"          }        ],        "style": "microservices"      }    ],    "summary": "string"  },  "version": "string"}