Jump to

• Request
• Response

(Preview) Get connected Git repository

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}

(Preview) Returns stored repository URL, folder, branch, and connectivity references. The authentication setting key is included only when shouldIncludeCredentialKey=true.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• gitRepositoryKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The opaque repository key, available as GitRepository.key or system:repoKey in the folder's JSON file-metadata HEAD response header when shouldIncludeMetadata=true. Distinct from the async operation resourceName.
• workspaceKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The key of the Workspace

Query Parameters

• shouldIncludeCredentialKey: boolean
  A flag to include credential key in response. If 'true', credential key will be returned in response. Default 'false'.

Header Parameters

• opc-request-id: string
  Maximum Length: 255

  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. A Git repository object is retrieved.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : GitRepository

Type: object

Details about a Git repository.

Show Source

• branchName(required): string
  The name of the Git branch.
• credentialKey: string
  Key of the current user's GIT_ACCOUNT user setting containing Git authentication credentials. Identified by settingType=GIT_ACCOUNT and displayName in user setting listings. Distinct from credentialStoreKey, which references a TLS CA certificate.
• credentialStoreKey: string
  Minimum Length: 1

  Maximum Length: 255

  Key of the credential-store entry containing the Git server's TLS CA certificate, identified by displayName in credential listings. Provides server certificate trust, separate from the Git authentication user setting referenced by credentialKey. Required when isPrivateConnectivityEnabled is true.
• credentialStoreName: string
  User-friendly display name of the repository TLS CA certificate credential.
• gitConnectivityProfileKey: string
  Minimum Length: 1

  Maximum Length: 200

  Key of the private network profile used for Git connectivity, returned by private network profile listings filtered by name. Required when isPrivateConnectivityEnabled is true.
• gitConnectivityProfileName: string
  User-friendly name of the private Git connectivity profile.
• gitFolderPath(required): string
  The path of the current Git folder which has to be created for the new branch.
• gitUrl(required): string
  The Git repository url corresponding to the branch.
• isPrivateConnectivityEnabled: boolean
  Whether this repository uses private network connectivity.
• key(required): string
  Unique key associated with repository.
• sparseCheckout: object SparseCheckoutDetails
  Sparse checkout configuration for a git repository. Only cone mode is supported. Specify only when creating a sparse git folder; sparse checkout cannot be enabled later for a non-sparse git folder. For sparse git folders, settings updates can change cone folder patterns but cannot enable or disable sparse checkout.
• workspaceKey(required): string
  The workspaceKey associated with the Git repository.

{
    "type":"object",
    "description":"Details about a Git repository.",
    "required":[
        "key",
        "workspaceKey",
        "branchName",
        "gitUrl",
        "gitFolderPath"
    ],
    "properties":{
        "key":{
            "description":"Unique key associated with repository.",
            "type":"string"
        },
        "workspaceKey":{
            "description":"The workspaceKey associated with the Git repository.",
            "type":"string"
        },
        "branchName":{
            "description":"The name of the Git branch.",
            "type":"string"
        },
        "gitUrl":{
            "description":"The Git repository url corresponding to the branch.",
            "type":"string"
        },
        "gitFolderPath":{
            "description":"The path of the current Git folder which has to be created for the new branch.",
            "type":"string"
        },
        "credentialKey":{
            "description":"Key of the current user's GIT_ACCOUNT user setting containing Git authentication\ncredentials. Identified by settingType=GIT_ACCOUNT and displayName in user\nsetting listings. Distinct from credentialStoreKey, which references a TLS\nCA certificate.\n",
            "type":"string"
        },
        "sparseCheckout":{
            "$ref":"#/definitions/SparseCheckoutDetails"
        },
        "isPrivateConnectivityEnabled":{
            "description":"Whether this repository uses private network connectivity.",
            "type":"boolean"
        },
        "gitConnectivityProfileKey":{
            "description":"Key of the private network profile used for Git connectivity, returned by\nprivate network profile listings filtered by name. Required when\nisPrivateConnectivityEnabled is true.\n",
            "type":"string",
            "minLength":1,
            "maxLength":200
        },
        "gitConnectivityProfileName":{
            "description":"User-friendly name of the private Git connectivity profile.",
            "type":"string"
        },
        "credentialStoreKey":{
            "description":"Key of the credential-store entry containing the Git server's TLS CA\ncertificate, identified by displayName in credential listings. Provides\nserver certificate trust, separate from the Git authentication user setting\nreferenced by credentialKey. Required when isPrivateConnectivityEnabled is true.\n",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "credentialStoreName":{
            "description":"User-friendly display name of the repository TLS CA certificate credential.",
            "type":"string"
        }
    }
}

Nested Schema : SparseCheckoutDetails

Type: object

Sparse checkout configuration for a git repository. Only cone mode is supported. Specify only when creating a sparse git folder; sparse checkout cannot be enabled later for a non-sparse git folder. For sparse git folders, settings updates can change cone folder patterns but cannot enable or disable sparse checkout.

Show Source

• mode: string
  Default Value: CONE

  Allowed Values: [ "CONE" ]

  Sparse checkout matching mode. Git supports cone and non-cone sparse checkout pattern styles; AIDP supports cone mode only.
• patterns: array patterns
  Minimum Number of Items: 0

  Maximum Number of Items: 100

  Repository-root-relative folder paths to include in the sparse worktree. Cone patterns apply only to folders; root-level files in the repository are always materialized. Empty or omitted patterns materialize root-level files only.

{
    "description":"Sparse checkout configuration for a git repository. Only cone mode is supported. Specify only when creating a sparse git folder; sparse checkout cannot be enabled later for a non-sparse git folder. For sparse git folders, settings updates can change cone folder patterns but cannot enable or disable sparse checkout.",
    "type":"object",
    "properties":{
        "patterns":{
            "description":"Repository-root-relative folder paths to include in the sparse worktree. Cone patterns apply only to folders; root-level files in the repository are always materialized. Empty or omitted patterns materialize root-level files only.",
            "type":"array",
            "minItems":0,
            "maxItems":100,
            "items":{
                "type":"string",
                "maxLength":1000
            }
        },
        "mode":{
            "description":"Sparse checkout matching mode. Git supports cone and non-cone sparse checkout pattern styles; AIDP supports cone mode only.",
            "type":"string",
            "enum":[
                "CONE"
            ],
            "default":"CONE"
        }
    }
}

Nested Schema : patterns

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 100

Repository-root-relative folder paths to include in the sparse worktree. Cone patterns apply only to folders; root-level files in the repository are always materialized. Empty or omitted patterns materialize root-level files only.

Show Source

• Array of: string
  Maximum Length: 1000

{
    "description":"Repository-root-relative folder paths to include in the sparse worktree. Cone patterns apply only to folders; root-level files in the repository are always materialized. Empty or omitted patterns materialize root-level files only.",
    "type":"array",
    "minItems":0,
    "maxItems":100,
    "items":{
        "type":"string",
        "maxLength":1000
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top