Git Repositories

get

Return list of active repositories in the organization

🔒 Requires the read:package permission

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
installation_idstringOptional

App installation ID for the repository

Example: 12345678
Responses
chevron-right
200

List of active repositories

application/json

List of active repositories

statusCodenumberRequiredExample: 200
messagestringRequiredExample: Repositories retrieved successfully
get
/api/v1/git/repos
post

Register a new trigger for the git repository

🔒 Requires the create:package permission

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
installation_idstringRequired

App installation ID for the repository

Example: 12345678
repostringRequired

Repository name with owner

Example: organization/repository
git_refstringRequired

The git branch name the package was created from

Example: main
pathstringRequired

The git subdirectory path of the package repository

Example: path/to/subdirectory
packagestringOptional

The package name e.g. @bluebricks/aws-vpc

Example: @bluebricks/aws-vpc
Responses
chevron-right
200

Trigger registered successfully

application/json

Trigger registered successfully

providerstring · enumRequired

Git provider type

Example: githubPossible values:
repostringRequired

Repository name with owner

Example: organization/repository
installationIdstring · nullableRequired

App installation ID for the repository

Example: 12345678
createdAtstring · date-timeRequired

The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z

updatedAtstring · nullableRequired

The date and time the resource was updated e.g. 2022-01-01T00:00:00.000Z

isActivebooleanRequired

Indicates if the repository is active

Example: true
publisherJobIdstring · uuidOptional

Unique identifier for the publisher status stream job

Example: 123e4567-e89b-12d3-a456-42661417400
post
/api/v1/git/register
put

Activate git trigger

🔒 Requires the create:package permission

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
triggerIdstring · uuidRequired

Unique identifier for the git trigger

Example: 123e4567-e89b-12d3-a456-42661417400
Responses
chevron-right
200

Updated trigger information for the git repository

application/json

Updated trigger information for the git repository

providerstring · enumRequired

Git provider type

Example: githubPossible values:
repostringRequired

Repository name with owner

Example: organization/repository
installationIdstring · nullableRequired

App installation ID for the repository

Example: 12345678
createdAtstring · date-timeRequired

The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z

updatedAtstring · nullableRequired

The date and time the resource was updated e.g. 2022-01-01T00:00:00.000Z

isActivebooleanRequired

Indicates if the repository is active

Example: true
publisherJobIdstring · uuidOptional

Unique identifier for the publisher status stream job

Example: 123e4567-e89b-12d3-a456-42661417400
put
/api/v1/git/trigger
delete

Deactivate git trigger

🔒 Requires the create:package permission

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
triggerIdstring · uuidRequired

Unique identifier for the git trigger

Example: 123e4567-e89b-12d3-a456-42661417400
Responses
chevron-right
200

Updated trigger information for the git repository

application/json

Updated trigger information for the git repository

providerstring · enumRequired

Git provider type

Example: githubPossible values:
repostringRequired

Repository name with owner

Example: organization/repository
installationIdstring · nullableRequired

App installation ID for the repository

Example: 12345678
createdAtstring · date-timeRequired

The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z

updatedAtstring · nullableRequired

The date and time the resource was updated e.g. 2022-01-01T00:00:00.000Z

isActivebooleanRequired

Indicates if the repository is active

Example: true
publisherJobIdstring · uuidOptional

Unique identifier for the publisher status stream job

Example: 123e4567-e89b-12d3-a456-42661417400
delete
/api/v1/git/trigger
post

Return git credentials for the publisher within the organization

🔒 Requires the read:package permission

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
git_remote_urlstringOptional

The git remote url of the package repository

Example: https://github.com/username/repository.git
Responses
chevron-right
200

Git credentials for the publisher within the organization

application/json

Git credentials for the publisher within the organization

organizationstringRequired

The organization ID

Example: org_abCdeFghIjklMnmP
git_remote_urlstringOptional

The git remote url of the package repository

Example: https://github.com/username/repository.git
installation_idstringRequired

App installation ID for the repository

Example: 12345678
post
/api/v1/git-credentials

Last updated

Was this helpful?