Jump to

• Request
• Response

Asynchronously creates a Git folder and clones the repository

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitFolders

Asynchronously creates a Git folder and clones the repository. The aidp-async-operation-key header identifies the operation. Once SUCCEEDED, the folder's HEAD response with shouldIncludeMetadata=true exposes system:repoKey in the JSON file-metadata header for subsequent Git APIs.

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.
• workspaceKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The key of the Workspace

Header Parameters

• if-match: string
  Maximum Length: 1000

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• 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.
• opc-retry-token: string
  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.

Body ()

The information to be updated.

Root Schema : CreateGitFolderDetails

Type: object

The data to create a Git folder in a workspace.

Show Source

• branchName(required): string
  Minimum Length: 1

  Maximum Length: 400

  Git branch name that is cloned.
• credentialKey(required): string
  Minimum Length: 1

  Maximum Length: 255

  Key of the current user's GIT_ACCOUNT user setting for repository authentication. User setting listings identify it by settingType=GIT_ACCOUNT and displayName; the matching entry's key is the credentialKey.
• credentialStoreKey: string
  Minimum Length: 1

  Maximum Length: 255

  Key of the credential containing the Git server's TLS CA certificate, returned by credential listings filtered by displayName. Required when isPrivateConnectivityEnabled is true.
• description: string
  Minimum Length: 0

  Maximum Length: 1000

  Short description about the git repository.
• folderPath(required): string
  Minimum Length: 1

  Maximum Length: 1000

  Workspace-relative path of the Git folder, without a leading slash (for example, `sample-repo`). The folder is located at `/Workspace/`.
• 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.
• gitProviderKey: string
  Maximum Length: 200

  Default Value: GIT

  key corresponding to Git service provider in git provider table.
• gitRepositoryUrl(required): string
  Minimum Length: 1

  Maximum Length: 1000

  Git repository url used to clone.
• isPrivateConnectivityEnabled: boolean
  Default Value: false

  Whether this Git folder uses private network connectivity.
• 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.

{
    "description":"The data to create a Git folder in a workspace.",
    "type":"object",
    "required":[
        "folderPath",
        "gitRepositoryUrl",
        "branchName",
        "credentialKey"
    ],
    "properties":{
        "folderPath":{
            "description":"Workspace-relative path of the Git folder, without a leading slash (for example, `sample-repo`). The folder is located at `/Workspace/<folderPath>`.",
            "type":"string",
            "minLength":1,
            "maxLength":1000
        },
        "gitProviderKey":{
            "description":"key corresponding to Git service provider in git provider table.",
            "type":"string",
            "default":"GIT",
            "maxLength":200
        },
        "gitRepositoryUrl":{
            "description":"Git repository url used to clone.",
            "type":"string",
            "minLength":1,
            "maxLength":1000
        },
        "branchName":{
            "description":"Git branch name that is cloned.",
            "type":"string",
            "minLength":1,
            "maxLength":400
        },
        "credentialKey":{
            "description":"Key of the current user's GIT_ACCOUNT user setting for repository authentication.\nUser setting listings identify it by settingType=GIT_ACCOUNT and displayName;\nthe matching entry's key is the credentialKey.\n",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "isPrivateConnectivityEnabled":{
            "description":"Whether this Git folder uses private network connectivity.",
            "type":"boolean",
            "default":false
        },
        "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
        },
        "credentialStoreKey":{
            "description":"Key of the credential containing the Git server's TLS CA certificate,\nreturned by credential listings filtered by displayName. Required when\nisPrivateConnectivityEnabled is true.\n",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "description":{
            "description":"Short description about the git repository.",
            "type":"string",
            "minLength":0,
            "maxLength":1000
        },
        "sparseCheckout":{
            "$ref":"#/definitions/SparseCheckoutDetails"
        }
    }
}

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
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Git folder creation was accepted for asynchronous processing.

Headers

• aidp-async-operation-key: string
  The key of the asynchronous operations associated with an AI Data Platform instance. Use GetAsyncOperation with this key to track the status of the request.
• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : GitFolder

Type: object

A workspace Git folder and its repository, branch, and connectivity settings.

Show Source

• branchName: string
  Minimum Length: 1

  Maximum Length: 400

  Git branch name that is cloned.
• credentialStoreKey: string
  Minimum Length: 1

  Maximum Length: 255

  Key of the credential containing the Git server's TLS CA certificate, returned by credential listings filtered by displayName. Required when isPrivateConnectivityEnabled is true.
• description: string
  Minimum Length: 0

  Maximum Length: 1000

  Short description about the git repository.
• folderMetadata: object folderMetadata
  Additional Properties Allowed: additionalProperties

  The metadata about the folder, like branchName.
• folderPath(required): string
  Minimum Length: 1

  Maximum Length: 1000

  Workspace-relative path of the Git folder, without a leading slash (for example, `sample-repo`). The folder is located at `/Workspace/`.
• gitConnectivityProfileKey: string
  Key of the private network profile used for Git connectivity, returned by private network profile listings filtered by name. Required when isPrivateConnectivityEnabled is true.
• gitProviderKey: string
  Maximum Length: 200

  Default Value: GIT

  key corresponding to Git service provider in git provider table.
• gitRepositoryUrl: string
  Minimum Length: 1

  Maximum Length: 1000

  Git repository url used to clone.
• isPrivateConnectivityEnabled: boolean
  Whether this Git folder uses private network connectivity.
• 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.

{
    "description":"A workspace Git folder and its repository, branch, and connectivity settings.",
    "type":"object",
    "required":[
        "folderPath"
    ],
    "properties":{
        "folderPath":{
            "description":"Workspace-relative path of the Git folder, without a leading slash (for example, `sample-repo`). The folder is located at `/Workspace/<folderPath>`.",
            "type":"string",
            "minLength":1,
            "maxLength":1000
        },
        "gitProviderKey":{
            "description":"key corresponding to Git service provider in git provider table.",
            "type":"string",
            "default":"GIT",
            "maxLength":200
        },
        "gitRepositoryUrl":{
            "description":"Git repository url used to clone.",
            "type":"string",
            "minLength":1,
            "maxLength":1000
        },
        "description":{
            "description":"Short description about the git repository.",
            "type":"string",
            "minLength":0,
            "maxLength":1000
        },
        "branchName":{
            "description":"Git branch name that is cloned.",
            "type":"string",
            "minLength":1,
            "maxLength":400
        },
        "isPrivateConnectivityEnabled":{
            "description":"Whether this Git folder 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"
        },
        "credentialStoreKey":{
            "description":"Key of the credential containing the Git server's TLS CA certificate,\nreturned by credential listings filtered by displayName. Required when\nisPrivateConnectivityEnabled is true.\n",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "folderMetadata":{
            "description":"The metadata about the folder, like branchName.",
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "sparseCheckout":{
            "$ref":"#/definitions/SparseCheckoutDetails"
        }
    }
}

Nested Schema : folderMetadata

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"The metadata about the folder, like branchName.",
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

The metadata about the folder, like branchName.

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 : additionalProperties

Type: object

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
    }
}

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"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

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"
        }
    }
}

412 Response

Precondition Failed (One or more conditions in request failed).

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