Get Provider Details
get
/services/{version}/installation/aiservice/providers/{provider}
Required Role: Security
Retrieve the details of an AI Provider.Request
Path Parameters
-
provider(required): string
Minimum Length:
1Maximum Length:255Pattern:.*Name of the Provider. -
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
provider details returned
Root Schema : AI Provider
Type:
objectTitle:
Show Source
AI Provider-
$schema:
Allowed Values:
[ "ogg:provider" ] -
authentication:
object authentication
-
baseUrl:
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$ -
capabilities:
array capabilities
Minimum Number of Items:
0Maximum Number of Items:32767 -
description:
string
Minimum Length:
1Maximum Length:4000 -
enabled:
boolean
Default Value:
true -
headers:
object headers
-
id:
string
Minimum Length:
1Maximum Length:255 -
metadata:
object metadata
-
name:
string
Minimum Length:
1Maximum Length:255 -
regions:
array regions
Minimum Number of Items:
0Maximum Number of Items:32767 -
retry:
object retry
-
tasksTypes:
array tasksTypes
Minimum Number of Items:
0Maximum Number of Items:32767 -
timeouts:
object timeouts
-
type:
string
Minimum Length:
1Maximum Length:255
Nested Schema : authentication
Type:
Show Source
object-
audiences:
array audiences
Minimum Number of Items:
0Maximum Number of Items:32767 -
compartmentId:
string
Minimum Length:
1Maximum Length:255Pattern:ocid1[.].*[.]oc[123]{1}[.].*[.].* -
configured:
boolean
-
credentialsRef:
object credentialsRef
-
keyFingerprint:
string
Minimum Length:
47Maximum Length:47 -
password:
string
Minimum Length:
1Maximum Length:256 -
privateKey:
string
Minimum Length:
1Maximum Length:10240 -
scopes:
array scopes
Minimum Number of Items:
0Maximum Number of Items:32767 -
secret:
string
Minimum Length:
1Maximum Length:512 -
tenancyId:
string
Minimum Length:
1Maximum Length:255Pattern:ocid1[.].*[.]oc[123]{1}[.].*[.].* -
type:
string
Minimum Length:
1Maximum Length:255Example:api_key -
userId:
string
Minimum Length:
1Maximum Length:255Pattern:ocid1[.].*[.]oc[123]{1}[.].*[.].*
Nested Schema : capabilities
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767-
Array of:
string
Minimum Length:
1Maximum Length:512
Nested Schema : headers
Type:
objectNested Schema : metadata
Type:
objectNested Schema : regions
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767-
Array of:
string
Minimum Length:
1Maximum Length:512
Nested Schema : retry
Type:
Show Source
object-
backoffMultiplier:
number
Default Value:
2 -
initialBackoffMs:
integer
Minimum Value:
0Maximum Value:9223372036854776000Default Value:100 -
maxBackoffMs:
integer
Minimum Value:
0Maximum Value:9223372036854776000Default Value:10000 -
maxRetries:
integer
Minimum Value:
0Maximum Value:9223372036854776000Default Value:3
Nested Schema : tasksTypes
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767-
Array of:
string
Minimum Length:
1Maximum Length:512
Nested Schema : timeouts
Type:
Show Source
object-
connectTimeoutMs:
integer
Minimum Value:
0Maximum Value:9223372036854776000Default Value:10000 -
requestTimeoutMs:
integer
Minimum Value:
0Maximum Value:9223372036854776000Default Value:30000 -
totalTimeoutMs:
integer
Minimum Value:
0Maximum Value:9223372036854776000Default Value:60000
Nested Schema : audiences
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767-
Array of:
string
Minimum Length:
1Maximum Length:512
Nested Schema : credentialsRef
Type:
Show Source
object-
alias:
string
Minimum Length:
1Maximum Length:255 -
domain:
string
Minimum Length:
1Maximum Length:255
Nested Schema : scopes
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767-
Array of:
string
Minimum Length:
1Maximum Length:512
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"rel":"canonical",
"href":"https://localhost:9000/services/v2/installation/aiservice/providers/voyage1",
"mediaType":"application/json"
},
{
"rel":"self",
"href":"https://localhost:9000/services/v2/installation/aiservice/providers/voyage1",
"mediaType":"application/json"
},
{
"rel":"describedby",
"href":"https://localhost:9000/services/v2/metadata-catalog/provider",
"mediaType":"application/schema+json"
}
],
"messages":[
],
"response":{
"id":"voyage1",
"name":"Voyage AI",
"type":"voyage",
"baseUrl":"https://api.voyageai.com/v1",
"description":"Voyage AI embedding provider",
"authentication":{
"type":"api_key",
"configured":true
}
}
}