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 Service Instance API

The DB Service Instance API from Tessell — 4 operation(s) for db service instance.

Tessell DB Service Instance 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 Service Instance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 5 operations across 4 paths, and defines 48 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

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

5 operations 4 paths 48 schemas 1 DELETE2 GET1 PATCH1 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 Service Instance API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 5

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

DB Service Instance 5
GET
/services/{id}/service-instances
View a list of available DB Service instances
getTessellServiceInstances 6 params → 200default
POST
/services/{service-id}/service-instances/{instance-id}/private-link
Create private link for instance
createPrivateLinkForInstance 3 params body → 200default
PATCH
/services/{service-id}/service-instances/{instance-id}/private-link/{id}
Update private link for instance
updatePrivateLinkForInstance 4 params body → 200default
DELETE
/services/{service-id}/service-instances/{instance-id}/private-link/{id}
Delete private link for instance
deletePrivateLinkForInstance 4 params → 200default
GET
/services/{service-id}/service-instances/{id}
Get a DB Service instance by Id
getTessellServiceInstance 4 params → 200default

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are TessellServiceInstanceDTO (43 properties), InstanceAzureNetAppConfig (10 properties), ApiErrorOps (8 properties), ApiError (7 properties). Each schema is shown below with its type and property counts.

TessellServiceInstanceRole
string
DB Service instance role
ServiceInstanceOracleEngineConfig
object
1 property
PrivateLinkPayload
object
The interface endpoint or Gateway Load Balancer endpoint to connect to your DB service.
2 properties
ApiError
object
Common error response object for non 2xx responses
7 properties
InstanceConnectivityUpdateRequest
object
1 property
PerfInsightsConfig
object
3 properties
AzureNetAppCapacityPoolServiceLevel
string
ParameterProfileStatus
string
Association status of the instance to the parameter profile
InstanceAccessMode
string
Service instance access mode
apiResponse
object
2 properties
apiPaginationInfo
object
2 properties
PrivateLinkStatus
string
Tessell Private Link Status
InstanceStorageConfig
object
4 properties
AwsInfraConfig
object
1 property
PerfInsightsStatus
string
Perf insights status of a Service Instance
ApiErrorOps
object
Common error response object for non 2xx responses of internal or ops APIs
8 properties
GcpInfraConfig
object
1 property
taskSummary
object
5 properties
TessellServiceInstanceConnectString
object
4 properties
InstanceExadataComputeConfig
object
6 properties 6 required
MonitoringConfig
object
1 property
ComputeProviderType
string
TessellResourceUpdateInfo
object
In progress update information for a Tessell Resource
4 properties
TessellServiceInstancesResponse
SecurityConfigOps
object
1 property
PrivateLinkInfo
object
4 properties
InstanceComputeConfig
object
2 properties
InstanceSyncMode
string
Service instance sync mode
OptionProfile
object
4 properties
apiMetadata
object
3 properties
ServiceInstanceEngineInfo
object
This field details the DB Service Instance engine configuration details like - access mode
1 property
AzureNetAppNetworkFeature
string
Azure NetApp network feature configuration for creating volume
AzureNetAppEncryptionKeySource
SecurityProfileInfoOps
object
3 properties
ParameterProfile
object
4 properties
TessellServiceInstanceType
string
DB Service instance type
TessellServiceInstanceStatus
string
DB Service instance status
TessellServiceInstanceSubStatus
string
DB Service Instance could have a sub status associated along with status
InstanceFsxNetAppConfig
object
5 properties
SecurityProfileSyncStatus
string
Sync status of the security profile applied on an instance/server
TessellExceptionUserView
object
3 properties
OptionProfileStatus
string
Association status of the instance to the option profile
AzureNetAppEncryptionKeyInfo
object
Details of encryption key
4 properties
InstanceAzureNetAppConfig
object
Service instance level Azure NetApp config
10 properties
TessellHTTPErrorCode
object
2 properties
TessellServiceInstanceContextInfo
object
Provide more context of Service Instance state
2 properties
StorageProviderType
Storage Type in the cloud
TessellServiceInstanceDTO
object
This is a definition of the DB Service Instance object
43 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tessell-db-service-instance-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