Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tessell DB Collection API

The DB Collection API from Tessell — 6 operation(s) for db collection.

Tessell DB Collection API is one of 82 APIs that Tessell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DB Collection. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 11 operations across 6 paths, and defines 28 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, {server}.

11 operations 6 paths 28 schemas 2 DELETE4 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.console.tessell.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Tessell DB Collection API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 2 DELETE, 4 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

DB Collection 11
GET
/services/{service-id}/databases/{database-id}/collections
Get all collections for the given database-id
getDbCollections 7 params → 200default
POST
/services/{service-id}/databases/{database-id}/collections
Create a collection for given database ID
createDbCollection 3 params body → 200default
GET
/services/{service-id}/databases/{database-id}/collections/{collection-id}
Get all collections for given database ID
getDbCollectionById 4 params → 200default
PATCH
/services/{service-id}/databases/{database-id}/collections/{collection-id}
Update collection for given collection ID
updateDbCollection 4 params body → 200default
DELETE
/services/{service-id}/databases/{database-id}/collections/{collection-id}
Delete collection for given collection ID
deleteDbCollection 4 params body → 200default
POST
/services/{service-id}/databases/{database-id}/collections/{collection-id}/load
Load collection into memory for given collection ID
loadDbCollection 4 params body → 200default
POST
/services/{service-id}/databases/{database-id}/collections/{collection-id}/release
Release collection from memory for given collection name
releaseDbCollection 4 params body → 200default
GET
/services/{service-id}/databases/{database-id}/collections/{collection-id}/indices
Get all indices for the given collection ID
getDbCollectionIndices 8 params → 200201default
POST
/services/{service-id}/databases/{database-id}/collections/{collection-id}/indices
Create a index for given collection ID
createDbCollectionIndex 4 params body → 200default
GET
/services/{service-id}/databases/{database-id}/collections/{collection-id}/indices/{index-id}
Get index for the given index ID
getDbCollectionIndexById 5 params → 200201default
DELETE
/services/{service-id}/databases/{database-id}/collections/{collection-id}/indices/{index-id}
Delete collection for given collection name
deleteDbCollectionIndex 5 params body → 200default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are MilvusCollectionField (12 properties), MilvusCreateCollectionField (10 properties), DbCollectionDTO (9 properties), DbCollectionIndexDTO (8 properties). Each schema is shown below with its type and property counts.

ApiError
object
Common error response object for non 2xx responses
7 properties
MilvusIndexMetricType
string
apiResponse
object
2 properties
apiPaginationInfo
object
2 properties
IndexSpecification
object
3 properties
DbCollectionStatus
string
DbCollectionIndexStatus
string
The status of the DB collection index
DbCollectionsResponse
MilvusIndexConfig
object
1 property
DeleteDbCollectionIndexPayload
object
1 property
taskSummary
object
5 properties
MilvusIndexParameters
object
4 properties
MilvusCreateCollectionConfig
object
4 properties
MilvusCollectionConfig
object
3 properties
DbCollectionDTO
object
Db collection
9 properties
MilvusIndexType
string
apiMetadata
object
3 properties
DbCollectionCreatePayload
object
2 properties
DbCollectionIndexPayload
object
3 properties
MilvusCollectionField
object
12 properties
LoadCollectionPayload
object
1 property
DeleteDbCollectionPayload
object
1 property
DbCollectionIndexDTO
object
8 properties
databaseEngineType
string
Database Engine Type
DbCollectionsIndexResponse
DbCollectionConfig
object
1 property
MilvusCreateCollectionField
object
10 properties
MilvusDatatype
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tessell-db-collection-api-openapi.yml Raw ↑

Other APIs Tessell publishes across the network.

Tessell activity-center API
Tessell Ad Domain API
Tessell Ad Domain Governance API
Tessell agentController API
Tessell alert-controller API
Tessell Authorization API
Tessell Availability Machine API
Tessell azure-netapp-admin-controller API
Tessell azure-netapp-service-controller API
Tessell cloud-resource API
Tessell Compute API
Tessell Compute Governance API