Get Topology

GET

/topologies/{topologyId}

Retrieves details of a specific topology

Authorizations

• publicOauth2

Parameters

Path Parameters

topologyId

required

string

format: uuid

Responses

200

Topology details

Response Schema

object

topologyId

Unique identifier for the topology

string

format: uuid

orgId

Organization ID

string

format: uuid

name

string

>= 1 characters

<= 100 characters

/\S+/

description

string

""

<= 250 characters

Example:

Description of the thing

status

Current status of the topology

string

Allowed values:

creating

active

updating

deleting

error

globalXdr

object

ignoreExpunges

Whether to ignore record expunges

boolean

shipVersionsPolicy

Version shipping policy

string

default: keep_all_versions

Allowed values:

keep_all_versions

keep_latest_version

enableCompression

Enable compression for XDR shipping

boolean

shipSets

List of sets to ship

Array<string>

shipBins

List of bins to ship

Array<string>

ignoreBin

List of bins to ignore

Array<string>

databases

Array<object>

object

databaseId

required

ID of the database in the topology

string

format: uuid

outboundConnections

Array<object>

object

databaseId

required

ID of the target database for this connection

string

format: uuid

createdAt

Timestamp when topology was created

string

format: date-time

updatedAt

Timestamp when topology was last updated

string

format: date-time

Example

Content type: application/json

Copied!

{ 

{

"topologyId": "string",

"orgId": "string",

"name": { 

"0": "s",

"1": "t",

"2": "r",

"3": "i",

"4": "n",

"5": "g"

},

"description": "Description of the thing",

"status": "creating",

"globalXdr": { 

"ignoreExpunges": "boolean",

"shipVersionsPolicy": "keep_all_versions",

"enableCompression": "boolean",

"shipSets": [ 

"string"

],

"shipBins": [ 

"string"

],

"ignoreBin": [ 

"string"

]

},

"databases": [ 

{ 

"databaseId": "string",

"outboundConnections": [ 

{ 

"databaseId": "string"

}

]

}

],

"createdAt": "string",

"updatedAt": "string"

}

401

Access token is missing or invalid

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "invalid_token",

"message": "The access token expired."

}

403

Permission denied

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

404

Resource not found

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

500

Internal Server Error

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}