Skip to content
SupaCloud Docs
Select themeSelect language

post_api_projects_sync_list

POST
/api/projects/sync/list
curl --request POST \
  --url https://example.com/api/projects/sync/list \
  --header 'Content-Type: application/json' \
  --cookie supacloud_session=<supacloud_session> \
  --data '{ "credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "provider": "example", "workspace": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
credential_id
required
string format: uuid
provider
string | null
workspace
string | null
Examplegenerated
{
  "credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "provider": "example",
  "workspace": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Remote repositories visible to the credential

Media typeapplication/json
Array<object>

Remote repository info returned from provider APIs

object
already_imported
required
boolean
clone_url

HTTPS clone URL — present whenever the provider exposes one. The importer prefers it over ssh_url because the workspace sync gate already enforces an access_token credential, which only works over HTTPS.

string | null
default_branch
string | null
description
string | null
full_name
required
string
html_url
required
string
name
required
string
provider
required
string
ssh_url
string | null
Examplegenerated
[
  {
    "already_imported": true,
    "clone_url": "example",
    "default_branch": "example",
    "description": "example",
    "full_name": "example",
    "html_url": "example",
    "name": "example",
    "provider": "example",
    "ssh_url": "example"
  }
]

400

Section titled “400”

Structured client error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}