Link a GitHub repo for this workspace's apps

POST

/api/workspaces/{workspaceId}/apps/link

curl --request POST \
  --url http://localhost:8080/api/workspaces/example/apps/link \
  --header 'Content-Type: application/json' \
  --cookie auth_session=<auth_session> \
  --data '{ "owner": "example", "repo": "example", "defaultBranch": "example", "subdirectory": "example", "installationId": 1 }'

• Configured API base URL

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Request Body

Media typeapplication/json

object

owner

required

string

>= 1 characters

repo

required

string

>= 1 characters

defaultBranch

string

subdirectory

string

installationId

integer

Example ^generated

{
  "owner": "example",
  "repo": "example",
  "defaultBranch": "example",
  "subdirectory": "example",
  "installationId": 1
}

Responses

2XX

Successful response

Media typeapplication/json

object

success

Whether the request succeeded.

boolean

data

Endpoint-specific response payload.

message

string

error

string

Example

{
  "message": "Operation completed",
  "error": "Error message"
}

4XX

Invalid request

Media typeapplication/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

Media typeapplication/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}