Sign in

v4

latestOpenAPI 3.1.0Redoclyraw.githubusercontent.com2026-06-05101533.8 KB
Remotes

Upsert remote

Upsert remote. If remote with the same mountPath and type already exists the remote object is returned. If the type doesn't match the existing remote, a 409 error is returned. Otherwise, a new remote is created.

post/orgs/{orgId}/projects/{projectId}/remotes

Request body

mountPathstring required

Remote target path.

type'CICD' | 'GIT' | 'URL' required

Remote type. TODO: Add discriminator by type and add other fields for GIT and URL remote types.

autoSyncboolean

Auto sync changes to remote.

autoMergeboolean

Auto merge changes from remote.

createdAtstring date-time
updatedAtstring date-time
providerType'GITHUB_CLOUD' | 'GITHUB_SERVER' | 'GITLAB_CLOUD' | 'GITLAB_SELF_MANAGED' | 'BITBUCKET_CLOUD' | 'BITBUCKET_DATACENTER' | 'AZURE' enum

Git provider type.

namespaceIdstring
repositoryIdstring
projectIdstring nullable
mountBranchNamestring
contentPathstring
credentialIdstring
branchNamestring
contentType'FOLDER' | 'FILE'

Example request

{
  "mountPath": "apis/test/@v1",
  "type": "CICD",
  "createdAt": "2023-06-07T00:00:00Z",
  "updatedAt": "2023-06-07T00:00:00Z",
  "contentType": "FILE"
}

Response

Remote created.

mountPathstring required

Remote target path.

type'CICD' | 'GIT' | 'URL' required

Remote type. TODO: Add discriminator by type and add other fields for GIT and URL remote types.

autoSyncboolean

Auto sync changes to remote.

autoMergeboolean

Auto merge changes from remote.

createdAtstring date-time
updatedAtstring date-time
providerType'GITHUB_CLOUD' | 'GITHUB_SERVER' | 'GITLAB_CLOUD' | 'GITLAB_SELF_MANAGED' | 'BITBUCKET_CLOUD' | 'BITBUCKET_DATACENTER' | 'AZURE' enum

Git provider type.

namespaceIdstring
repositoryIdstring
projectIdstring nullable
mountBranchNamestring
contentPathstring
credentialIdstring
branchNamestring
contentType'FOLDER' | 'FILE'
idstring required

Remote ID.

Example response

{
  "mountPath": "apis/test/@v1",
  "type": "CICD",
  "createdAt": "2023-06-07T00:00:00Z",
  "updatedAt": "2023-06-07T00:00:00Z",
  "contentType": "FILE",
  "id": "rem_01h2captefvs9bpg3v6twqqj9n"
}
All 10 operations