# Aplas

> Aplas maps the software estate — the applications, integrations, components and the
> relationships between them — and publishes those maps to the people who need them.
> This site documents the product and its REST APIs.

Two API versions are published. v3 serves organizations on the current data model;
v2 is the legacy API for organizations created before the v2 rollout. An API key works
with exactly one of the two.

## Guides

- [A guide for viewers](https://docs.aplas.com/docs/welcome-view-users): You have been sent an Aplas view — here is how to read it
- [API keys](https://docs.aplas.com/docs/api-keys): Programmatic access to your inventory, over the API and the MCP server
- [Account and plans](https://docs.aplas.com/docs/account-and-plans): How your plan is sized, what counts towards it, and where billing lives
- [Aplas Launch Checklist](https://docs.aplas.com/docs/setup-checklist): Checklist to launch Aplas as a service within your organization
- [Best Practices for Managing Map Scale](https://docs.aplas.com/docs/best-practices-for-managing-scale): Some tips to enhance your software map that will improve navigation and understanding
- [Browsing and editing the grid](https://docs.aplas.com/docs/inventory-grid): Search, facets, filters, columns, bulk edits and export
- [Confluence Connector](https://docs.aplas.com/docs/confluence-connector): Sync with Confluence documents to keep your software index up-to-date
- [Connecting AI assistants (MCP)](https://docs.aplas.com/docs/ai-overview): Query and manage your software landscape using natural language through AI assistants
- [Connector Overview](https://docs.aplas.com/docs/connector-overview): Automate the synchronization of software asset metadata
- [Exports and reporting](https://docs.aplas.com/docs/exports): Everything taken out of this workspace — documents to generate and collect, and a record of every export
- [Getting started with Aplas](https://docs.aplas.com/docs): What Aplas holds, how you fill it, and how you publish it
- [GitHub Connector](https://docs.aplas.com/docs/github-connector): Sync with your GitHub org to keep your software index up-to-date
- [Import](https://docs.aplas.com/docs/import-overview): Bringing data in — a file, a paste, or a drafted starting point
- [Index Overview](https://docs.aplas.com/docs/index-overview): Create an index and customize
- [Inventory overview](https://docs.aplas.com/docs/inventory-overview): Asset types, fields and relations — the shape of what you catalogue
- [LeanIX Connector](https://docs.aplas.com/docs/leanix-connector): Sync with LeanIX fact sheets to keep your software index up-to-date
- [LeanIX Embedding](https://docs.aplas.com/docs/leanix-embedding): Instructions for embedding Aplas publications within LeanIX dashboards
- [MCP server setup](https://docs.aplas.com/docs/ai-setup): Connect your AI assistant to Aplas using the MCP server
- [Manual Map Build](https://docs.aplas.com/docs/manual-map-build): Control every aspect of your organization's software map
- [Map Overview](https://docs.aplas.com/docs/map-overview)
- [Maps](https://docs.aplas.com/docs/maps): Where your software lives — assets pinned to a grid so the same thing is always in the same place
- [Metamap Interface](https://docs.aplas.com/docs/metamap-interface)
- [Modelling Connections](https://docs.aplas.com/docs/modelling-connections): How to record the connections in your estate — as assets, as relationships, or both
- [Modelling Integrations](https://docs.aplas.com/docs/modelling-integrations): Best practices to model integrations/interfaces into the Aplas schema
- [Populating an Index](https://docs.aplas.com/docs/index-population)
- [Publication Overview](https://docs.aplas.com/docs/publication-overview): Share software metadata with the rest of your organization
- [Publishing a view](https://docs.aplas.com/docs/publishing): Giving a view a URL, for the members of your organization
- [Relationship types](https://docs.aplas.com/docs/relationship-types): The registry of verbs your assets connect with — naming, describing and colouring them
- [Style Overview](https://docs.aplas.com/docs/style-overview): Create powerful styles to tell stories on your software map
- [Stylemap Interface](https://docs.aplas.com/docs/stylemap-interface)
- [Styles](https://docs.aplas.com/docs/styles): How a map is coloured and labelled — a map can carry many styles
- [The AI assistant](https://docs.aplas.com/docs/assistant): Ask about your systems, and build the inventory in conversation
- [Upload via CSV](https://docs.aplas.com/docs/importing-via-csv)
- [Views](https://docs.aplas.com/docs/views-overview): Every way of looking at your inventory — and why you no longer publish to see one
- [Workspaces](https://docs.aplas.com/docs/workspaces): Dividing the estate, switching between workspaces, and the change log

## API v3 (current)

- [API Overview](https://docs.aplas.com/api/v3): REST API for programmatic access to Aplas workspaces, asset types, assets, relations and views.
- [Add targets for a relationship type](https://docs.aplas.com/api/v3/relations/addAssetRelations)
- [Apply one operation to many assets](https://docs.aplas.com/api/v3/assets/applyAssetsBulkOp)
- [Archive a view](https://docs.aplas.com/api/v3/views/archiveView)
- [Archive a workspace](https://docs.aplas.com/api/v3/workspaces/archiveWorkspace)
- [Asset Types](https://docs.aplas.com/api/v3/asset-types): Operations relating to asset types.
- [Assets](https://docs.aplas.com/api/v3/assets): Operations relating to assets — the rows themselves. Nested under an asset type because an asset slug is unique per (workspace, type), not per workspace.
- [Create a view](https://docs.aplas.com/api/v3/views/createView)
- [Create a workspace](https://docs.aplas.com/api/v3/workspaces/createWorkspace)
- [Create an asset type](https://docs.aplas.com/api/v3/asset-types/createAssetType)
- [Create an asset](https://docs.aplas.com/api/v3/assets/createAsset)
- [Create many assets, with per-item results](https://docs.aplas.com/api/v3/assets/createAssetsBulk)
- [Delete an asset type](https://docs.aplas.com/api/v3/asset-types/deleteAssetType)
- [Delete an asset](https://docs.aplas.com/api/v3/assets/deleteAsset)
- [Delete one relation](https://docs.aplas.com/api/v3/relations/deleteRelation)
- [Get a publication](https://docs.aplas.com/api/v3/publications/getPublication)
- [Get a relationship type](https://docs.aplas.com/api/v3/relationship-types/getRelationshipType)
- [Get a view](https://docs.aplas.com/api/v3/views/getView)
- [Get a workspace](https://docs.aplas.com/api/v3/workspaces/getWorkspace)
- [Get an asset type](https://docs.aplas.com/api/v3/asset-types/getAssetType)
- [Get an asset](https://docs.aplas.com/api/v3/assets/getAsset)
- [List a view's styles](https://docs.aplas.com/api/v3/views/listViewStyles)
- [List a workspace's views](https://docs.aplas.com/api/v3/views/listViews)
- [List an asset's relations](https://docs.aplas.com/api/v3/relations/listAssetRelations)
- [List asset types in a workspace](https://docs.aplas.com/api/v3/asset-types/listAssetTypes)
- [List assets of a type](https://docs.aplas.com/api/v3/assets/listAssets)
- [List relationship types](https://docs.aplas.com/api/v3/relationship-types/listRelationshipTypes)
- [List the organization's publications](https://docs.aplas.com/api/v3/publications/listPublications)
- [List workspaces](https://docs.aplas.com/api/v3/workspaces/listWorkspaces)
- [Publications](https://docs.aplas.com/api/v3/publications): Operations relating to publications — the organization's public shopfront. Org-level, because a publication's slug is unique per organization and only the default workspace's views may publish.
- [Publish a view](https://docs.aplas.com/api/v3/publications/createPublication)
- [Relations](https://docs.aplas.com/api/v3/relations): Operations relating to relations between assets. Endpoints are named by `{type, id}` slug pairs; a single relation is addressed by its natural key (relationship type + target type + target id) rather than a row id.
- [Relationship Types](https://docs.aplas.com/api/v3/relationship-types): The registry of edge kinds a workspace may use. Read-only: types arrive from the standard template, or are minted automatically when an asset type declares a relation field.
- [Set an asset's targets for a relationship type](https://docs.aplas.com/api/v3/relations/setAssetRelations)
- [Set or clear one relation's ordinal](https://docs.aplas.com/api/v3/relations/setRelationOrdinal)
- [Unpublish](https://docs.aplas.com/api/v3/publications/deletePublication)
- [Update a publication](https://docs.aplas.com/api/v3/publications/updatePublication)
- [Update a view](https://docs.aplas.com/api/v3/views/updateView)
- [Update a workspace](https://docs.aplas.com/api/v3/workspaces/updateWorkspace)
- [Update an asset type](https://docs.aplas.com/api/v3/asset-types/updateAssetType)
- [Update an asset](https://docs.aplas.com/api/v3/assets/updateAsset)
- [Views](https://docs.aplas.com/api/v3/views): Operations relating to views — the saved table / matrix / graph / map configurations inside a workspace.
- [Workspaces](https://docs.aplas.com/api/v3/workspaces): Operations relating to workspaces.

## API v2 (legacy)

- [API Overview](https://docs.aplas.com/api): REST API for programmatic access to Aplas indexes, maps, files, and connectors.
- [Connector](https://docs.aplas.com/api/connector): Operations relating to connectors.
- [Create a collection tag](https://docs.aplas.com/api/index-collection-tag/createCollectionTag)
- [Create a collection](https://docs.aplas.com/api/index-collection/createCollection)
- [Create a component tag](https://docs.aplas.com/api/index-component-tag/createComponentTag)
- [Create a component](https://docs.aplas.com/api/index-component/createComponent)
- [Create a filespec](https://docs.aplas.com/api/filespec/createFilespec)
- [Create a map](https://docs.aplas.com/api/map/createMap)
- [Create a publication](https://docs.aplas.com/api/publication/createPublication)
- [Create a style](https://docs.aplas.com/api/style/createStyle)
- [Create an application tag group](https://docs.aplas.com/api/index-application-tag-group/createApplicationTagGroup)
- [Create an application tag](https://docs.aplas.com/api/index-application-tag/createApplicationTag)
- [Create an application](https://docs.aplas.com/api/index-application/createApplication)
- [Create an index](https://docs.aplas.com/api/indexes/createIndex)
- [Create an integration tag](https://docs.aplas.com/api/index-integration-tag/createIntegrationTag)
- [Create an integration](https://docs.aplas.com/api/index-integration/createIntegration)
- [Delete a collection tag](https://docs.aplas.com/api/index-collection-tag/deleteCollectionTag)
- [Delete a collection](https://docs.aplas.com/api/index-collection/deleteCollection)
- [Delete a component tag](https://docs.aplas.com/api/index-component-tag/deleteComponentTag)
- [Delete a component](https://docs.aplas.com/api/index-component/deleteComponent)
- [Delete a map](https://docs.aplas.com/api/map/deleteMap)
- [Delete a publication](https://docs.aplas.com/api/publication/deletePublication)
- [Delete a style](https://docs.aplas.com/api/style/deleteStyle)
- [Delete an application tag group](https://docs.aplas.com/api/index-application-tag-group/deleteApplicationTagGroup)
- [Delete an application tag](https://docs.aplas.com/api/index-application-tag/deleteApplicationTag)
- [Delete an application](https://docs.aplas.com/api/index-application/deleteApplication)
- [Delete an index](https://docs.aplas.com/api/indexes/deleteIndex)
- [Delete an integration tag](https://docs.aplas.com/api/index-integration-tag/deleteIntegrationTag)
- [Delete an integration](https://docs.aplas.com/api/index-integration/deleteIntegration)
- [Duplicate a map](https://docs.aplas.com/api/map/duplicateMap)
- [Duplicate a publication](https://docs.aplas.com/api/publication/duplicatePublication)
- [Duplicate a style](https://docs.aplas.com/api/style/duplicateStyle)
- [Duplicate an index](https://docs.aplas.com/api/indexes/duplicateIndex)
- [File Spec](https://docs.aplas.com/api/filespec): Operations relating to fileSpecs.
- [File](https://docs.aplas.com/api/file): Operations relating to files.
- [Index Application Tag Group](https://docs.aplas.com/api/index-application-tag-group): Operations relating to index application tag groups.
- [Index Application Tag](https://docs.aplas.com/api/index-application-tag): Operations relating to index application tags.
- [Index Application](https://docs.aplas.com/api/index-application): Operations relating to index applications.
- [Index Collection Tag](https://docs.aplas.com/api/index-collection-tag): Operations relating to index collection tags.
- [Index Collection](https://docs.aplas.com/api/index-collection): Operations relating to index collections.
- [Index Component Tag](https://docs.aplas.com/api/index-component-tag): Operations relating to index component tags.
- [Index Component](https://docs.aplas.com/api/index-component): Operations relating to index components.
- [Index Integration Tag](https://docs.aplas.com/api/index-integration-tag): Operations relating to index integration tags.
- [Index Integration](https://docs.aplas.com/api/index-integration): Operations relating to index integrations.
- [Indexes](https://docs.aplas.com/api/indexes): Operations relating to indexes.
- [List all application tag groups](https://docs.aplas.com/api/index-application-tag-group/listApplicationTagGroups)
- [List all application tags](https://docs.aplas.com/api/index-application-tag/listApplicationTags)
- [List all applications](https://docs.aplas.com/api/index-application/listApplications)
- [List all collection tags](https://docs.aplas.com/api/index-collection-tag/listCollectionTags)
- [List all collections](https://docs.aplas.com/api/index-collection/listCollections)
- [List all component tags](https://docs.aplas.com/api/index-component-tag/listComponentTags)
- [List all components](https://docs.aplas.com/api/index-component/listComponents)
- [List all indexes](https://docs.aplas.com/api/indexes/listIndexes)
- [List all integration tags](https://docs.aplas.com/api/index-integration-tag/listIntegrationTags)
- [List all integrations](https://docs.aplas.com/api/index-integration/listIntegrations)
- [List all maps](https://docs.aplas.com/api/map/listMaps)
- [List all publications](https://docs.aplas.com/api/publication/listPublications)
- [List all styles](https://docs.aplas.com/api/style/listStyles)
- [Map](https://docs.aplas.com/api/map): Operations relating to maps.
- [Publication](https://docs.aplas.com/api/publication): Operations relating to publications.
- [Purge a single connector folder](https://docs.aplas.com/api/connector/deleteConnectorFolderStatus)
- [Purge all files from a connector's folders](https://docs.aplas.com/api/connector/deleteConnectorStatus)
- [Refresh a connector w/ period](https://docs.aplas.com/api/connector/refreshConnectorWithPeriod)
- [Refresh a connector](https://docs.aplas.com/api/connector/refreshConnector)
- [Replace a collection tag](https://docs.aplas.com/api/index-collection-tag/replaceCollectionTag)
- [Replace a collection](https://docs.aplas.com/api/index-collection/replaceCollection)
- [Replace a component tag](https://docs.aplas.com/api/index-component-tag/replaceComponentTag)
- [Replace a map](https://docs.aplas.com/api/map/replaceMap)
- [Replace a publication](https://docs.aplas.com/api/publication/replacePublication)
- [Replace a style](https://docs.aplas.com/api/style/replaceStyle)
- [Replace an application tag group](https://docs.aplas.com/api/index-application-tag-group/replaceApplicationTagGroup)
- [Replace an application tag](https://docs.aplas.com/api/index-application-tag/replaceApplicationTag)
- [Replace an application](https://docs.aplas.com/api/index-application/replaceApplication)
- [Replace an existing component](https://docs.aplas.com/api/index-component/replaceComponent)
- [Replace an index](https://docs.aplas.com/api/indexes/replaceIndex)
- [Replace an integration tag](https://docs.aplas.com/api/index-integration-tag/replaceIntegrationTag)
- [Replace an integration](https://docs.aplas.com/api/index-integration/replaceIntegration)
- [Retrieve a collection tag](https://docs.aplas.com/api/index-collection-tag/collectionTagById)
- [Retrieve a collection](https://docs.aplas.com/api/index-collection/collectionById)
- [Retrieve a component tag](https://docs.aplas.com/api/index-component-tag/componentTagById)
- [Retrieve a component](https://docs.aplas.com/api/index-component/componentById)
- [Retrieve a connector folder's contents metadata](https://docs.aplas.com/api/connector/connectorFolderStatus)
- [Retrieve a connector's status](https://docs.aplas.com/api/connector/connectorStatus)
- [Retrieve a file](https://docs.aplas.com/api/file/fileById)
- [Retrieve a filespec](https://docs.aplas.com/api/filespec/filespecById)
- [Retrieve a map](https://docs.aplas.com/api/map/mapById)
- [Retrieve a publication](https://docs.aplas.com/api/publication/publicationById)
- [Retrieve a style](https://docs.aplas.com/api/style/styleById)
- [Retrieve an application tag group](https://docs.aplas.com/api/index-application-tag-group/applicationTagGroupById)
- [Retrieve an application tag](https://docs.aplas.com/api/index-application-tag/applicationTagById)
- [Retrieve an application](https://docs.aplas.com/api/index-application/applicationById)
- [Retrieve an index](https://docs.aplas.com/api/indexes/indexById)
- [Retrieve an integration tag](https://docs.aplas.com/api/index-integration-tag/integrationTagById)
- [Retrieve an integration](https://docs.aplas.com/api/index-integration/integrationById)
- [Style](https://docs.aplas.com/api/style): Operations relating to map styles.
- [Update a collection partially](https://docs.aplas.com/api/index-collection/updateCollection)
- [Update a collection tag partially](https://docs.aplas.com/api/index-collection-tag/updateCollectionTag)
- [Update a component tag partially](https://docs.aplas.com/api/index-component-tag/updateComponentTag)
- [Update a map partially](https://docs.aplas.com/api/map/updateMap)
- [Update a publication partially](https://docs.aplas.com/api/publication/updatePublication)
- [Update a style partially](https://docs.aplas.com/api/style/updateStyle)
- [Update an application partially](https://docs.aplas.com/api/index-application/updateApplication)
- [Update an application tag group partially](https://docs.aplas.com/api/index-application-tag-group/updateApplicationTagGroup)
- [Update an application tag partially](https://docs.aplas.com/api/index-application-tag/updateApplicationTag)
- [Update an existing component partially](https://docs.aplas.com/api/index-component/updateComponent)
- [Update an index partially](https://docs.aplas.com/api/indexes/updateIndex)
- [Update an integration partially](https://docs.aplas.com/api/index-integration/updateIntegration)
- [Update an integration tag partially](https://docs.aplas.com/api/index-integration-tag/updateIntegrationTag)
- [Upload a file](https://docs.aplas.com/api/file/uploadFile)

## Specifications

- [OpenAPI v3](https://docs.aplas.com/openapi-v3.yaml): machine-readable specification for the current API
- [OpenAPI v2](https://docs.aplas.com/openapi.yaml): machine-readable specification for the legacy API