{"openapi":"3.0.1","info":{"title":"Data Bridge","description":"This document describes information on the Data Bridge API.","version":"2026.07.c"},"x-readme":{"explorer-enabled":false,"samples-languages":["curl","java","csharp","node","python"],"proxy-enabled":true,"samples-enabled":true},"servers":[{"url":"https://{host}/databridge","description":"Intelligent Risk Platform","variables":{"host":{"enum":["api-euw1.rms.com","api-use1.rms.com"],"default":"api-euw1.rms.com","description":"Data center that hosts the tenant instance: api-euw1.rms.com or\napi-use1.rms.com."}}}],"security":[{"RMS_Auth":[]}],"paths":{"/v1/sql-instances/{instanceName}/Archives":{"get":{"tags":["Archives"],"summary":"List archives by server instance","operationId":"getarchives","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}},{"name":"filter","description":"<<glossary:Query string>> to select response data base on property values.\n\n| Property        | Type   | Comparison                              | List | \n| --------------- | ------ | --------------------------------------- | ---- | \n  | `archiveId`     | String | `=`, `!=`, `>`, `<`, `>=`, `<=`         | `IN` | \n  | `name`          | String | `=`, `!=`, `>`, `<`, `>=`, `<=`, `LIKE` | `IN` | \n  | `sizeInMb`      | Number | `=`, `!=`, `>`, `<`, `>=`, `<=`         | `IN` | \n  | `createDate`    | Date   | `=`, `!=`, `>`, `<`, `>=`, `<=`         | `IN` | \n  | `expiryDate`    | Date   | `=`, `!=`, `>`, `<`, `>=`, `<=`         | `IN` | \n  | `createdBy`     | String | `=`, `!=`, `>`, `<`, `>=`, `<=`, `LIKE` | `IN` | \n  | `storageTypeId` | Number | `=`, `!=`, `>`, `<`, `>=`, `<=`         | `IN` |","in":"query","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending). This operation supports sorting response data based by the following property values: `archiveId`, `createDate`, `createdBy`, `expiryDate`, `name` , `serverName`, `sizeInMb` , and `storageTypeId`.","schema":{"type":"string","default":"createDate DESC"}},{"name":"limit","in":"query","description":"Numbe of records to return per page.","schema":{"maximum":5000,"minimum":1,"type":"integer","format":"int32","default":5000}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_.","schema":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchivesResponse"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchivesResponse"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchivesResponse"}}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/Archives/{archiveId}":{"get":{"tags":["Archives"],"summary":"Get archive","operationId":"getarchive","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}},{"name":"archiveId","description":"ID of archive.","example":74,"in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchivesDetail"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchivesDetail"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchivesDetail"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}},"delete":{"tags":["Archives"],"summary":"Delete archive","operationId":"deletearchive","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}},{"name":"archiveId","description":"ID of archive.","example":74,"in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well."},"204":{"description":"No content."},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/Archives/{archiveId}/restore":{"post":{"tags":["Archives"],"summary":"Restore database from archive","operationId":"restorearchive","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance. Archived database was originally on this server.","in":"path","required":true,"schema":{"type":"string"}},{"name":"archiveId","description":"ID of archive to be restored.","example":74,"in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.RestoreArchiveRequest"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.RestoreArchiveRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.RestoreArchiveRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.RestoreArchiveRequest"}}}},"responses":{"202":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ImportDatabaseResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ImportDatabaseResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ImportDatabaseResponse"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"409":{"description":"Conflict. The requested resource already exists."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/Cluster":{"get":{"tags":["Cluster"],"summary":"Get Data Bridge ACL","operationId":"getAcl","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Cluster"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Cluster"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Cluster"}}}}}}},"/v1/Cluster/allowed-ips":{"get":{"tags":["Cluster"],"summary":"Get IP addresses","operationId":"getipaddresses","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CidrEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CidrEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CidrEntry"}}}}}}},"put":{"tags":["Cluster"],"summary":"Update Data Bridge ACL","operationId":"updateacl","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.AddCidrRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.AddCidrRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.AddCidrRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.AddCidrRequest"}}}},"responses":{"200":{"description":"Success"}}},"patch":{"tags":["Cluster"],"summary":"Overwrite Data Bridge ACL","operationId":"overwriteacl","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.UpdateCidrRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.UpdateCidrRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.UpdateCidrRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.UpdateCidrRequest"}}}},"responses":{"200":{"description":"Success"}}}},"/v1/Cluster/allowed-ips/{ipAddress}":{"delete":{"tags":["Cluster"],"summary":"Delete IP address","operationId":"deleteipaddress","parameters":[{"name":"ipAddress","in":"path","description":"Removes this IP address from ACL.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}}}},"/v1/Cluster/allowed-ips/{cidrIpAddress}/{cidrIpPrefix}":{"delete":{"tags":["Cluster"],"summary":"Delete range of IP addresses","operationId":"deleteipaddresses","parameters":[{"name":"cidrIpAddress","description":"Range of IP addresses in binary notation.","in":"path","required":true,"schema":{"type":"string"}},{"name":"cidrIpPrefix","description":"CIDR prefix that specifies the number of bits in the network ID. By\ndefault, `32`.","in":"path","required":true,"schema":{"type":"string","default":"32"}}],"responses":{"200":{"description":"Success"}}}},"/v1/Cluster/server-security":{"put":{"tags":["Cluster"],"summary":"Set TLS protocol version","operationId":"settlsprotocolversion","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.SetClusterSecurityRequest"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.SetClusterSecurityRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.SetClusterSecurityRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.SetClusterSecurityRequest"}}}},"responses":{"200":{"description":"Success"}}},"get":{"tags":["Cluster"],"summary":"Get cluster security","operationId":"identifyencryptedconnection","responses":{"200":{"description":"Success"}}}},"/v1/sql-instances/{instanceName}/Databases":{"post":{"tags":["Databases"],"summary":"Create database","operationId":"createdatabase","parameters":[{"name":"instanceName","in":"path","description":"Name of managed SQL Server instance. The database is created on this\ninstance.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateDatabaseRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateDatabaseRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateDatabaseRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateDatabaseRequest"}}}},"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateDatabaseResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateDatabaseResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateDatabaseResponse"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}},"get":{"tags":["Databases"],"summary":"List databases","description":" ","operationId":"getdatabasesbyinstance","parameters":[{"name":"instanceName","in":"path","description":"Name of managed SQL Server instance.","required":true,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Property on which to sort records returned. Supported properties: `createdAt`, `databases`, `name`, `sizeInMb` \n\nSort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\n* `/databridge/v1/sql-instances/databridge-1/databases/?sort=sizeInMb+desc`\n* `/databridge/v1/sql-instances/databridge-1/databases/?sort=createdAt+desc`","schema":{"type":"string"}},{"name":"adminAccess","in":"query","description":"Flag to enable Data Bridge Admins to view all managed databases. Data returned depends on <<glossary:tenant security>> settings and client role.\n\n  - If `true`, Data Bridge Admin can view information about all databases. Consumer and Contributor have no access.\n  - If `false`,  roles can view information about accessible databases only. \n\n  If parameter is unspecified, a `value` of false is assumed.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Database"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Database"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Database"}}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/Databases/{databaseName}":{"get":{"tags":["Databases"],"summary":"Get database","operationId":"getdatabasebyinstance","parameters":[{"name":"instanceName","in":"path","description":"Name of managed SQL Server instance.","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Database"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Database"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Database"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}},"delete":{"tags":["Databases"],"summary":"Drop database","operationId":"deletedatabase","parameters":[{"name":"instanceName","in":"path","description":"Name of server instance that hosts database.","required":true,"schema":{"type":"string"}},{"name":"databaseName","in":"path","description":"Name of database.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well."},"204":{"description":"No content."},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}},"put":{"tags":["Databases"],"summary":"Pin database","operationId":"pindatabase","parameters":[{"name":"instanceName","in":"path","description":"Name of managed SQL Server instance.","required":true,"schema":{"type":"string"}},{"name":"databaseName","in":"path","description":"Name of database.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.PinOrUnpinRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.PinOrUnpinRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.PinOrUnpinRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.PinOrUnpinRequest"}}},"required":true},"responses":{"200":{"description":"OK. All went well."},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."}}},"patch":{"tags":["Databases"],"summary":"Update database security","operationId":"updateDatabaseGroup","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.GroupOperation"}}}}},"responses":{"204":{"description":"No content."},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/Databases/{databaseName}/archive":{"post":{"tags":["Databases"],"summary":"Archive database","description":" ","operationId":"archiveDatabase","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database.","in":"path","required":true,"schema":{"type":"string"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>.","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchiveRequest"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchiveRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchiveRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchiveRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchiveDatabaseResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchiveDatabaseResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchiveDatabaseResponse"}}}}}}},"/v1/sql-instances/{instanceName}/Databases/{databaseName}/archives/{archiveId}":{"patch":{"tags":["Databases"],"summary":"Update archive","operationId":"updateArchive","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database.","in":"path","required":true,"schema":{"type":"string"}},{"name":"archiveId","description":"ID of archive.","in":"path","example":74,"required":true,"schema":{"type":"string"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>.\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchivePatch"}},"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchivePatch"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchivePatch"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ArchivePatch"}}},"required":true},"responses":{"200":{"description":"OK. All went well."},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"403":{"description":"Forbidden. You do not have permission to access that resource."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/Databases/{databaseName}/export":{"post":{"tags":["Databases"],"summary":"Export database to URI","operationId":"exportdatabase","parameters":[{"name":"instanceName","in":"path","description":"Name of managed SQL Server instance.","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database.","in":"path","required":true,"schema":{"type":"string"}},{"name":"exportTo","description":"The file format of the exported database artifact. One of `0` (MDF),\n`1` (BAK), or `2` (DACPAC). By default, `0` (MDF).","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Enums.ExportToType"}},{"name":"detachOnly","description":"If undefined or `false`, database is backed up before it is\ndetatched. If `true`, database is taken offline for the duration of\nthe export job and not backed up. Must be `true`, if database is >\n100GB or error is returned. Valid only if `exportTo` is `0` (MDF).","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"202":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ExportDatabaseResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ExportDatabaseResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ExportDatabaseResponse"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"409":{"description":"Conflict. The requested resource already exists."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/Databases/{databaseName}/import":{"get":{"tags":["Databases"],"summary":"Get upload directory URI","operationId":"getuploaddirectoryuri","parameters":[{"name":"instanceName","in":"path","description":"Name of managed SQL Server instance.","required":true,"schema":{"type":"string"}},{"name":"databaseName","in":"path","description":"Name of database.","required":true,"schema":{"pattern":"^[_\\-a-zA-Z0-9]+$","type":"string"}},{"name":"importFrom","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Enums.ImportFromType"}}],"responses":{"200":{"description":"OK. All went well.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ImportDatabasePrepareResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ImportDatabasePrepareResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ImportDatabasePrepareResponse"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"409":{"description":"Conflict. The requested resource already exists."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}},"post":{"tags":["Databases"],"summary":"Import database from file","operationId":"importdatabase","parameters":[{"name":"instanceName","in":"path","description":"Name of managed SQL Server instance.","required":true,"schema":{"type":"string"}},{"name":"databaseName","in":"path","description":"Name of database.","required":true,"schema":{"type":"string"}},{"name":"importFrom","in":"query","schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Enums.ImportFromType"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ImportDatabaseRequest"}}}},"responses":{"202":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ImportDatabaseResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ImportDatabaseResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ImportDatabaseResponse"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"409":{"description":"Conflict. The requested resource already exists."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/Databases/{databaseName}/move":{"post":{"tags":["Databases"],"summary":"Move database","operationId":"movedatabase","description":" ","parameters":[{"name":"instanceName","in":"path","description":"Name of managed SQL Server instance.\n\nDatabase is moved from this server instance.","required":true,"schema":{"type":"string"}},{"name":"databaseName","in":"path","description":"Name of database to move.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.MoveDatabaseRequest"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.MoveDatabaseRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.MoveDatabaseRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.MoveDatabaseRequest"}}}},"responses":{"202":{"description":"Accepted. `MOVE_DATABASE` job submitted.","headers":{"Location":{"description":"URL of the submitted move job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"Empty JSON response."}}}},"400":{"description":"Bad Request. \n\nSome of the provided parameters were not valid.\n\n`serverName does not exist in the tenant.` if the specified destination server is not found in the tenant."},"403":{"description":"Forbidden. The user does not have access to perform this action."},"404":{"description":"Not found. \n\nThe entity you are trying to interact with does not exist."},"500":{"description":"Internal Server Error. \n\nIf the problem persists you may want to contact the Administrator."}}}},"/v1/sql-instances/{instanceName}/Databases/{databaseName}/rename":{"post":{"tags":["Databases"],"summary":"Rename database","operationId":"renamedatabase","parameters":[{"name":"instanceName","in":"path","description":"Name of managed SQL Server instance.","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database to be renamed.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.RenameDatabaseRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.RenameDatabaseRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.RenameDatabaseRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.RenameDatabaseRequest"}}}},"responses":{"202":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.JobIdResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.JobIdResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.JobIdResponse"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/Databases/{databaseName}/shrink":{"post":{"tags":["Databases"],"summary":"Shrink database","operationId":"shrinkdatabase","description":" ","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database to shrink. Both user databases and system databases (e.g. `tempdb`) are supported.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ShrinkDatabaseRequest"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ShrinkDatabaseRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ShrinkDatabaseRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ShrinkDatabaseRequest"}}}},"responses":{"202":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ExportDatabaseResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ExportDatabaseResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.ExportDatabaseResponse"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"409":{"description":"Conflict. The requested resource already exists."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/databases/{databaseName}/{fileExtension}/init-upload":{"post":{"tags":["Import Upload"],"summary":"Initiate multipart upload","operationId":"initiatemultipartupload","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database.","in":"path","required":true,"schema":{"pattern":"^[_\\-a-zA-Z0-9]+$","type":"string"}},{"name":"fileExtension","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.InitUploadResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.InitUploadResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.InitUploadResponse"}}}}}}},"/v1/sql-instances/{instanceName}/databases/{databaseName}/{fileExtension}/upload-part/{uploadId}/{partNumber}":{"get":{"tags":["Import Upload"],"summary":"Get pre-signed URL for multipart upload","operationId":"geturiformultipartupload","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database.","in":"path","required":true,"schema":{"type":"string"}},{"name":"fileExtension","in":"path","required":true,"schema":{"type":"string"}},{"name":"uploadId","in":"path","required":true,"schema":{"type":"string"}},{"name":"partNumber","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}}}},"put":{"tags":["Import Upload"],"summary":"Upload data part by number","operationId":"uploaddatapartbynumber","parameters":[{"name":"instanceName","in":"path","description":"Name of managed SQL Server instance.","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database.","in":"path","required":true,"schema":{"type":"string"}},{"name":"fileExtension","in":"path","required":true,"schema":{"type":"string"}},{"name":"uploadId","in":"path","required":true,"schema":{"type":"string"}},{"name":"partNumber","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","format":"byte"}},"application/octet-stream":{"schema":{"type":"string","format":"byte"}},"application/json-patch+json":{"schema":{"type":"string","format":"byte"}},"text/json":{"schema":{"type":"string","format":"byte"}},"application/*+json":{"schema":{"type":"string","format":"byte"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}}}}},"/v1/sql-instances/{instanceName}/databases/{databaseName}/{fileExtension}/complete-upload":{"post":{"tags":["Import Upload"],"summary":"Complete multipart upload","operationId":"completemultipartupload","parameters":[{"name":"instanceName","in":"path","description":"Name of managed SQL Server instance.","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database.","in":"path","required":true,"schema":{"type":"string"}},{"name":"fileExtension","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CompleteUploadRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CompleteUploadRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CompleteUploadRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CompleteUploadRequest"}}}},"responses":{"200":{"description":"Success"}}}},"/v1/Jobs/{jobId}":{"get":{"tags":["Jobs"],"summary":"Get job status","operationId":"getjobstatus","parameters":[{"name":"jobId","description":"ID of job.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"410":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/Jobs/{jobId}/details":{"get":{"tags":["Jobs"],"summary":"Get job details","operationId":"getjobdetails","parameters":[{"name":"jobId","description":"ID of job.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.BackgroundJobs.JobDetails"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.BackgroundJobs.JobDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.BackgroundJobs.JobDetails"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"410":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/jobs":{"get":{"tags":["Jobs"],"summary":"List jobs by server instance","operationId":"getjobsbyserver","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.JobSummary"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.JobSummary"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.JobSummary"}}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"410":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/jobs/{jobId}":{"get":{"tags":["Jobs"],"summary":"Get job by server instance","description":" ","operationId":"Getjobdetailsbyserver","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}},{"name":"jobId","description":"ID of job.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.JobDetail"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.JobDetail"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.JobDetail"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"410":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/sessions":{"get":{"tags":["Sessions"],"summary":"List sessions by server instance","operationId":"getsessionsbyserver","parameters":[{"name":"instanceName","description":"Name of <<glossary:managed SQL Server instance>>.","in":"path","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to filter response data by property values.\n\n| Property            | Type   | Comparison                              | List |\n| ------------------- | ------ | --------------------------------------- | ---- |\n| `blockingSessionId` | Number | `=`, `!=`, `>`, `<`, `>=`, `<=`         | `IN` |\n| `databaseName`      | String | `=`, `!=`, `>`, `<`, `>=`, `<=`, `LIKE` | `IN` |\n| `hostName`          | String | `=`, `!=`, `>`, `<`, `>=`, `<=`, `LIKE` | `IN` |\n| `loginName`         | String | `=`, `!=`, `>`, `<`, `>=`, `<=`, `LIKE` | `IN` |\n| `programName`       | String | `=`, `!=`, `>`, `<`, `>=`, `<=`, `LIKE` | `IN` |\n| `sessionId`         | Number | `=`, `!=`, `>`, `<`, `>=`, `<=`         | `IN` |\n| `status`            | String | `=`, `!=`                               | `IN` |","schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Session"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Session"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Session"}}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/databases/{databaseName}/sessions":{"get":{"tags":["Sessions"],"summary":"List sessions by database","operationId":"getsessionsbydatabase","parameters":[{"name":"instanceName","description":"Name of <<glossary:managed SQL Server instance>>.","in":"path","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Session"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Session"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Session"}}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/databases/{databaseName}/sessions/{spid}":{"delete":{"tags":["Sessions"],"summary":"Delete database session","operationId":"deletedatabasesession","parameters":[{"name":"instanceName","description":"Name of <<glossary:managed SQL Server instance>>.","in":"path","required":true,"schema":{"type":"string"}},{"name":"databaseName","description":"Name of database.","in":"path","required":true,"schema":{"type":"string"}},{"name":"spid","description":"Server process ID of session to delete.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well."},"204":{"description":"No content."},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not exist."},"500":{"description":"Internal Server Error. If the problem persists you may want to contact the Administrator."}}}},"/v1/sql-instances/{instanceName}/sessions/{spid}":{"delete":{"tags":["Sessions"],"summary":"Delete session","operationId":"deletesession","parameters":[{"name":"instanceName","description":"Name of <<glossary:managed SQL Server instance>>.","in":"path","required":true,"schema":{"type":"string"}},{"name":"spid","description":"Server Process ID of session to delete.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well."},"204":{"description":"No content."},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/Logins":{"get":{"tags":["Logins"],"summary":"List logins by server instance","operationId":"getloginsbyinstance","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Login"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Login"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Login"}}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}},"post":{"tags":["Logins"],"summary":"Create login","operationId":"createlogin","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateLoginRequest"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateLoginRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateLoginRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateLoginRequest"}}}},"responses":{"202":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateLoginResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateLoginResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CreateLoginResponse"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"403":{"description":"Forbidden. You do not have permission to access that resource."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"409":{"description":"Conflict. The requested resource already exists."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/Logins/{loginName}":{"patch":{"tags":["Logins"],"summary":"Update login password","operationId":"updateloginpassword","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}},{"name":"loginName","description":"Name of login.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.UpdateLoginRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.UpdateLoginRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.UpdateLoginRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.UpdateLoginRequest"}}}},"responses":{"200":{"description":"OK. All went well."},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"403":{"description":"Forbidden. You do not have permission to access that resource."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}},"delete":{"tags":["Logins"],"summary":"Delete server instance login","operationId":"deleteinstancelogin","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}},{"name":"loginName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.DeleteLoginResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.DeleteLoginResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.DeleteLoginResponse"}}}},"202":{"description":"OK. All went well.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.DeleteLoginResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.DeleteLoginResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.DeleteLoginResponse"}}}},"204":{"description":"No content."},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"403":{"description":"Forbidden. You do not have permission to access that resource."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/MyIp":{"get":{"tags":["Client IP"],"summary":"Get client IP","operationId":"getclientip","responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.GetMyIpResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.GetMyIpResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.GetMyIpResponse"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances":{"get":{"tags":["Server Instances"],"summary":"List server instances","operationId":"getinstances","responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.SqlInstance"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.SqlInstance"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.SqlInstance"}}}}},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}":{"get":{"tags":["Server Instances"],"summary":"Get server instance","operationId":"getinstance","parameters":[{"name":"instanceName","description":"Name of managed SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.SqlInstance"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.SqlInstance"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.SqlInstance"}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}},"patch":{"tags":["Server Instances"],"summary":"Update server security","operationId":"updateServerGroup","parameters":[{"name":"instanceName","description":"Name of SQL Server instance.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.GroupOperation"}}}}},"responses":{"204":{"description":"No content."},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/linked-servers":{"get":{"tags":["Server Instances"],"summary":"Get linked server instances","operationId":"getLinkedServers","parameters":[{"name":"instanceName","in":"path","required":true,"description":"Name of managed server instance. Returns list of server instances\nlinked to this server instance.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.LinkedServerResponse"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.LinkedServerResponse"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.LinkedServerResponse"}}}}},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"403":{"description":"Forbidden. You do not have permission to access that resource."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}},"post":{"tags":["Server Instances"],"summary":"Create link to server instance","operationId":"linkServer","parameters":[{"name":"instanceName","in":"path","description":"Name of managed server instance.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.LinkedServerRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.LinkedServerRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.LinkedServerRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.LinkedServerRequest"}}},"required":true},"responses":{"200":{"description":"OK. All went well."},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"403":{"description":"Forbidden. You do not have permission to access that resource."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}},"/v1/sql-instances/{instanceName}/linked-servers/{linkedServerName}":{"delete":{"tags":["Server Instances"],"summary":"Delete link to server instance","operationId":"deleteLink","parameters":[{"name":"instanceName","in":"path","required":true,"description":"Name of managed server instance.","schema":{"type":"string"}},{"name":"linkedServerName","in":"path","description":"Name of linked managed server instance.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. All went well."},"400":{"description":"Bad Request. Some of the provided parameters were not valid."},"403":{"description":"Forbidden. You do not have permission to access that resource."},"404":{"description":"Not found. The entity you are trying to interact with does not\nexist."},"500":{"description":"Internal Server Error. If the problem persists you may want to\ncontact the Administrator."}}}}},"components":{"schemas":{"RMS.BackgroundJobs.JobDetails":{"type":"object","properties":{"error":{"description":"Error thrown for this job","type":"string","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.AddCidrRequest":{"required":["cidrEntry"],"type":"object","properties":{"cidrEntry":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CidrEntry"}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.ArchivesDetail":{"type":"object","properties":{"archiveId":{"description":"ID of archive.","type":"string","example":5555,"nullable":true},"serverName":{"description":"Name of server instance hosting archived database.","type":"string","example":"sql-instance-1","nullable":true},"name":{"description":"Name of archive.","type":"string","nullable":true},"databaseType":{"type":"string","description":"Type of database archived.","example":"EDM","enum":["EDM","RDM","UNKNOWN"],"nullable":true},"sizeInMb":{"description":"Size of archive in MB.","type":"integer","example":1833,"format":"int32"},"createDate":{"description":"Timestamp of archive creation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","type":"string","format":"date-time","example":"2025-04-10T20:45:28.775Z"},"expiryDate":{"description":"Timestamp of archive expiration in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","type":"string","format":"date-time","example":"2025-09-10T20:45:28.775Z"},"createdBy":{"description":"Login of <<glossary:principal>> that created archive.","type":"string","example":"user.name@company.com","nullable":true},"downloadUris":{"description":"Array of URIs for downloading this archive","type":"array","items":{"type":"string"},"nullable":true},"thumbprint":{"type":"string","description":"Thumbprint identifier for the archive","example":"EUW1.20251024.57"}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.ArchiveRequest":{"type":"object","properties":{"expirationDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`"}}},"RMS.EnterpriseIntegrationHub.Contracts.ArchivePatch":{"type":"object","properties":{"storageType":{"type":"string","description":"Type of archive.  One of `permanent`, `temporary`.\n\nIf storage type is `temporary`, archive is deleted on `expirationDate`.","enum":["Temporary","Permanent"]},"expirationDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss` that indicates when archive will be deleted if storage type is `temporary`."}}},"RMS.EnterpriseIntegrationHub.Contracts.ArchivesResponse":{"type":"object","properties":{"archiveId":{"description":"ID of this archive.","type":"string","example":5555,"nullable":true},"serverName":{"description":"ID of server instance hosting archive.","type":"string","example":"sql-instance-1","nullable":true},"name":{"description":"Name of archive.","type":"string","example":"archive-of-edm","nullable":true},"sizeInMb":{"description":"Size of archive in MB.","type":"integer","example":1833,"format":"int32"},"createDate":{"description":"Timestamp of archive creation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","type":"string","example":"2025-04-10T20:45:28.775Z","format":"date-time"},"expiryDate":{"description":"Timestamp of archive expiration in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","type":"string","example":"2025-09-10T20:45:28.775Z","format":"date-time"},"createdBy":{"description":"Login of <<glossary:principal>> that created archive.","type":"string","example":"user.name@company.com","nullable":true},"storageTypeId":{"type":"integer","example":0,"description":"Type of archive. One of `0` (temporary) or `1` (permanent). If `0`, archive is deleted on `expiryDate`.","format":"int32"},"thumbprint":{"type":"string","description":"Thumbprint identifier for the archive","example":"EUW1.20251024.57"}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.CidrEntry":{"required":["cidrBlock","comment"],"type":"object","properties":{"cidrBlock":{"description":"Range of IP addresses in <<glossary:CIDR>> format","type":"string","example":"140.177.XXX.123/32"},"comment":{"description":"Description of CIDR block","type":"string","example":"HomeNetNew"}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.Cluster":{"type":"object","properties":{"name":{"description":"Display name of CIDR block","type":"string","nullable":true},"state":{"description":"Current state of job. One of `Succeeded`, `Deleted`, `Failed`","type":"string","nullable":true},"cidrEntries":{"type":"array","description":"Array of <<glossary:CIDR>> entries that consist of `cidrBlock` and\n`comment`","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CidrEntry"},"nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.CompleteUploadRequest":{"type":"object","properties":{"uploadId":{"description":"ID of multi-part upload job.","type":"string","nullable":true},"etags":{"description":"etags that identify chunks","type":"object","additionalProperties":{"type":"string"},"nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.CreateArchiveRequest":{"type":"object","properties":{"expirationDate":{"type":"string","format":"date-time","description":"Expiration date of archive. Temporary archives are deleted on expiration date. If unspecified, archive storage type of archive is `permanet` rather than `temporary`.","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.CreateDatabaseRequest":{"required":["databaseName"],"type":"object","properties":{"databaseName":{"type":"string","description":"Name of database."},"groupIds":{"type":"array","description":"List of group IDs. Client members of the specified groups can access this database.","items":{"type":"string"},"example":["8e676a8f-63ed-4cc0-8678-9a20ce41a80a","4x679a8a-74et-4cc0-8678-7g90ee96d00f"],"nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.CreateDatabaseResponse":{"type":"object","properties":{"jobId":{"description":"ID of job.","type":"string","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.CreateLoginRequest":{"required":["login","password","role"],"type":"object","properties":{"login":{"description":"Unique name of login.","maxLength":20,"minLength":0,"type":"string"},"password":{"description":"Password for login.","maxLength":128,"minLength":0,"type":"string"},"role":{"description":"Role of login. One of `Consumer`, `Contributor`","type":"string","enum":["Consumer","Contributor"]}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.CreateLoginResponse":{"type":"object","properties":{"jobId":{"description":"ID of job.","type":"string","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.Session":{"type":"object","description":"Session information for a SQL Server connection. SPID is the Server\nProcess ID of the session associated with the connection.","properties":{"sessionId":{"type":"integer","format":"int32","description":"Session ID of the connection holding the transaction.","example":54,"nullable":true},"databaseName":{"type":"string","description":"Associated database name.","example":"master","nullable":true},"loginName":{"type":"string","description":"SQL login name.","example":"sa","nullable":true},"programName":{"type":"string","description":"Program name, e.g. _SQL Studio_.","example":"Core Microsoft SqlClient Data Provider","nullable":true},"hostName":{"type":"string","description":"Client machine host name.","example":"eih-api-5555f4f65c-7qsfv","nullable":true},"status":{"type":"string","description":"Session status. One of `running`, `pending`, `suspended`, etc.","example":"running","nullable":true},"loginTime":{"type":"string","format":"date-time","description":"Timestamp when the session logged in.","nullable":true},"lastRequestStartTime":{"type":"string","format":"date-time","description":"Timestamp when the last request started.","nullable":true},"lastRequestEndTime":{"type":"string","format":"date-time","description":"Timestamp when the last request ended.","nullable":true},"cpuTime":{"type":"integer","format":"int32","description":"CPU time used by the session.","nullable":true},"memoryUsage":{"type":"integer","format":"int32","description":"Memory used by the session.","nullable":true},"executingSql":{"type":"string","description":"SQL currently being executed, if applicable.","example":"SELECT * from sys.databases","nullable":true},"blockingSessionId":{"type":"integer","format":"int32","description":"Session ID of the blocking session, if the session is blocked.","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.Database":{"type":"object","properties":{"name":{"type":"string","description":"Name of this database","example":"_0301_NpLZ","nullable":true},"status":{"type":"string","description":"Status of this database.","example":"Ready","nullable":true},"error":{"type":"string","description":"Errors related to this database","nullable":true},"sizeInMb":{"type":"integer","description":"Size of this database in MB","format":"int32","example":79,"nullable":true},"createdAt":{"type":"string","description":"Timestamp of database creatiion date","format":"date-time","example":"2025-01-03T14:20:30.9+00:00"},"pinned":{"type":"boolean","description":"If `true`, database is pinned","example":true},"pinExpiration":{"type":"string","description":"Timestamp of pin expiration date. If `pinned` is `true` and no\n`pinExpiration` is specified, the database is pemanently pinned","format":"date-time","nullable":true},"databaseSchema":{"type":"string","description":"Schema of this database. One of `Edm`, `Rdm`, `System`, or `Unknown`","nullable":true,"example":"Edm"},"databaseVersion":{"type":"string","description":"Schema version of EDM or RDM database. For example, _21_, _24_","nullable":true,"example":24},"lastIndexUpdate":{"type":"string","description":"Timestamp of last update of this database","format":"date-time","nullable":true,"example":"2025-03-05T13:03:36+00:00"},"registered":{"type":"boolean","description":"If `true`, EDM is registered with Risk Modeler. Registered EDMs are\naccessible via Risk Modeler and Platform APIs.","example":true},"exposureSetId":{"type":"string","description":"UUID of exposure set.","format":"uuid","nullable":true,"example":"1bb56357-1c73-4fa9-9587-28b4e7ba28e0"},"owner":{"type":"string","description":"Name of login that owns database.","nullable":true,"example":"user.name@company.com"},"secured":{"type":"boolean","description":"If `true`, this database is secured and access is restricted to the\nowner and members of assigned groups.","example":true},"groups":{"type":"array","description":"`groupId` and `groupName` of groups that can access this database\n","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Group"},"nullable":true},"exposureSetRiId":{"type":"number","description":"ID of exposure set.","example":3541941},"exposureSetName":{"type":"string","description":"Name of exposure set.","example":"_0301_NpLZ"},"thumbprint":{"type":"string","description":"Thumbprint identifier for the database","example":"EUW1.20251024.57"}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.DeleteLoginResponse":{"type":"object","properties":{"jobId":{"description":"ID of job.","type":"string","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.ExportDatabaseResponse":{"type":"object","properties":{"jobId":{"description":"ID of job.","type":"string","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.GetMyIpResponse":{"type":"object","properties":{"clientIP":{"description":"IP address of this client","type":"string","nullable":true},"isAllowed":{"description":"If `true`, client IP address is specified in ACL and client can\naccess Data Bridge cluster","type":"boolean"}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.Group":{"type":"object","properties":{"groupId":{"description":"ID of group.","type":"string","example":"a5d11079-4c73-4863-9de1-0790d316b630","nullable":true},"groupName":{"description":"Name of group","type":"string","example":"Engineering Support","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.GroupOperation":{"description":"Array of operations for granting or revoking access to a data resource (server instance or database) by group.\n","required":["operation","targetProperty","value"],"type":"object","properties":{"operation":{"type":"string","description":"One of `Add` or `Remove`. If `Add`, the specified group can access the data resource. If `Remove`, the specified group cannot access the data resource.","example":"Add"},"targetProperty":{"description":"Property to update. Only `groupId` is supported.\n","type":"string","example":"groupId"},"value":{"description":"Unique ID of a group.","example":"8e676a8f-63ed-4cc0-8678-9a20ce41a80a","type":"string"}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.ImportDatabasePrepareResponse":{"type":"object","additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.ImportDatabaseRequest":{"type":"object","properties":{"groupIds":{"type":"array","description":"List of <<glossary:group>>s that can access the database identified\nby `groupId`.","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.ArchiveDatabaseResponse":{"type":"object","properties":{"jobId":{"description":"ID of this job","type":"string","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.ImportDatabaseResponse":{"type":"object","properties":{"jobId":{"description":"ID of this job","type":"string","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.InitUploadResponse":{"type":"object","properties":{"uploadId":{"description":"ID of this job","type":"string","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.JobDetailDetails":{"type":"object","description":"Job logging and error details.","properties":{"error":{"type":"string","nullable":true,"description":"User-facing error string when the job did not complete successfully. Typical values returned by the platform include:\n\n- `An internal error has occurred during the backup/restore operation. Database info/backup file might not be valid.`\n- `The backup provided is invalid for this version of Sql Server.`\n- `We encountered an error trying to run the job. Please try again. If this still does not work, contact Support.`\n- `A network-related or instance-specific error occurred while establishing a connection to SQL Server`\n\nAdditional or revised messages may be returned without notice; clients should display the text as provided.","example":"We encountered an error trying to run the job. Please try again. If this still does not work, contact Support."}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.JobDetail":{"type":"object","properties":{"id":{"description":"ID of this job","type":"string","nullable":true},"type":{"description":"Type of job, e.g. `export`, `import`, `delete archive`, `create login`.","type":"string","nullable":true},"owner":{"description":"Login of <<glossary:principal>> that created  job, e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase.","type":"string","nullable":true},"status":{"description":"Status of job. One of `cancelRequested`, `cancelled` `cancelling`, `done`, `failed`, `finished`, `pending`, `queued`, `running`.","type":"string","nullable":true},"resourceType":{"description":"Type of data resource. One of `server`, `database`.","type":"string","nullable":true},"resourceName":{"description":"Name of data resource this job is run on","type":"string","nullable":true},"createTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time","nullable":true},"details":{"description":"Detailed error and diagnostic information. If returned, `details.error` summarizes the error.","nullable":true,"allOf":[{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.JobDetailDetails"}]}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.JobIdResponse":{"type":"object","properties":{"jobId":{"description":"ID of this job","type":"string","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.JobSummary":{"type":"object","properties":{"id":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"owner":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"resourceType":{"type":"string","nullable":true},"resourceName":{"type":"string","nullable":true},"createTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.LinkedServerRequest":{"required":["name","targetInstanceName"],"type":"object","properties":{"name":{"type":"string","description":"Name of link between the server instances."},"targetInstanceName":{"type":"string","description":"Name of managed server instance to link."}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.LinkedServerResponse":{"type":"object","properties":{"name":{"type":"string","nullable":true},"targetInstanceName":{"type":"string","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.Login":{"type":"object","properties":{"name":{"type":"string","description":"Unique name used by <<glossary:principal>> to log into and manage data in the tenant's cluster.","example":"user.name@company.com","nullable":true},"role":{"type":"string","description":"Role of <<glossary:principal>>. One of `Consumer`, `Contributor`","example":"Contributor","nullable":true},"status":{"type":"string","nullable":true},"owner":{"type":"string","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.MoveDatabaseRequest":{"required":["serverName"],"type":"object","properties":{"serverName":{"type":"string","description":"Name of server instance on Data Bridge.\n\nDatabase is moved to this server instance.","example":"databridge-2"}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.PatchDatabaseOperationRequest":{"type":"object","properties":{"groupOperations":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.GroupOperation"},"nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.PatchSqlInstanceOperationRequest":{"type":"object","properties":{"groupOperations":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.GroupOperation"},"nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.PinOrUnpinRequest":{"required":["pinned"],"type":"object","properties":{"pinned":{"type":"boolean","description":"Boolean to pin or unpin database. If `true` database is pinned.\nWhile pinned, the database cannot be archived."},"pinExpiration":{"type":"string","format":"date-time","description":"Expiration date for database lease. If unspecified, the lease will\nnot expire and the database must be unpinned.","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.RenameDatabaseRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.RestoreArchiveRequest":{"required":["databaseName"],"type":"object","properties":{"targetInstance":{"type":"string","description":"Name of managed SQL Server instance. Archived database is restored to this server.","nullable":true},"databaseName":{"type":"string","description":"Name of restored database.\n\nArchived database is restored with the specified name on the `targetInstance`."},"owner":{"type":"string","description":"Login of <<glossary:principal>> that owns restored database.","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.SetClusterSecurityRequest":{"type":"object","properties":{"minTlsVersion":{"type":"string","description":"Minimum version of TLS protocol allowed on cluster.","nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.ShrinkDatabaseRequest":{"type":"object","properties":{"timeout":{"type":"integer","description":"Timeout period in hours. Shrink job times out if incomplete after the specified time. If unspecified, _4_.","default":4,"maximum":12},"truncateLogsOnly":{"type":"boolean","description":"If `true`, data files are ignored and only log files are truncated.","default":false}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.SqlInstance":{"type":"object","properties":{"name":{"type":"string","description":"Name of this SQL Server instance.","nullable":true},"uid":{"type":"string","description":"ID of SQL Server instance.","nullable":true},"endpoint":{"type":"string","description":"URI of this SQL Server instance.","nullable":true},"internalEndpoint":{"type":"string","nullable":true},"status":{"type":"string","description":"Status of this SQL Server instance in cluster. One of `Pending`, `Ready`, `Creating`, `Updating`, `Deleting`, `Deleted`, `FailedCreate`, `FailedUpdate`, `FailedDelete`.","nullable":true},"totalDiskSpaceInMb":{"type":"integer","format":"int32","description":"Disk space on server instance in MB. Defined by licensing agreement.","nullable":true},"availableDiskSpaceInMb":{"type":"integer","format":"int32","description":"Disk space available on this server instance in MB.","nullable":true},"usedDiskSpaceInMb":{"type":"integer","description":"Disk space used on this server instance in MB.","format":"int32","nullable":true},"databaseLimit":{"type":"integer","description":"Maximum number of active databases this server instance will support as defined in the tenant's license agreement.","format":"int32","nullable":true},"pinnedDatabaseLimit":{"type":"integer","description":"Max number of pinned databases allowed based on license agreement","format":"int32","nullable":true},"archivedDatabaseStorageUsedInMb":{"type":"integer","description":"Total usage of database storage in MB.","format":"int64"},"archivedDatabaseCount":{"type":"integer","description":"Number of databases archived.","format":"int32"},"owner":{"type":"string","description":"Name of <<glossary:login>> that owns this server instance. Owner can grant access to one or more groups","nullable":true},"secured":{"type":"boolean","description":"If `true`, this server instance is secured and access is restricted based on group membership"},"groups":{"type":"array","description":"The `groupId` and `groupName` of the <<glossary:group>> that can access this server.","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.Group"},"nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.UpdateCidrRequest":{"type":"object","properties":{"addCidrEntries":{"type":"array","items":{"$ref":"#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CidrEntry"},"nullable":true},"removeCidrEntries":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Contracts.UpdateLoginRequest":{"required":["password"],"type":"object","properties":{"password":{"description":"New password for login.","maxLength":128,"minLength":0,"type":"string"}},"additionalProperties":false},"RMS.EnterpriseIntegrationHub.Enums.ExportToType":{"enum":[0,1,2],"type":"integer","format":"int32"},"RMS.EnterpriseIntegrationHub.Enums.ImportFromType":{"enum":[0,1,2],"type":"integer","description":"Format of database artifact. One of `0` (MDF), `1` (BAK), `2` (DACPAC).\nIf undefined, `1` (`BAK`) is default.","format":"int32"}}}}