Appearance
Test GitHub installation and repository access ​
Team admins only. Sync imports GitHub issue/comment history, exports active public feedback and new publications after repository connection, and preserves existing mappings. Previously published changelog history and untouched completed feedback are not backfilled; changelog-only mappings are excluded from feedback and roadmap views/counts. Disconnect pauses sync without uninstalling the shared GitHub App.
Request preparation ​
Send a POST request to /product/sites/{siteId}/integrations/github/test on the appropriate server. Check the API overview for base URL guidance and the server information in the interactive reference. Replace path placeholders with identifiers from the intended account or site; a similarly named record in another workspace is not interchangeable.
The declared request parameters are:
siteId(path, required): Use the type and constraints shown in the parameter reference.
No request body is declared in the current specification. Check the route and any documented parameters before sending the request rather than adding an arbitrary JSON payload.
Authentication and scope ​
The specification lists these security alternatives: BearerAuth, AccessToken. Read any operation-specific restrictions as well: browser-session, account-role, and signed-user requirements may impose additional conditions. See authentication before choosing a credential.
Keep credentials in the appropriate private configuration and remove secrets from shared logs. Confirm the target resource belongs to the intended workflow before issuing a request. Authentication alone should not be treated as confirmation that a supplied account, site, or customer identifier is correct.
Response handling ​
The documented responses for Test GitHub installation and repository access are:
- 200: Success
- 400: Invalid input or unavailable GitHub resource
- 403: Team admin or repository access required
- 404: Project or record not found
- 409: Repository mapping changed or remote outcome requires reconciliation
- 429: GitHub rate limit; retry scheduled
Exercise this operation with controlled test data before enabling it in an automated workflow. Validate the request against the schema and inspect the response before updating local state. Do not assume that a successful response means background processing has finished; follow any documented status or follow-up operation when the action queues additional work.
If a connection fails after submission, investigate the current server state before repeating an action whose outcome is uncertain. When requesting support, retain the method, route, response status, and sanitized error message. The interactive reference below provides the detailed schemas and examples for this specific operation.
Test GitHub installation and repository access​
POST
/product/sites/{siteId}/integrations/github/test
Team admins only. Sync imports GitHub issue/comment history, exports active public feedback and new publications after repository connection, and preserves existing mappings. Previously published changelog history and untouched completed feedback are not backfilled; changelog-only mappings are excluded from feedback and roadmap views/counts. Disconnect pauses sync without uninstalling the shared GitHub App.
Authorizations​
BearerAuth
JWT token from login
Type
HTTP (bearer)
or
AccessToken
Personal access token. Value: Token <your-token>
Type
API Key (header: Authorization)
Parameters​
Path Parameters
siteId*
Type
Requiredstring
Responses​
Success
application/json
JSON"url": "string","queued": true,"github": "string"
{
 Â
 Â
 Â
}