CDBs

List all CDBs (Oracle only).

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "name" "-name" "database_version" "-database_version" "environment_id" "-environment_id" "size" "-size" "jdbc_connection_string" "-jdbc_connection_string" "engine_id" "-engine_id" "group_name" "-group_name" "enabled" "-enabled" "status" "-status" "instance_name" "-instance_name" "instance_number" "-instance_number"
Example: sort=id
Responses
200

OK

get/cdbs
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search for CDBs (Oracle only).

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "name" "-name" "database_version" "-database_version" "environment_id" "-environment_id" "size" "-size" "jdbc_connection_string" "-jdbc_connection_string" "engine_id" "-engine_id" "group_name" "-group_name" "enabled" "-enabled" "status" "-status" "instance_name" "-instance_name" "instance_number" "-instance_number"
Example: sort=id
Request Body schema: application/json

A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension.

Filter Expression Overview

Note: All keywords are case-insensitive

Comparison Operators

Operator Description Example
CONTAINS Substring or membership testing for string and list attributes respectively. field3 CONTAINS 'foobar', field4 CONTAINS TRUE
IN Tests if field is a member of a list literal. List can contain a maximum of 100 values field2 IN ['Goku', 'Vegeta']
GE Tests if a field is greater than or equal to a literal value field1 GE 1.2e-2
GT Tests if a field is greater than a literal value field1 GT 1.2e-2
LE Tests if a field is less than or equal to a literal value field1 LE 9000
LT Tests if a field is less than a literal value field1 LT 9.02
NE Tests if a field is not equal to a literal value field1 NE 42
EQ Tests if a field is equal to a literal value field1 EQ 42

Search Operator

The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically SEARCH '12' would match an item with an attribute with an integer value of 123.

Logical Operators

Ordered by precedence.

Operator Description Example
NOT Logical NOT (Right associative) NOT field1 LE 9000
AND Logical AND (Left Associative) field1 GT 9000 AND field2 EQ 'Goku'
OR Logical OR (Left Associative) field1 GT 9000 OR field2 EQ 'Goku'

Grouping

Parenthesis () can be used to override operator precedence.

For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo')

Literal Values

Literal Description Examples
Nil Represents the absence of a value nil, Nil, nIl, NIL
Boolean true/false boolean true, false, True, False, TRUE, FALSE
Number Signed integer and floating point numbers. Also supports scientific notation. 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2
String Single or double quoted "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar'
Datetime Formatted according to RFC3339 2018-04-27T18:39:26.397237+00:00
List Comma-separated literals wrapped in square brackets [0], [0, 1], ['foo', "bar"]

Limitations

  • A maximum of 8 unique identifiers may be used inside a filter expression.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/cdbs/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Get a CDB by ID (Oracle only).

SecurityApiKeyAuth
Request
path Parameters
cdbId
required
string non-empty

The ID of the CDB.

Responses
200

OK

get/cdbs/{cdbId}
Response samples
application/json
{
  • "id": "1-CDB-1",
  • "name": "Oracle CDB",
  • "namespace_id": "1-NAMESPACE-1",
  • "namespace_name": "test-engine-1",
  • "is_replica": true,
  • "database_version": "10.2.0.5.0",
  • "environment_id": "1-ENVIRONMENT-1",
  • "size": 339292672,
  • "jdbc_connection_string": "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
  • "engine_id": "engine-12",
  • "is_linked": false,
  • "tags": [
    ],
  • "group_name": "Untitled",
  • "status": "RUNNING",
  • "enabled": true,
  • "instance_name": "CDBSID",
  • "instance_number": 0,
  • "instances": [
    ],
  • "oracle_services": [
    ]
}

Get tags for a CDB.

SecurityApiKeyAuth
Request
path Parameters
cdbId
required
string non-empty

The ID of the CDB.

Responses
200

Ok

get/cdbs/{cdbId}/tags
Response samples
application/json
{
  • "tags": [
    ]
}

Create tags for a CDB.

SecurityApiKeyAuth
Request
path Parameters
cdbId
required
string non-empty

The ID of the CDB.

Request Body schema: application/json
required

Tags information for CDB.

required
Array of objects (Tag) [ 1 .. 1000 ] items unique

Array of tags with key value pairs

Responses
201

Created

post/cdbs/{cdbId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ]
}

Delete tags for a CDB.

SecurityApiKeyAuth
Request
path Parameters
cdbId
required
string non-empty

The ID of the CDB.

Request Body schema: application/json

The parameters to delete tags

key
string [ 1 .. 4000 ] characters

Key of the tag

value
string [ 1 .. 4000 ] characters

Value of the tag

Array of objects (Tag) [ 1 .. 1000 ] items unique

List of tags to be deleted

Responses
204

No Content

post/cdbs/{cdbId}/tags/delete
Request samples
application/json

Delete all tags for given object - No request body required

{ }

Enable a CDB.

SecurityApiKeyAuth
Request
path Parameters
cdbId
required
string non-empty

The ID of the CDB.

Request Body schema: application/json

The parameters to enable a CDB.

attempt_start
boolean
Default: true

Whether to attempt a startup of the CDB after the enable.

Responses
200

CDB enable initiated.

post/cdbs/{cdbId}/enable
Request samples
application/json
{
  • "attempt_start": true
}
Response samples
application/json
{
  • "job": {
    }
}

Disable a CDB.

SecurityApiKeyAuth
Request
path Parameters
cdbId
required
string non-empty

The ID of the CDB.

Request Body schema: application/json

The parameters to disable a CDB.

attempt_cleanup
boolean
Default: true

Whether to attempt a cleanup of the CDB before the disable.

Responses
200

CDB disable initiated.

post/cdbs/{cdbId}/disable
Request samples
application/json
{
  • "attempt_cleanup": true
}
Response samples
application/json
{
  • "job": {
    }
}

Delete a CDB.

SecurityApiKeyAuth
Request
path Parameters
cdbId
required
string non-empty

The ID of the CDB.

Request Body schema: application/json

The parameters to delete a CDB.

force
boolean
Default: false

Whether to continue the operation upon failures.

Responses
200

CDB delete initiated.

post/cdbs/{cdbId}/delete
Request samples
application/json
{
  • "force": false
}
Response samples
application/json
{
  • "job": {
    }
}

Update a CDB.

SecurityApiKeyAuth
Request
path Parameters
cdbId
required
string non-empty

The ID of the CDB.

Request Body schema: application/json

The parameters to update a CDB.

oracle_services
Array of strings

List of jdbc connection strings which are used to connect with the database.

Responses
200

CDB update initiated.

patch/cdbs/{cdbId}/update
Request samples
application/json
{
  • "oracle_services": [
    ]
}
Response samples
application/json
{
  • "job": {
    }
}

Upgrade Oracle CDB

SecurityApiKeyAuth
Request
path Parameters
cdbId
required
string non-empty

The ID of the CDB.

Request Body schema: application/json

The new data to upgrade an Oracle CDB.

repository_id
string

The object reference of the CDB repository to upgrade to.

environment_user_id
string

Reference of the environment user to use for CDB upgrade.

Responses
200

OK

post/cdbs/{cdbId}/upgrade
Request samples
application/json
{
  • "repository_id": "ORACLE_INSTALL-4",
  • "environment_user_id": "HOST_USER-4"
}
Response samples
application/json
{
  • "job": {
    }
}

Detaches an Oracle CDB from an Oracle database.

SecurityApiKeyAuth
Request
path Parameters
cdbId
required
string non-empty

The ID of the CDB.

Responses
200

OK

post/cdbs/{cdbId}/detachSource
Response samples
application/json
{
  • "job": {
    },
  • "dsource_id": "1-ORACLE_DB_CONTAINER-32"
}

Attach an Oracle CDB to an Oracle database.

SecurityApiKeyAuth
Request
path Parameters
cdbId
required
string non-empty

The ID of the CDB.

Request Body schema: application/json
required

The parameters to attach an Oracle CDB.

dsource_id
required
string [ 1 .. 256 ] characters

Id of the dsource to attach.

backup_level_enabled
boolean

Boolean value indicates whether LEVEL-based incremental backups can be used on the source database.

bandwidth_limit
integer
Default: 0

Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit.

check_logical
boolean
Default: false

True if extended block checking should be used for this linked database.

compressed_linking_enabled
boolean
Default: true

True if SnapSync data from the source should be compressed over the network. Enabling this feature will reduce network bandwidth consumption and may significantly improve throughput, especially over slow network.

double_sync
boolean
Default: false

True if two SnapSyncs should be performed in immediate succession to reduce the number of logs required to provision the snapshot. This may significantly reduce the time necessary to provision from a snapshot.

encrypted_linking_enabled
boolean
Default: false

True if SnapSync data from the source should be retrieved through an encrypted connection. Enabling this feature can decrease the performance of SnapSync from the source but has no impact on the performance of VDBs created from the retrieved data.

environment_user
string

Reference to the user that should be used in the host.

external_file_path
string [ 1 .. 1024 ] characters

External file path.

files_per_set
integer [ 1 .. 64 ]
Default: 5

Number of data files to include in each RMAN backup set.

force
boolean
Default: false

If true, attach will succeed even if the resetlogs of the new database does not match the resetlogs information of the original database.

link_now
boolean
Default: false

True if initial load should be done immediately.

number_of_connections
integer
Default: 1

Total number of transport connections to use during SnapSync.

Array of objects (SourceOperation)

Operations to perform after syncing a created dSource and before running the LogSync.

oracle_fallback_user
string [ 1 .. 256 ] characters

The database fallback username. Optional if bequeath connections are enabled (to be used in case of bequeath connection failures). Only required for username-password auth.

oracle_fallback_credentials
string [ 1 .. 256 ] characters

Password for fallback username.

rman_channels
integer [ 1 .. 32 ]
Default: 2

Number of parallel channels to use.

Responses
200

OK

post/cdbs/{cdbId}/attachSource
Request samples
application/json
{
  • "dsource_id": "string",
  • "backup_level_enabled": true,
  • "bandwidth_limit": 0,
  • "check_logical": false,
  • "compressed_linking_enabled": true,
  • "double_sync": false,
  • "encrypted_linking_enabled": false,
  • "environment_user": "string",
  • "external_file_path": "string",
  • "files_per_set": 5,
  • "force": false,
  • "link_now": false,
  • "number_of_connections": 1,
  • "operations": [
    ],
  • "oracle_fallback_user": "oracle",
  • "oracle_fallback_credentials": "oracle",
  • "rman_channels": 2
}
Response samples
application/json
{
  • "job": {
    }
}
➔ Next to VCDBs