SOsocket-dev
repos

Update repository

Update details of an existing repository.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

  • repo:update
post/orgs/{org_slug}/repos/{repo_slug}

Request

  • Base URL
    https://api.socket.dev/v0
  • URL
    https://api.socket.dev/v0/orgs/{org_slug}/repos/{repo_slug}
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

org_slugstring required

The slug of the organization

repo_slugstring required

The slug of the repository

Query parameters

workspacestring

The workspace of the repository

Request body

namestring

The name of the repository

descriptionstring nullable

The description of the repository

homepagestring nullable

The homepage URL of the repository

visibility'public' | 'private'

The visibility of the repository

archivedboolean

Whether the repository is archived or not

default_branchstring nullable

The default branch of the repository

workspacestring

The workspace of the repository

Response

Updated repository details

idstring

The ID of the repository

created_atstring

The creation date of the repository

updated_atstring

The last update date of the repository

html_urlstring

The URL to the repository dashboard page

head_full_scan_idstring nullable

The ID of the head full scan of the repository

slugstring

The slug of the repository.

namestring

The name of the repository

descriptionstring nullable

The description of the repository

homepagestring nullable

The homepage URL of the repository

visibility'public' | 'private'

The visibility of the repository

archivedboolean

Whether the repository is archived or not

default_branchstring nullable

The default branch of the repository

workspacestring

The workspace of the repository

Changes

No recorded changes to this operation across all 2 revisions of this API.