Get repositories associated with a code security configuration

GET

/orgs/{org}/code-security/configurations/{configuration_id}/repositories

Lists the repositories associated with a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

configuration_id

required

integer

The unique identifier of the code security configuration.

Query Parameters

per_page

integer

default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

before

string

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see “Using pagination in the REST API.”

after

string

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see “Using pagination in the REST API.”

status

string

default: all

A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.

Can be: all, attached, attaching, detached, removed, enforced, failed, updating, removed_by_enterprise

Responses

200

Response

application/json

Array<object>

Repositories associated with a code security configuration and attachment status

object

status

The attachment status of the code security configuration on the repository.

string

Allowed values: attached attaching detached removed enforced failed updating removed_by_enterprise

repository

Simple Repository

A GitHub repository.

object

required

A unique identifier of the repository.

integer format: int64

node_id

required

The GraphQL identifier of the repository.

string

name

required

The name of the repository.

string

full_name

required

The full, globally unique, name of the repository.

string

owner

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

private

required

Whether the repository is private.

boolean

html_url

required

The URL to view the repository on GitHub.com.

string format: uri

description

required

The repository description.

string

nullable

fork

required

Whether the repository is a fork.

boolean

url

required

The URL to get more information about the repository from the GitHub API.

string format: uri

archive_url

required

A template for the API URL to download the repository as an archive.

string

assignees_url

required

A template for the API URL to list the available assignees for issues in the repository.

string

blobs_url

required

A template for the API URL to create or retrieve a raw Git blob in the repository.

string

branches_url

required

A template for the API URL to get information about branches in the repository.

string

collaborators_url

required

A template for the API URL to get information about collaborators of the repository.

string

comments_url

required

A template for the API URL to get information about comments on the repository.

string

commits_url

required

A template for the API URL to get information about commits on the repository.

string

compare_url

required

A template for the API URL to compare two commits or refs.

string

contents_url

required

A template for the API URL to get the contents of the repository.

string

contributors_url

required

A template for the API URL to list the contributors to the repository.

string format: uri

deployments_url

required

The API URL to list the deployments of the repository.

string format: uri

downloads_url

required

The API URL to list the downloads on the repository.

string format: uri

events_url

required

The API URL to list the events of the repository.

string format: uri

forks_url

required

The API URL to list the forks of the repository.

string format: uri

git_commits_url

required

A template for the API URL to get information about Git commits of the repository.

string

git_refs_url

required

A template for the API URL to get information about Git refs of the repository.

string

git_tags_url

required

A template for the API URL to get information about Git tags of the repository.

string

issue_comment_url

required

A template for the API URL to get information about issue comments on the repository.

string

issue_events_url

required

A template for the API URL to get information about issue events on the repository.

string

issues_url

required

A template for the API URL to get information about issues on the repository.

string

keys_url

required

A template for the API URL to get information about deploy keys on the repository.

string

labels_url

required

A template for the API URL to get information about labels of the repository.

string

languages_url

required

The API URL to get information about the languages of the repository.

string format: uri

merges_url

required

The API URL to merge branches in the repository.

string format: uri

milestones_url

required

A template for the API URL to get information about milestones of the repository.

string

notifications_url

required

A template for the API URL to get information about notifications on the repository.

string

pulls_url

required

A template for the API URL to get information about pull requests on the repository.

string

releases_url

required

A template for the API URL to get information about releases on the repository.

string

stargazers_url

required

The API URL to list the stargazers on the repository.

string format: uri

statuses_url

required

A template for the API URL to get information about statuses of a commit.

string

subscribers_url

required

The API URL to list the subscribers on the repository.

string format: uri

subscription_url

required

The API URL to subscribe to notifications for this repository.

string format: uri

tags_url

required

The API URL to get information about tags on the repository.

string format: uri

teams_url

required

The API URL to list the teams on the repository.

string format: uri

trees_url

required

A template for the API URL to create or retrieve a raw Git tree of the repository.

string

hooks_url

required

The API URL to list the hooks on the repository.

string format: uri

Examples

default

Example of code security configuration repositories

[
  {
    "status": "attached",
    "repository": {
      "value": {
        "id": 1296269,
        "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
        "name": "Hello-World",
        "full_name": "octocat/Hello-World",
        "owner": {
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "",
          "url": "https://api.github.com/users/octocat",
          "html_url": "https://github.com/octocat",
          "followers_url": "https://api.github.com/users/octocat/followers",
          "following_url": "https://api.github.com/users/octocat/following{/other_user}",
          "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
          "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
          "organizations_url": "https://api.github.com/users/octocat/orgs",
          "repos_url": "https://api.github.com/users/octocat/repos",
          "events_url": "https://api.github.com/users/octocat/events{/privacy}",
          "received_events_url": "https://api.github.com/users/octocat/received_events",
          "type": "User",
          "site_admin": false
        },
        "private": false,
        "html_url": "https://github.com/octocat/Hello-World",
        "description": "This your first repo!",
        "fork": false,
        "url": "https://api.github.com/repos/octocat/Hello-World",
        "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
        "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
        "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
        "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
        "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
        "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
        "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
        "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
        "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
        "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
        "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
        "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
        "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
        "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
        "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
        "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
        "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
        "git_url": "git:github.com/octocat/Hello-World.git",
        "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
        "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
        "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
        "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
        "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
        "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
        "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
        "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
        "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
        "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
        "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
        "ssh_url": "git@github.com:octocat/Hello-World.git",
        "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
        "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
        "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
        "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
        "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
        "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
        "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
        "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
      }
    }
  }
]

403

Forbidden

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

Get repositories associated with a code security configuration

Parameters

Path Parameters

Query Parameters

Responses

200

Examples

403

Example generated

404

Example generated

Example ^generated

Example ^generated