Patch a Provider
patch
/services/{version}/installation/aiservice/providers/{provider}
Required Role: Security
Patch an AI Provider.Request
Supported Media Types
- application/json
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" ]
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 Request (application/json)
{
"authentication":{
"type":"api_key",
"secret":"abcdefghijklmnopqrstuvwxyz0123456789"
}
}Response
Supported Media Types
- application/json
200 Response
Patch an existing provider.
Root Schema : RESTful API Standard Response
Type:
objectTitle:
RESTful API Standard ResponseStandard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema:
Allowed Values:
[ "api:standardResponse" ] -
links(required):
array links
Minimum Number of Items:
0Maximum Number of Items:16Oracle GoldenGate links for the request -
messages(required):
array messages
Minimum Number of Items:
0Maximum Number of Items:65535Oracle GoldenGate messages issued during the request -
response:
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
16Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
65535Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
objectOracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:link" ] -
description:
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType:
string
Minimum Length:
6Maximum Length:255Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel(required):
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:message" ] -
code(required):
string
Minimum Length:
9Maximum Length:9Pattern:^OGG[-][0-9]{5}$The Oracle GoldenGate message code -
issued(required):
string
Minimum Length:
20Maximum Length:32Pattern:^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$The date and time that the message was issued -
severity(required):
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]The severity of the message -
title(required):
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI [RFC3986] to a page that describes the info, warning or error type.
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"
}
],
"messages":[
],
"response":{
"name":"Voyage AI",
"description":"Voyage AI embedding provider",
"type":"voyage",
"baseUrl":"https://api.voyageai.com/v1",
"authentication":{
"type":"api_key"
},
"id":"voyage1"
}
}