Jump to

• Request
• Response

Create OCI Vector Credential

post

/essbase/rest/v1/ai/dbconnection/{dbConnectionName}/vector/credential/{credentialName}

Creates the OCI vector credential for the specified application..

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• credentialName(required): string

  Credential name.

• dbConnectionName(required): string

  Database connection name.

Body ()

OCI vector credential details.

Root Schema : OCIVectorCredentialDTO

Type: object

Show Source

• compartment_ocid(required): string
• embed_model(required): string
• fingerprint(required): string
• private_key(required): string
• tenancy_ocid(required): string
• url(required): string
• user_ocid(required): string

{
    "type":"object",
    "required":[
        "compartment_ocid",
        "embed_model",
        "fingerprint",
        "private_key",
        "tenancy_ocid",
        "url",
        "user_ocid"
    ],
    "properties":{
        "user_ocid":{
            "type":"string"
        },
        "tenancy_ocid":{
            "type":"string"
        },
        "compartment_ocid":{
            "type":"string"
        },
        "private_key":{
            "type":"string"
        },
        "fingerprint":{
            "type":"string"
        },
        "url":{
            "type":"string"
        },
        "embed_model":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

OCI vector credential created successfully.

400 Response

Bad Request

Failed to create OCI vector credential.

Back to Top