Jump to Content
Home
Guides
API Reference
Changelog
API Reference
Home
Guides
API Reference
Changelog
Get credentials for a DB Service database
All
Pages
Start typing to search…
JUMP TO
Tessell APIs
Authorization
/iam/authorize
post
/iam/api-keys
post
Get a list of Tessell Permission
get
Delete a Tessell api key
del
DB Service
View list of available DB Services
get
Provision a DB service
post
Get a DB Service by Id
get
Update a DB service
patch
Delete a DB service
del
Add DB service Instances
post
Delete DB service Instances
del
Starts the DB Service
patch
Stops the DB Service
patch
Resize DB service storage/compute
patch
Update DB Service Connectivity
patch
Get credentials for a DB Service
get
Update DB service credentials
patch
Switchover a DB Service
patch
Restore a DB Service
post
Patches the DB Service Software
patch
Update parameter profile/s for instances in service
patch
Add/update an integration for the DB Service
patch
Get a DB timeline by service ID
get
Cleanup a failed DB service entry
del
Clone a DB service
post
View tags for the DB Service
get
Create/update (override) tags for the DB Service
patch
Delete tags for a DB Service
del
Update DB service timezone
patch
Impact assessment for update parameter profile request
post
validate the parameter profile.
post
DB Service Instance
View a list of available DB Service instances
get
Create private link for instance
post
Update private link for instance
patch
Delete private link for instance
del
Get a DB Service instance by Id
get
Database
Create a new database in a DB service
post
Update a database
patch
Delete a database
del
Get credentials for a DB Service database
get
Update DB service Database credentials
patch
Starts a database in the DB Service
patch
Stops a database in the DB Service
patch
DB Collection
Get all collections for the given database-id
get
Create a collection for given database ID
post
Get all collections for given database ID
get
Update collection for given collection ID
patch
Delete collection for given collection ID
del
Load collection into memory for given collection ID
post
Release collection from memory for given collection name
post
Get all indices for the given collection ID
get
Create a index for given collection ID
post
Get index for the given index ID
get
Delete collection for given collection name
del
DB Service Schedule
Creates the deletion schedule for the DB Service
post
Updates the deletion schedule for the DB Service
patch
Returns the deletion schedule details for the DB Service
get
Deletes the deletion schedule for the DB Service
del
Returns the details about all the automated schedules on the DB Service
get
Creates a start/stop schedule for the DB Service
post
Get the details of start/stop schedules for the DB Service
get
Update the status of the given start/stop schedule for the DB Service.
patch
Updates the deletion schedule for the DB Service
patch
Returns the deletion schedule details for the DB Service
get
Deletes the deletion schedule for the DB Service
del
Updates the given start/stop schedule on the DB Service
patch
Return the details about the start/stop schedule for given schedule ID for the DB Service
get
Deletes the given start/stop schedule for the DB Service.
del
Compute Resource
View a list of available Compute Resources
get
Get a Compute Resource by ID
get
Delete a Database Server
del
Update a DB server
patch
View a list of available Compute Resources that can be used for newer provisioning
get
Enable compute resource sharing
patch
Update compute resource owner
patch
Update owner for all compute resources of a given owner
patch
Get a Compute Resource by ID
get
Resize a Database Server Compute Resource
patch
Starts Database Server Compute Resource
patch
Stops the DB Service
patch
Patch request for compute resource maintenance window
patch
View tags for the DB Server
get
Create/update (override) tags for the DB Server
patch
Delete tags for a DB Server
del
Add/update an integration for the Compute Resource
patch
DB Service ACL
Create or update the DB Service ACLs
patch
Revoke DB Service ACLs
del
Get list of all the users by privileges for the given DB Service
get
DB Connection Pool
Get list of connection pools for the DB Service
get
Creates a new connection pool for the DB Service
post
Delete an existing connection pool for the DB Service
del
Update an existing connection pool for the DB Service
patch
Sample Dataset
Returns details about sample datasets that can be loaded in the given DB Service
get
Controls if the sample data loading suggestions should be shown for the given DB Service
patch
Get details about existing sample datasets being/already loaded in the given DB Service
get
Submits a request to load sample-dataset in given DB Service.
post
Availability Machine
Get a list of Availability Machines
get
Get details about an Availability Machine
get
Delete the Availability Machine and the associated data (if any) including snapshots, sanitized-snapshots, and backups.
del
Pause the automated backups for a Availability Machine
patch
Allow backup download for a Availability Machine
patch
Resume the automated backups for a Availability Machine
patch
Get list of ACLs for an Availability Machine
get
Create or update ACLs for an Availability Machine
patch
Revoke ACLs for an Availability Machine
del
Get list of users which are eligible to grant access for an Availability Machine
get
Get download url info for the backup
get
Get list of all the users by privileges
get
Get size consumption details for Tessell Data Management Machine
get
dataflix-controller
Get a list of accessible Dataflix
get
Get Dataflix by AM id
get
Get snapshots and pitr catalog of the Availability Machine
get
Get sanitised snapshots catalog for the Availability Machine
get
Get native backups catalog for the Availability Machine
get
Snapshot and Backup
Get list of snapshots for an Availability Machine
get
Submit a request to capture the associated DB Service's snapshot
post
Get details about the specified snapshot
get
Submit a request to delete the snapshot
del
Create download url for the backup
post
Get the restore or clone information for the specified snapshot or the recovery-timestamp
get
View a list of available Tessell Backups
get
Create backup for the snapshot
post
get backup
get
Submit a request to delete the backup
del
Get list of sanitized snapshots for an Availability Machine
get
Submit a request to sanitize the specified snapshot
post
Get details about the specified Sanitized Snapshot
get
Submit a request to delete the Sanitized Snapshot
del
SLA Policy
Get the RPO policy configuration associated with an Availability Machine
get
Update RPO policy configuration for an Availability Machine
patch
Data Access Policy
Get list of Access Policies (DAP) that are associated with an Availability Machine
get
Create a new Access Policy for an Availability Machine
post
Get details about an Access Policy
get
Delete an Access Policy
del
Update an Access Policy
patch
View details about a Tessell Dap Catalog
get
Update users of an Access Policy
patch
Data Sanitization
Data Script
Get a list of Scripts
get
Request to create a new Script
post
Get information about a Script
get
Update the specified Script
patch
Delete the specified Script
del
Update the Script's maturity status
patch
Get Tessell Script versions
get
Create a new Tessell Script Version
post
Get Tessell Script versions
get
Delete a new Tessell Script Version
del
Download Tessell Script Content
get
Upload Tessell Script Version blob
post
Get list of ACLs for the Script
get
Create/update the Script ACLs
patch
Revoke Script ACLs
del
Get list of all the users by privileges
get
Personas
Get a list of Personas
get
Create a new Persona
post
Get upgradable list of Personas for all the Personas
get
Delete a Persona
del
Update a Persona
patch
Privileges
Create a privilege
post
Delete a privilege
del
Update a privilege
patch
Users
Get list of all the users
get
Create for a new user
post
Accept invite
post
Change current user's password
post
Forcefully reset password for a user
post
Login a user
post
Acquire new access-token using refresh-token
post
Logout a user
post
Forgot Password
post
Reset password for a user
post
Reset password for a user when password has been expired
post
Get details of a user
get
Delete a user
del
Update a user
patch
Update self profile
patch
Change status of a user
post
/iam/users/session/mfa/verify
post
/iam/users/session/mfa/resend
post
Userpool
Get list of all the userpools
get
Create for a new userpool
post
Delete a userpool
del
Update a userpool
patch
Roles
Get a list of Roles
get
SSO
/iam/sso
get
Identity Providers
Create a new integration with an Identity Provider
post
Get a list of integrated Identity Providers
get
Update an Identity Provider
put
Delete an Identity Provider integration
del
DB Service Benchmark
Fetch list of supported benchmarks (catalog)
get
Fetch benchmark catalog entry by id
get
Fetch list of current benchmarks
get
Create new benchmark request
post
Fetch benchmark by id
get
Subscription
Returns details about the Tessell Subscriptions
get
Create a new Tessell subscription.
post
Returns details about the Tessell Subscriptions
get
Submits request to get the subscription details
get
Submits request to update a Tessell Subscription
patch
Submits request to delete a Tessell Subscription
del
Submits request to enable or disable a Tessell Subscription
patch
Adds cloud type to a new Tessell subscription
post
Enables or disables a cloud type in a Tessell Subscription
patch
Update regions for a cloud type in a Tessell Subscription
put
Add regions for a cloud type in a Tessell Subscription
put
Adds users to a Tessell subscription
patch
Removes users from a Tessell subscription
del
Get subscription's users' details
get
Get users which can be added to the subscription
get
/subscription-service/governance/subscription-metadata/byoa
get
Track the progress of the ongoing subscription creation operation
get
Track the progress of the ongoing region onboarding operation
get
Resubmits failed Tessell Subscription creation
put
Resubmits failed region onboarding
put
Skip a particular step in the subscription creation flow
put
Skip a particular step in the region onboarding flow
put
Generate a script to register any compute resource with tessell
get
Register a compute resource after executing the script
post
Returns the list of user resources under a Tessell Subscription
get
Track the progress of the ongoing subscription deletion operation
get
Encryption Key
Get a list of Tessell Encryption keys
get
Get a list of eligible Tessell Encryption keys
get
Get a list of eligible Tessell Encryption keys
get
Creates new encryption key
post
Get a list of Tessell Encryption keys
get
Disable Encryption Key
patch
Enables Encryption Key
patch
/encryption-keys/register
post
Creates/updates encryption key acls
patch
Revokes encryption key acls
del
Get list of all the users by privileges
get
Upload encryption key file blob
post
Password Policy
Update Tenant Password Policies
patch
Get Tenant Password Policies
get
Notification
Get notification count
get
Acknowledge notifications
post
Get notifications summary
get
Returns the events for the user
get
VPC
Get a list of VPCs
get
Get VPC by Name
get
Get Default VPC Configuration
get
VPC Governance
Get a list of VPCs as an administrator
get
Create a VPC
post
Get VPC as an administrator by Name
get
Delete a VPC
del
Register VPC from a BYOA subscription
post
Get ACL (Access Control List) of a VPC
get
Modify ACL (Access Control List) of a VPC
patch
Delete ACL (Access Control List) of a VPC
del
Get a list of Users with allowed accesses for a VPC
get
Apply action on a VPC
patch
Get a list of Subnets of a VPC
get
List VPCs from a BYOA Subscription to register in Tessell
post
Get VPC and it's Subnets from a BYOA Subscription registered in Tessell
post
Track the progress of the ongoing VPC registration operation
get
Skip a particular step in the VPC registration flow
put
Resubmit failed VPC registration
put
Edit registered subnets of a VPC from a BYOA subscription
patch
List VPC Endpoints from a BYOA Subscription to register in Tessell
post
List Security Groups from a BYOA Subscription
post
List Route Tables from a BYOA Subscription
post
List Private Link Scopes from a BYOA Subscription
post
VPC Peering Governance
Get a list of VPC Peerings of a VPC
get
Create a Peering between VPCs
post
Get VPC Peering by Name for a given VPC
get
Delete Vpc Peering
del
Create a VPC Peering using AWS Cloudformation
post
Get Cloudformation URL for VPC Peering
get
Genie
Enable Genie for a specific database system
post
Disable Genie for a specific database system
post
Request access to VMs of a specific ÐB_SERVICE
get
Request access to VMs of a specific ÐB_SERVICE
post
get genie config for a tenant
get
Extend Genie expiry time
patch
Get status for a specific Genie request
get
Downloads connection details
get
Service Plan
Get a list of Tessell Service Plans
get
Tessell App
Get a list of Tessell App
get
tessell-cloud-controller
Get a list of enabled clouds in Tessell
get
Add a cloud in Tessell
post
Software Library
Get a list of all software images. Using the name filter, a software image can be found using name.
get
Get Software Image by name
get
Software Library Governance
Disable Software Images
patch
Enable Software Images
patch
Restrict Software Images to certain regions
patch
Restrict Software Images access to set of Personas
patch
List Software Images (including disabled ones)
get
Get Details of Patchable Software Image Version identified by ImageId and VersionId.
get
Ad Domain
Returns all Ad Domain available.
get
Returns an ad domain.
get
Ad Domain Governance
Integration Governance
Get a list of supported Integration Types
get
Get Integration Type by Id
get
Get a list of active Integrations (consumer view)
get
Get active Integration by Id (consumer view)
get
Create a new Integration
post
Get a list of active Integrations
get
Get active Integration Details by Id
get
Delete an Integration
del
Update an Integration
patch
Create/Update ACLs of an Integration
patch
Revoke access of given users on an Integration
del
Get a list of all users along with role they are eligible on an Integration
get
Compute
Get a list of Compute Profiles.
get
Get all available vcpus, even if some are disabled for an user
get
Compute Governance
Get all compute profiles.
get
Enable/Disable compute profile
patch
Update compute regions
patch
Parameter Profile
Get a list of supported Database Parameters for all Database Engines with default configuration
get
Create a new Parameter Profile
post
Get a list of Parameter Profiles
get
Get a parameter profile by Id
get
Delete a Parameter Profile
del
Update a Parameter Profile
patch
Compare two Parameter Profile configuration
get
Copy Parameters of one Parameter Profile to other Parameter Profiles
patch
Reset Parameters of Parameter Profile to its default values
post
Get a list of available Parameter Profiles
get
Check if Parameter Profile is deletable or not
get
View available Database Parameter Profiles by Id
get
Provide Services/Instances that are using the Parameter Profile
get
DB Profile
Get a list of available Tessell Database Options Profile Types
get
Get Options Profile Types by name
get
Create a new Options Profile
post
Get a list of available Database Options Profiles
get
Get an Options Profile by name
get
Get a list of available Tessell Database Options Profiles
get
Get an Options Profile by name
get
Delete an Options Profile
del
Update an Options Profile
patch
DB Profile ACLs
Create/Update ACLs of a Parameter Profile
patch
Revoke access of given users from a Parameter Profile
del
Create/Update ACLs of an Options Profile
patch
Revoke access of given users from an Options Profile
del
Get a list of all users along with role they are eligible on a Parameter Profile
get
Get a list of all users along with role they are eligible on an Options Profile
get
Update Options Profile's Maturity Status
patch
Update Parameter Profile's Maturity Status
patch
Ticket
Get tickets
get
Create ticket
post
Get ticket by id
get
Update ticket
put
Open/Close a ticket
put
Update watchers list for a ticket
patch
Conversation
ticket's conversation
get
Post ticket reply
post
Post ticket notes
post
agentController
Get agent list
get
Get agent by id
get
Logs
/logs/download
get
/logs/stream
get
/logs/task/{taskId}
get
/logs/workflow/{workflowId}
get
/logs/resources/logfiles
get
/logs/resources/i/logfiles
get
/logs/resources/i/loggroup
post
/logs/service/{service-id}/script/download
get
/logs/resources/logfiles/cloud-info
get
/logs/resources/i/loggroups/{logGroupName}/service-instance-info
get
/logs/resources/aws/loggroup/i/update-retention
patch
Monitoring
/monitoring/metrics/avg-db-load
post
/monitoring/metrics/top-dimensions
post
/monitoring/metrics/extended-perf-metrics
post
/monitoring/metrics/top-processes
get
/monitoring/metrics
get
/monitoring/compute-resources/summary
get
/monitoring/service/{id}/features/{feature-name}
get
/monitoring/service/{id}/features/{feature-name}
patch
/monitoring/infra
post
/monitoring/infras
get
/monitoring/infra/{id}
get
/monitoring/infra/{id}
del
/monitoring/infra/{id}/active-db-services
get
/monitoring/deployments/{deployment-id}
get
License Governance
Returns a list detail of licenses from directory.
get
Register license into license pool
post
Deletes an existing license from directory.
del
Event
Reads event for the current user.
get
Suppress an event type
patch
Unsuppress a previous suppressed event.
patch
Payment
View a list of Tessell Invoices
get
Get Invoice By Id
get
Create a payment option update request
post
Update payment option
patch
Cancel payment option request
del
Get default payment option
get
Metering
infra-deployment
Get regions
get
maintenance-window
Get maintenance windows for given service
get
Update maintenance window config for given service
patch
Get maintenance window by Id
get
Update maintenance window
patch
Trigger maintenance window
post
Apply Maintenance Window Task
post
Remove task from existing maintenance window
del
service-refresh-controller
Refresh service with parent service's snapshot or pitr.
patch
Fetch all the refresh schedules for a service
get
Create refresh schedule for a service
post
Update the refresh schedule
patch
Delete the refresh schedule
del
Update the refresh schedule status
patch
cloud-resource
Get details of outbound access requests from the vpc / vnet
get
Allow private cp dp endpoints
post
Get details of control plane endpoint services
get
EncryptionKeysAdminView
Validate encryption key permissions for a key
post
Get the encryption key policy
get
List Encryption Keys from a BYOA Subscription to register in Tessell
get
Register Encryption Key from a BYOA Subscription
post
tessell-notification-profile-controller
Create a Notification Profile
post
Get Notification Profiles
get
Get Notification Profile by ID
get
Update a Notification Profile Info by Id
patch
Delete Notification Profile corresponding to given id
del
Add a Notification Profile Destination
post
Add a Notification Profile Destination
put
Delete a Destination corresponding to given channelId (destId)
del
storage-controller
fsx-netapp-service-controller
Get FSx NetApp(s) available for Provisioning DB services
get
fsx-netapp-admin-controller
Get FSx NetApp(s) registered with Tessell
get
Get the FSx NetApp policy to enable access of resouces from aws
get
Get FSx NetApp registered with Tessell
get
Update creds of FSx NetApp
patch
Sync details of FSx NetApp with cloud
post
Discover FSx NetApps
post
Register FSx NetApp if not already registered
post
De-Register FSx NetApp
del
Discover Storage Virtual Machine(s) for a FSx NetApp
post
Register FSx NetApp Storage Virtual Machine if not already registered
post
De-Register FSx NetApp Storage Virtual Machine
del
/storages/governance/fsx-netapp/{fsx-id}/metrics
get
/storages/governance/fsx-netapp/{fsx-id}/volumes/{volume-id}/metrics
get
alert-controller
Create Alert Profile
post
Get a list of alert Profiles
get
Get Alert Profile by Id
get
Update a Alert Profile by Id
put
Delete Alert Profile corresponding to given id
del
Create Alert Entity
post
Get Alert Entities
get
Get Alert entity
get
Update a Alert Entity by Id
patch
Delete Alert Entity corresponding to given id
del
Get Alert Policies
get
Create Alert Policy
post
Get Alert Policy by Id
get
Update a Alert Policy by Id
put
Delete Alert Policy corresponding to given id
del
Get Alert Policy Associations
get
Create or Update Alert Policy Associations by Subscription Id
put
Delete Alert Policy Associations by Subscription Id
del
Get Alert Policy Association Details
get
Get Alert Rules Configuration
get
Get Alert Annotations Catalog
get
activity-center
Return all activities to the user
get
Provides ability to marks one/all notifications as read/notified for the current logged-in user
patch
rpo-policy
Get a list of RPO policies
get
Get details about a RPO policy
get
Get a list of custom RPO policies
get
Create a new custom RPO policy
post
Get details of a custom RPO policy
get
Update a custom RPO policy
patch
Delete a RPO policy
del
Update RPO Policy maturity status
patch
Get details of Availability Machines which are using the RPO policy
get
azure-netapp-admin-controller
Discover Azure NetApp Accounts(s)
post
Discover Capacity Pools(s) for a Azure NetApp
post
Register Azure NetApp if not already registered
post
Register Azure NetApp Capacity Pools if not already registered
post
De-Register Azure NetApp
del
De-Register Azure NetApp
del
Get the Azure NetApp policy to enable access of resources from azure
get
Get Azure NetApp(s) registered with Tessell
get
Get Azure NetApp registered with Tessell
get
Get the Azure NetApp Quotas for a region
get
Sync details of Azure NetApp with cloud
post
azure-netapp-service-controller
Get Azure NetApp(s) available for Provisioning DB services
get
exadata-infrastructure
/infrastructures/exadata/infrastructures/discovery
get
/infrastructures/exadata/infrastructures/{id}/vm-clusters/discovery
get
/infrastructures/exadata/infrastructures
get
/infrastructures/exadata/infrastructures/{id}
get
/infrastructures/exadata/infrastructures/{id}
del
/infrastructures/exadata/infrastructures/{id}/vm-clusters
get
/infrastructures/exadata/infrastructures/{id}/vm-clusters/{cluster-id}
get
/infrastructures/exadata/infrastructures/{id}/vm-clusters/{cluster-id}
del
/infrastructures/exadata/infrastructures/register
post
/infrastructures/exadata/infrastructures/{id}/sync
post
/infrastructures/exadata/infrastructures/{id}/vm-clusters/register
post
/infrastructures/exadata/vm-clusters/{id}/metrics
get
tessell-service-option-profile
Update the option profiles for a service
patch
get the status of option profile for a given service
get
tessell-compute-resource-acl-controller
Create or update the DB Server ACLs
patch
Revoke DB Server Acls
del
Get eligible users for a DB Server
get
Get eligible users for DB Servers
post
Bulk share multiple DB Servers with multiple users, does not override the existing ACL if present
patch
db-schema-controller
Get DB schema for a service
get
data-pipeline
/data-pipelines
get
/data-pipelines
post
/data-pipelines/{id}
get
/data-pipelines/{id}
del
/data-pipelines/{id}/resume
patch
/data-pipelines/{id}/pause
patch
/data-pipelines/{id}/db-services/{dp-db-service-id}/db-schema
get
/data-pipelines/{id}/db-services/{dp-db-service-id}
del
/data-pipelines/{id}/db-services/{dp-db-service-id}/resume
patch
/data-pipelines/{id}/db-services/{dp-db-service-id}/pause
patch
/data-pipelines/db-services/{service-id}/publish-data
post
Track the progress of the ongoing data pipeline creation operation
get
Track the progress of the ongoing data pipeline DB service operation
get
Returns the metrics data for Azure Event Hub Namespace
get
Returns the list of eligible DB services for the Data Pipeline
get
Returns the list of eligible Data Pipelines for the DB Service
get
tessell-notification-channel-controller
Create Notification Channels
post
/governance/notification-channels
get
/governance/notification-channels/{id}
get
/governance/notification-channels/{id}
del
/governance/notification-channels/{id}
patch
tessellGatewayServiceController
Get the status of tessell agent
get
Data Sanitization
Get list of Sanitization Schedules that are associated with an Availability Machine
get
Create a new Sanitization Schedule for an Availability Machine
post
Get details about a Sanitization Schedule
get
Submit a request to delete the Sanitization Schedule
del
Update a Sanitization `Schedule`
patch
Ad Domain Governance
Get List of Active Directory Domain
get
Register an Active Directory Domain
post
Reconfigure an Active Directory Domain
patch
Deregister an Active Directory Domain
del
ticketControllerDeprecated
Get tickets
get
Create ticket
post
Get ticket by id
get
Update ticket
put
Open/Close a ticket
put
Update watchers list for a ticket
patch
Get global watchers list
get
Create global watchers list
post
Update global watchers list
put
conversationControllerDeprecated
ticket's conversation
get
Post ticket notes
post
Add attachment
post
Metering
/billing/meters
get
/billing/bills
post
/billing/bills
get
/billing/rates
get
/billing/credits
get
/billing/credits/{id}
get
/billing/summary
get
/billing/profile
get
/billing/profile
patch
/billing/cost-till-date
get
Powered by
Get credentials for a DB Service database
get
https://{server}/services/database/
{id}
/creds
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
https://
console.tessell.com
/services/database/{id}/creds
Response
Click
Try It!
to start a request and see the response here!
