Git
Git connections to GitHub, Forgejo and GitLab, and the repositories and branches they can see. Each operation lists its method and path, parameters, request body, responses and an example call.
/api/v1/git-connectionsAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Query Parameters
Opaque cursor from a previous response's nextCursor. Omit for the first page.
How many items to return.
int641 <= value <= 20050Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/git-connections"{ "$schema": "https://example.com/PageGitConnection.json", "items": [ { "$schema": "https://example.com/GitConnection.json", "accountLogin": "string", "createdAt": "2019-08-24T14:15:22Z", "host": "string", "id": "string", "installed": true, "kind": "github_app", "label": "string", "lastDeliveryAt": "2019-08-24T14:15:22Z", "lastDeliveryStatus": "string", "lastError": "string", "manageUrl": "string", "missingPermissions": [ "string" ], "organizationId": "string", "verifiedAt": "2019-08-24T14:15:22Z" } ], "nextCursor": "string"}/api/v1/git-connections/forgejoAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/api/v1/git-connections/forgejo" \ -H "Content-Type: application/json" \ -d '{ "host": "string", "label": "string", "token": "string" }'{ "$schema": "https://example.com/GitConnection.json", "accountLogin": "string", "createdAt": "2019-08-24T14:15:22Z", "host": "string", "id": "string", "installed": true, "kind": "github_app", "label": "string", "lastDeliveryAt": "2019-08-24T14:15:22Z", "lastDeliveryStatus": "string", "lastError": "string", "manageUrl": "string", "missingPermissions": [ "string" ], "organizationId": "string", "verifiedAt": "2019-08-24T14:15:22Z"}/api/v1/git-connections/github-appAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/api/v1/git-connections/github-app" \ -H "Content-Type: application/json" \ -d '{ "label": "string" }'{ "$schema": "https://example.com/CreateGitHubAppOutputBody.json", "connectionId": "string", "startUrl": "string"}/api/v1/git-connections/github-app/callbackQuery Parameters
Response Body
application/problem+json
curl -X GET "https://example.com/api/v1/git-connections/github-app/callback"/api/v1/git-connections/github-app/installedQuery Parameters
int64Response Body
application/problem+json
curl -X GET "https://example.com/api/v1/git-connections/github-app/installed"/api/v1/git-connections/github-app/startAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Query Parameters
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/git-connections/github-app/start""string"/api/v1/git-connections/gitlabAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/api/v1/git-connections/gitlab" \ -H "Content-Type: application/json" \ -d '{ "token": "string" }'{ "$schema": "https://example.com/GitConnection.json", "accountLogin": "string", "createdAt": "2019-08-24T14:15:22Z", "host": "string", "id": "string", "installed": true, "kind": "github_app", "label": "string", "lastDeliveryAt": "2019-08-24T14:15:22Z", "lastDeliveryStatus": "string", "lastError": "string", "manageUrl": "string", "missingPermissions": [ "string" ], "organizationId": "string", "verifiedAt": "2019-08-24T14:15:22Z"}/api/v1/git-connections/{id}An API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Path Parameters
Response Body
application/problem+json
curl -X DELETE "https://example.com/api/v1/git-connections/string"/api/v1/git-connections/{id}/branchesAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Path Parameters
Query Parameters
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/git-connections/string/branches"{ "$schema": "https://example.com/BranchList.json", "branches": [ "string" ], "defaultBranch": "string"}/api/v1/git-connections/{id}/checkAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Path Parameters
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/api/v1/git-connections/string/check"{ "$schema": "https://example.com/GitConnection.json", "accountLogin": "string", "createdAt": "2019-08-24T14:15:22Z", "host": "string", "id": "string", "installed": true, "kind": "github_app", "label": "string", "lastDeliveryAt": "2019-08-24T14:15:22Z", "lastDeliveryStatus": "string", "lastError": "string", "manageUrl": "string", "missingPermissions": [ "string" ], "organizationId": "string", "verifiedAt": "2019-08-24T14:15:22Z"}/api/v1/git-connections/{id}/repositoriesAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Path Parameters
Query Parameters
Case-insensitive substring filter on the repository's full name.
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/git-connections/string/repositories"{ "$schema": "https://example.com/ListRepositoriesOutputBody.json", "repositories": [ { "cloneUrl": "string", "defaultBranch": "string", "fullName": "string", "private": true } ]}Domains
Domains and their DNS and certificates. Each operation lists its method and path, parameters, request body, responses and an example call.
Registry
Resolve an image reference to an immutable digest. Each operation lists its method and path, parameters, request body, responses and an example call.