Bigeye Metadata API

The Bigeye Metadata API covers the data catalog and workspace administration surface: sources, schemas, tables, columns and virtual tables; catalog rebuilds and schema-change tracking; lineage (v1 and v2) nodes and edges; users, groups, roles, workspaces and object ownership; agent registration, API keys and service accounts; integrations, named schedules, tags, favorites, search, dashboards and workflow status.

OpenAPI Specification

bigeye-metadata-openapi.json Raw ↑
{"openapi":"3.0.0","info":{"title":"Metadata","version":"version not set"},"paths":{"/api/v1/agent/public-key/bigeye":{"get":{"operationId":"AgentService_GetBigeyePublicKey","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedPublicKeyMessage"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get the public key the user's company Agent should use when sending messages to Bigeye","tags":["AgentService"]}},"/api/v1/agent/public-key":{"get":{"operationId":"AgentService_GetCompanyPublicKey","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedPublicKeyMessage"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get the public key Bigeye currently has for the user's company Agent","tags":["AgentService"]},"put":{"operationId":"AgentService_SetCompanyPublicKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedPublicKeyMessage"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedPublicKeyMessage"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Set the public key Bigeye will use to encrypt messages to the user's company Agent","tags":["AgentService"]}},"/api/v1/agent/health/ping":{"get":{"operationId":"AgentService_PingAgents","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedAgentHealthResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Synchronously ping all agent sources for their health status","tags":["AgentService"]}},"/api/v1/agent/health":{"get":{"operationId":"AgentService_RetrieveAgentHealth","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedAgentHealthResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Retrieve the latest health status of all agent sources","tags":["AgentService"]}},"/api/v1/agent/validate/source/{sourceId}":{"get":{"operationId":"AgentService_ValidateAgentForSource","parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedSourceValidationResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Validate that the agent is working for a given source","tags":["AgentService"]}},"/api/v1/agent-api-keys/{apiKeyId}":{"delete":{"operationId":"ApiKeyService_DeleteAgentApiKey","parameters":[{"in":"path","name":"apiKeyId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Delete an Agent API Key","tags":["ApiKeyService"]}},"/api/v1/personal-api-keys/{apiKeyId}":{"delete":{"operationId":"ApiKeyService_DeletePersonalApiKey","parameters":[{"in":"path","name":"apiKeyId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Delete a Personal API Key","tags":["ApiKeyService"]}},"/api/v1/agent-api-keys":{"get":{"operationId":"ApiKeyService_GetAllAgentApiKeys","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedListAgentApiKeyResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get all Agent API Keys","tags":["ApiKeyService"]},"post":{"operationId":"ApiKeyService_CreateAgentApiKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedCreateAgentApiKeyRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedCreateAgentApiKeyResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Create an Agent API Key","tags":["ApiKeyService"]}},"/api/v1/personal-api-keys":{"get":{"operationId":"ApiKeyService_GetAllPersonalApiKeys","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedListPersonalApiKeyResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get all Personal API Keys","tags":["ApiKeyService"]},"post":{"operationId":"ServiceAccountApiKeyService_CreateServiceAccountApiKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedCreatePersonalApiKeyRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedCreatePersonalApiKeyResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Create a Service Account API Key","tags":["ServiceAccountApiKeyService"]}},"/api/v1/agent-api-keys/verify":{"get":{"operationId":"ApiKeyService_VerifyAgentApiKey","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"security":[{"Agent_API_Key":[]}],"summary":"Verify an Agent API Key","tags":["ApiKeyService"]}},"/api/v1/personal-api-keys/verify":{"get":{"operationId":"ApiKeyService_VerifyPersonalApiKey","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"security":[{"Personal_API_Key":[]}],"summary":"Verify a Personal API Key","tags":["ApiKeyService"]}},"/api/v1/rebuilds/schemas/{schemaId}":{"post":{"operationId":"CatalogRebuildsService_UpdateSchema","parameters":[{"in":"path","name":"schemaId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedRebuildSchemaRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedWorkflowResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Queue a catalog rebuild for a schema","tags":["CatalogRebuildsService"]}},"/api/v1/rebuilds/sources/{sourceId}":{"post":{"operationId":"CatalogRebuildsService_UpdateSource","parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedRebuildSourceRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedWorkflowResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Queue a catalog rebuild for a source","tags":["CatalogRebuildsService"]}},"/api/v1/rebuilds/tables/single-table/queue":{"post":{"operationId":"CatalogRebuildsService_UpdateTable","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedRebuildSingleTableRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedQueueSingleTableResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Queue a catalog rebuild for a table","tags":["CatalogRebuildsService"]}},"/api/v1/columns/{columnId}/applicable-metric-types":{"get":{"operationId":"ColumnService_GetColumnApplicableMetricTypes","parameters":[{"in":"path","name":"columnId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetColumnApplicableMetricTypesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get applicable metric types for column","tags":["ColumnService"]}},"/api/v1/columns/fetch":{"post":{"operationId":"ColumnService_GetColumns","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetColumnListRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetColumnListResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get columns","tags":["ColumnService"]}},"/api/v1/columns":{"get":{"operationId":"ColumnService_GetSpecifiedColumns","parameters":[{"in":"query","name":"tableId","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"columnIds","required":false,"explode":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}},{"in":"query","name":"includeDataNodeIds","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedColumnSearchResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get specified columns","tags":["ColumnService"]}},"/api/v1/company/{companyId}":{"put":{"operationId":"CompanyService_UpdateCompany","parameters":[{"in":"path","name":"companyId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedUpdateCompanyRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedCompany"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Update a company","tags":["CompanyService"]}},"/api/v1/configs/fetch":{"post":{"operationId":"ConfigService_GetConfigs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetConfigListResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get configs","tags":["ConfigService"]}},"/api/v1/configs":{"put":{"operationId":"ConfigService_UpdateConfigs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedUpdateConfigRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetConfigListResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Update configs","tags":["ConfigService"]}},"/api/v1/dashboard/refresh-info":{"post":{"operationId":"DashboardService_GetDashboardDataRefreshInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDashboardRefreshInfoRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDashboardRefreshInfoResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Gets last updated date for dashboard data series","tags":["DashboardService"]}},"/api/v1/dashboard/calculate-data-points-request":{"post":{"operationId":"DashboardService_GetDashboardDataSeries","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDashboardDataPointsRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDashboardDataPointsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get dashboard data series for requested types","tags":["DashboardService"]}},"/api/v1/favorites/bulk":{"post":{"operationId":"FavoriteService_BulkFavorite","requestBody":{"$ref":"#/components/requestBodies/generatedBulkFavoriteRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedBulkFavoriteResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Mark multiple entities as favorites","tags":["FavoriteService"]}},"/api/v1/favorites/unfavorite/bulk":{"post":{"operationId":"FavoriteService_BulkUnfavorite","requestBody":{"$ref":"#/components/requestBodies/generatedBulkFavoriteRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedBulkFavoriteResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Remove multiple entities from favorites","tags":["FavoriteService"]}},"/api/v1/favorites":{"get":{"operationId":"FavoriteService_GetFavorites","parameters":[{"in":"query","name":"workspaceId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedFavoriteListResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get favorites for the current user","tags":["FavoriteService"]},"post":{"operationId":"FavoriteService_Favorite","requestBody":{"$ref":"#/components/requestBodies/generatedFavoriteRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Mark an entity as a favorite","tags":["FavoriteService"]}},"/api/v1/favorites/unfavorite":{"post":{"operationId":"FavoriteService_Unfavorite","requestBody":{"$ref":"#/components/requestBodies/generatedFavoriteRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Remove an entity from favorites","tags":["FavoriteService"]}},"/api/v1/groups/grants":{"put":{"operationId":"GroupService_BulkChangeGroupGrants","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedBulkChangeGroupGrantsRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedBulkChangeGroupGrantsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Change a group's access to workspaces","tags":["GroupService"]}},"/api/v1/groups/users":{"put":{"operationId":"GroupService_BulkChangeGroupUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedBulkChangeGroupUsersRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedBulkChangeGroupUsersResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Add or remove users to a group","tags":["GroupService"]}},"/api/v1/groups":{"get":{"operationId":"GroupService_GetAllGroups","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGroupListResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get all groups","tags":["GroupService"]},"post":{"operationId":"GroupService_CreateGroup","requestBody":{"$ref":"#/components/requestBodies/generatedCreateOrUpdateGroupRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGroup"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Create a group","tags":["GroupService"]}},"/api/v1/groups/{groupId}":{"delete":{"operationId":"GroupService_DeleteGroup","parameters":[{"in":"path","name":"groupId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Delete a group","tags":["GroupService"]},"get":{"operationId":"GroupService_GetGroup","parameters":[{"in":"path","name":"groupId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGroup"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get a group","tags":["GroupService"]},"put":{"operationId":"GroupService_UpdateGroup","parameters":[{"in":"path","name":"groupId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"$ref":"#/components/requestBodies/generatedCreateOrUpdateGroupRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGroup"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Update a group","tags":["GroupService"]}},"/api/v1/integrations/dbt/jobs/{dbtJobId}":{"get":{"operationId":"IntegrationService_GetDbtJob","parameters":[{"in":"path","name":"dbtJobId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetDbtJobResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get single dbt job","tags":["IntegrationService"]}},"/api/v1/integrations/dbt/jobs/runs/{dbtJobRunId}":{"get":{"operationId":"IntegrationService_GetDbtJobRunResponse","parameters":[{"in":"path","name":"dbtJobRunId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDbtJobRunResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get single dbt job run","tags":["IntegrationService"]}},"/api/v1/integrations/dbt/projects/{dbtProjectId}/jobs":{"get":{"operationId":"IntegrationService_GetDbtJobsForProject","parameters":[{"in":"path","name":"dbtProjectId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetDbtJobsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get dbt jobs for project","tags":["IntegrationService"]}},"/api/v1/integrations/dbt/projects/{dbtProjectId}":{"get":{"operationId":"IntegrationService_GetDbtProject","parameters":[{"in":"path","name":"dbtProjectId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDbtProject"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get single dbt project","tags":["IntegrationService"]}},"/api/v1/integrations/{integrationId}/entities":{"get":{"operationId":"IntegrationService_GetEntitiesForIntegration","parameters":[{"in":"path","name":"integrationId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetIntegrationEntitiesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get entities for integration","tags":["IntegrationService"]}},"/api/v1/integrations/{integrationId}":{"delete":{"operationId":"IntegrationService_DeleteIntegration","parameters":[{"in":"path","name":"integrationId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Delete integration","tags":["IntegrationService"]},"get":{"operationId":"IntegrationService_GetIntegration","parameters":[{"in":"path","name":"integrationId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedIntegration"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get single integration","tags":["IntegrationService"]},"put":{"operationId":"IntegrationService_UpdateIntegration","parameters":[{"in":"path","name":"integrationId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"$ref":"#/components/requestBodies/generatedCreateOrUpdateIntegrationRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedIntegration"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Update integration","tags":["IntegrationService"]}},"/api/v1/integrations":{"get":{"operationId":"IntegrationService_GetIntegrations","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedIntegrationsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get integrations","tags":["IntegrationService"]},"post":{"operationId":"IntegrationService_CreateIntegration","requestBody":{"$ref":"#/components/requestBodies/generatedCreateOrUpdateIntegrationRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedIntegration"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Create integration","tags":["IntegrationService"]}},"/api/v1/lineage/nodes":{"post":{"operationId":"LineageService_CreateDataNode","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedCreateDataNodeRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDataNode"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Create a custom node","tags":["LineageService"]}},"/api/v1/lineage/relationships":{"post":{"operationId":"LineageService_CreateLineageRelationship","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedCreateLineageRelationshipRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedLineageRelationship"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Create a custom edge between two nodes","tags":["LineageService"]}},"/api/v1/lineage/nodes/{dataNodeId}":{"delete":{"operationId":"LineageService_DeleteDataNode","parameters":[{"in":"path","name":"dataNodeId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Delete a node by ID","tags":["LineageService"]},"get":{"operationId":"LineageService_GetDataNode","parameters":[{"in":"path","name":"dataNodeId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDataNode"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get a node by ID","tags":["LineageService"]}},"/api/v1/lineage/nodes/{dataNodeId}/downstream/fetch":{"post":{"operationId":"LineageService_GetDownstreamDataNodes","parameters":[{"in":"path","name":"dataNodeId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetDownstreamDataNodesRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetDownstreamDataNodesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get downstream nodes for a given node","tags":["LineageService"]}},"/api/v1/lineage/relationships/{lineageRelationshipId}":{"delete":{"operationId":"LineageService_DeleteLineageRelationship","parameters":[{"in":"path","name":"lineageRelationshipId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Delete an edge by ID","tags":["LineageService"]},"get":{"operationId":"LineageService_GetLineageRelationship","parameters":[{"in":"path","name":"lineageRelationshipId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedLineageRelationship"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get an edge by ID","tags":["LineageService"]}},"/api/v1/lineage/nodes/{dataNodeId}/relationships":{"delete":{"operationId":"LineageService_DeleteLineageRelationshipsForNode","parameters":[{"in":"path","name":"dataNodeId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDeleteLineageRelationshipsForNodeResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Delete all edges for a node","tags":["LineageService"]},"get":{"operationId":"LineageService_GetLineageRelationshipsForNode","parameters":[{"in":"path","name":"dataNodeId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetLineageRelationshipsForNodeResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get all edges for a node","tags":["LineageService"]}},"/api/v1/lineage/integrations/{integrationId}/lineage/workflow":{"post":{"operationId":"LineageService_QueueLineageForIntegration","parameters":[{"in":"path","name":"integrationId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedWorkflowResponse"}}}},"default":{"description":"An unexpec

# --- truncated at 32 KB (205 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bigeye/refs/heads/main/openapi/bigeye-metadata-openapi.json
Where this information came from

This is an independent, third-party profile of Bigeye Metadata API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.