Skip to content

Select which repositories are in scope

PUT
/api/v1/scm/connections/{id}/selection
curl --request PUT \
--url https://api.aletheia-ops.com/api/v1/scm/connections/example/selection \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "repository_ids": [ "example" ], "all": true, "selected": true }'
id
required
string
Media typeapplication/json

A bulk repository selection request: either an explicit id list (with a selected flag) or all repositories under the connection

object
repository_ids
Array<string>
all
boolean
selected
boolean
Examplegenerated
{
"repository_ids": [
"example"
],
"all": true,
"selected": true
}

OK

Media typeapplication/json

How many repositories changed selection state.

object
changed
integer
Examplegenerated
{
"changed": 1
}

The request is malformed or fails validation.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
{
"code": "validation_failed",
"message": "name: must not be blank"
}

No valid credential was presented, or it has expired.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
{
"code": "unauthorized",
"message": "authentication required"
}

Authenticated, but not permitted to perform this action.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
{
"code": "forbidden",
"message": "you do not have permission to perform this action"
}

The resource does not exist, or belongs to another organization. The two are deliberately indistinguishable.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
Examplenot_found
{
"code": "not_found",
"message": "resource not found"
}

The request conflicts with the current state.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
{
"code": "email_taken",
"message": "an account with this email already exists"
}

An unexpected failure. Diagnostic detail is logged server-side and deliberately not returned. Quote the X-Request-Id response header when reporting one.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
Exampleinternal_error
{
"code": "internal_error",
"message": "internal server error"
}

A dependency required for this request is not available.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
Exampleprovider_unavailable
{
"code": "provider_unavailable",
"message": "this source-control provider is not configured"
}