Skip to content
KataraKatara documentation

List the repositories an installation of the GitHub App reaches

GET
/katara/v1/orgs/{org_id}/environments/{environment_id}/github/repositories
curl --request GET \
  --url 'https://api.katara.com/katara/v1/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/environments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/github/repositories?installation_id=1' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
environment_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000

Query Parameters

Section titled “Query Parameters”
installation_id
required
integer
>= 1 <= 9007199254740991
after
string
/^[1-9][0-9]{0,3}$/
limit
integer
>= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

Successful request

Media typeapplication/json
object
data
required
Array<object>
<= 100 items

A repository an installation reaches, for choosing one to attach.

object
repository_id
required
integer
>= 1 <= 9007199254740991
owner
required
string
/^[A-Za-z0-9._-]{1,100}$/
name
required
string
/^[A-Za-z0-9._-]{1,100}$/
private
required
boolean
default_branch
required
string
<= 255 characters
next_cursor

GitHub’s next page; pass it back as after.

string
/^[1-9][0-9]{0,3}$/
Examplegenerated
{
  "data": [
    {
      "repository_id": 1,
      "owner": "example",
      "name": "example",
      "private": true,
      "default_branch": "example"
    }
  ],
  "next_cursor": "example"
}

default

Section titled “default”

Request error

Media typeapplication/json
object
error
required
object
message
required
string
>= 1 characters <= 500 characters
type
required
string
>= 1 characters <= 100 characters
code
required

Stable; branch on it. Any operation can answer invalid_request, with param naming the refused field when there is one; human_session_required, when an API key, service account or workload calls an operation only a signed-in person may perform; reauthentication_required, when a person’s sign-in is too old for the operation; permission_denied; route_not_found and method_not_allowed, when no operation matches the path or method; and feature_unavailable, when the operation’s service is not enabled on this deployment.

string
>= 1 characters <= 100 characters
param
required

The request field a refusal is about, such as the agent_id or run_id query parameter; null when the refusal is not about one field.

string | null
request_id
required
string
>= 1 characters <= 100 characters
upstream_status
required
integer | null
action
Allowed values: sign_in reauthenticate request_access review fund retry reconcile refresh support
operation_id
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
snapshot_ref
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
Example
{
  "error": {
    "action": "sign_in"
  }
}