Code repositories

List Code Repositories

get

Gets a page of code repositories.

Args: filter_model: Filter model used for pagination, sorting, filtering. project_name_or_id: Optional name or ID of the project. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: Page of code repository objects.

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
project_name_or_idany ofOptional
stringOptional
or
string · uuidOptional
or
nullOptional
hydratebooleanOptionalDefault: false
sort_bystringOptionalDefault: created
logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:
pageinteger · min: 1OptionalDefault: 1
sizeinteger · min: 1 · max: 10000OptionalDefault: 20
idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
createdany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
updatedany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
scope_userany ofOptional
string · uuidOptional
or
nullOptional
userany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
projectany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
nameany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/api/v1/code_repositories

Get Code Repository

get

Gets a specific code repository using its unique ID.

Args: code_repository_id: The ID of the code repository to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: A specific code repository object.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
code_repository_idstring · uuidRequired
Query parameters
hydratebooleanOptionalDefault: true
Responses
200

Successful Response

application/json
get
/api/v1/code_repositories/{code_repository_id}

Update Code Repository

put

Updates a code repository.

Args: code_repository_id: The ID of the code repository to update. update: The model containing the attributes to update.

Returns: The updated code repository object.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
code_repository_idstring · uuidRequired
Body

Update model for code repositories.

nameany ofOptional
string · max: 255Optional
or
nullOptional
configany ofOptional

Configuration for the code repository.

or
nullOptional
sourceany ofOptional

The code repository source.

or
nullOptional
logo_urlany ofOptional

Optional URL of a logo (png, jpg or svg) for the code repository.

stringOptional
or
nullOptional
descriptionany ofOptional

Code repository description.

string · max: 65535Optional
or
nullOptional
Responses
200

Successful Response

application/json
put
/api/v1/code_repositories/{code_repository_id}

Delete Code Repository

delete

Deletes a specific code repository.

Args: code_repository_id: The ID of the code repository to delete.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
code_repository_idstring · uuidRequired
Responses
200

Successful Response

application/json
Responseany
delete
/api/v1/code_repositories/{code_repository_id}

No content

Last updated

Was this helpful?