Back to All

2021 Archive

11 months ago by ReadMe API

An archive of changes made to the Data Bridge API in 2021.

Data Bridge, May 2021

The May 2021 release adds support for two methods of authentication: API keys and security tokens.

  • The API key identifies a client application that is entitled to call the API. The API key provides for long-term access to the tenant’s Data Bridge instance.
  • The security token identifies a user —a specific user account— that is entitled to call the API. The token provides for temporary access to the tenant’s Data Bridge instance.

RMS recommends that you use API keys to manage Data Bridge client authentication. API keys enable the RMS Authentication service to authenticate the client and determine the caller’s access rights based on group membership. Tenants using federated single sign-on must use API keys for client authentication. To learn more about authentication using the RMS Authentication Service, see Authentication Guide.

Data Bridge, May 2021

The first release Data Bridge APIs define services for administering access to Data Bridge and for importing and exporting databases from and to database artifacts.

Cluster API

The Data Bridge Cluster API defines services for managing the access control lists (ACLs) that define which IP addresses can access Data Bridge. For details, see Administer Data Bridge ACLs.

  • The GET /v1/Cluster service and GET /v1/Cluster/allowed-ips service enable users to view information about the tenant’s Data Bridge access control list.
  • The PUT /v1/Cluster/allowed-ips service enables Data Bridge Administrators to create or overwrite the tenant’s Data Bridge access control list.
  • The PATCH /v1/Cluster/allowed-ips service enables Data Bridge Administrators to create or overwrite the tenant’s Data Bridge access control list.
  • The DELETE /v1/Cluster/allowed-ips/{ipAddress} and DELETE /v1/Cluster/allowed-ips/{ipAddress}/subnetMask enables administrators to delete the tenant’s Data Bridge access control list.

Databases API

The Data Bridge Databases API defines services for importing and exporting databases to and from database artifacts.

  • The GET /v1/sql-instances/{instanceName}/databases service returns a list of the databases on a managed SQL Server instance.
  • The GET /v1/sql-instances/{instanceName}/databases/{databaseName}/import service returns the URI of the tenants S3 for importing database artifacts.
  • The POST /v1/sql-instances/{instanceName}/databases/{databaseName}/import service enables licensed users assigned the Data Bridge Contributor role to import databases into managed SQL Server instances from BAK, MDF, and DACPAC artifacts. For details, see Import Databases.
  • The POST /v1/sql-instances/{instanceName}/databases/{databaseName}/export service enables licensed users assigned the Data Bridge Contributor or Data Bridge Consumer roles to export databases from managed SQL instances as BAK, MDF, or DACPAC artifacts. For details, see Export Databases.
  • The DELETE /v1/sql-instances/{instanceName}/databases/{databaseName} service enables administrators to delete databases from managed SQL Server instances.

Jobs API

The GET /v1/Jobs/{jobId} service enables users to view the status of import and export jobs initiated on the Risk Intelligence workflow engine.

Logins API

The Logins API defines services that enable users to administer Data Bridge logins. A Data Bridge login defines the operations that a licensed user can perform on a managed SQL Server instance. To learn more, see Administering Data Bridge logins.

  • The GET /v1/sql-instances/{instanceName}/logins service enables users to view a list of the logins to a managed SQL Server instance.
  • The POST /v1/sql-instances/{instanceName}/logins service enables users to create logins to a managed SQL Server instance.
  • The PATCH /v1/sql-instances/{instanceName}/logins/{loginName} service enables users to edit logins to a managed SQL Server instance.
  • The DELETE /v1/sql-instances/{instanceName}/logins/{loginName} service enables Risk Intelligence Administrators and Data Bridge Administrators to delete logins to a managed SQL Server instance.

My IP API

  • The GET /v1/MyIP service enables users to view the IP address that their computer is using to access Data Bridge.

SQL Instances API

The SQL Instances API defines services for retrieving information about managed SQL Server instances on Data Bridge.

  • The GET /v1/sql-instances service returns a list of managed SQL Server instances.
  • The GET /v1/sql-instances/{instanceName} service returns detailed information about a specific managed SQL Server instance.