---
title: "Test connectivity to GitHub using the provided credentials"
method: POST
path: "/githubissuetracker/connectivitycheck"
tags: ["GitHub"]
---

# Test connectivity to GitHub using the provided credentials

`POST /githubissuetracker/connectivitycheck`

## Request body

- GitHubConnectivityCheckRequest
  - `BaseUrl` string, required — The GitHub base URL to test connectivity to
  - `Password` string — The GitHub personal access token or password for authentication. If not provided, will be retrieved from configuration.
  - `UserName` string — The GitHub username for authentication.

## Response `200`

Result of testing connectivity to GitHub

- GitHubConnectivityCheckResponse
  - `Messages` ConnectivityCheckMessage[], required — Messages from the connectivity check
    - `Category` 'Info' | 'Warning' | 'Error', required
    - `Message` string, required

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/revisions/b296c3a60aa5/schema)