2021-08-15 01:39:19 +00:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								# API Organization
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								OpenMetadata has the following APIs. See this [sandbox link ](https://sandbox.open-metadata.org/docs ) for full documentation related to APIs.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-08-15 04:51:47 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								*  **Data Asset APIs** - These API endpoints support operations related to data asset entities.  
						 
					
						
							
								
									
										
										
										
											2021-08-15 01:39:19 +00:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								  *  `.../api/v1/databases` 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  *  `...api/v1/tables` 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  *  `.../api/v1/metrics` 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  *  `.../api/v1/dashboards` 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  *  `.../api/v1/reports` 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  *  `.../api/v1/pipelines` 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-15 04:51:47 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								*  **Service APIs** - These API endpoints support operations related to services from which metadata is collected:  
						 
					
						
							
								
									
										
										
										
											2021-08-15 01:39:19 +00:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								  *  `.../api/v1/services`  is the collection of all service resources.
							 
						 
					
						
							
								
									
										
										
										
											2021-08-29 21:24:50 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  *  `.../api/v1/services/databaseService`  - APIs related to database services. This includes transactional databases - MySQL, Postgres, MSSQL, Oracle, and data warehouses - Apache Hive BigQuery, Redshift, and Snowflake. 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-15 04:51:47 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								*  **Teams &  Users APIs** 
						 
					
						
							
								
									
										
										
										
											2021-08-29 21:24:50 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  *  `.../api/v1/teams`  - APIs related to team entities
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  *  `.../api/v1/users`  - APIs related to user entities
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								*  **Search &  Suggest APIs -** These API endpoints support search and suggest APIs: 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  *  `.../api/v1/search`  - collection for search and suggest APIs
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  *  `.../api/v1/search/query`  - search entities using query text
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  *  `.../api/v1/search/suggest`  - get suggested entities used for auto-completion
							 
						 
					
						
							
								
									
										
										
										
											2021-08-15 04:51:47 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								*  **Other APIs** 
						 
					
						
							
								
									
										
										
										
											2021-08-15 01:39:19 +00:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								  *  `.../api/v1/tags`  for APIs related to Tag Category and Tag entities
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  *  `../api/v1/feeds`  for APIs related to Threads and Posts entities
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  *  `.../api/v1/usage`  for reporting usage information of entities