Dokploy
Generated

Github

GET
/github.one

Github one

/github.one

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

githubId
Required
string

Minimum length: 1
curl -X GET "https://your-dokploy-instance.com/api/github.one?githubId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET
/github.getGithubRepositories

Github get Github Repositories

/github.getGithubRepositories

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

githubId
Required
string

Minimum length: 1
curl -X GET "https://your-dokploy-instance.com/api/github.getGithubRepositories?githubId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET
/github.getGithubBranches

Github get Github Branches

/github.getGithubBranches

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

repo
Required
string

Minimum length: 1

owner
Required
string

Minimum length: 1

githubIdstring

curl -X GET "https://your-dokploy-instance.com/api/github.getGithubBranches?repo=string&owner=string&githubId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET
/github.githubProviders

Github github Providers

/github.githubProviders

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/github.githubProviders" \
  -H "Authorization: <token>"

Successful response

{}

POST
/github.testConnection

Github test Connection

/github.testConnection

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

githubId
Required
string

Minimum length: 1
curl -X POST "https://your-dokploy-instance.com/api/github.testConnection" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "githubId": "string"
  }'

Successful response

{}

POST
/github.update

Github update

/github.update

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

githubId
Required
string

Minimum length: 1

githubAppName
Required
string

Minimum length: 1

githubAppIdnumber | null

githubClientIdstring | null

githubClientSecretstring | null

githubInstallationIdstring | null

githubPrivateKeystring | null

githubWebhookSecretstring | null

gitProviderId
Required
string

Minimum length: 1

name
Required
string

Minimum length: 1
curl -X POST "https://your-dokploy-instance.com/api/github.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "githubId": "string",
    "githubAppName": "string",
    "githubAppId": 0,
    "githubClientId": "string",
    "githubClientSecret": "string",
    "githubInstallationId": "string",
    "githubPrivateKey": "string",
    "githubWebhookSecret": "string",
    "gitProviderId": "string",
    "name": "string"
  }'

Successful response

{}

Previous

Gitea

Next

Gitlab